Mark Nunberg > Couchbase-Client-0.19_1 > Couchbase::Client::Async::Event

Download:
Couchbase-Client-0.19_1.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Source   Latest Release: Couchbase-Client-1.0.2

NAME ^

Couchbase::Client::Async::Event

Event object for asynchronous couchbase client

DESCRIPTION ^

This documents the specific fields in the Event structure. For a more detailed overview of what this is used for, see Couchbase::Client::Async

FIELDS

The Event object is a simple array, and can be accessed by using either the listed index constants (exported by Couchbase::Client::IDXConst) or by using the named accessors.

Accessors are safer and do some basic sanity checking, at the cost of performance.

EVIDX_FD, fd

Read-Only.

The file descriptor number for this event.

EVIDX_DUPFH, dupfh

The perl-level dup'd file descriptor, if applicable.

This is mainly for use by event library plugins, but is modified (or rather, deleted) if we detect the file descriptor has changed or otherwise become invalid.

EVIDX_WATCHLFAGS, old_flags

Read-Only.

The old event flags before invoking the callback with the new flags

EVIDX_STATEFLAGS, old_state

The old state (resumed, active, suspended, etc) of the event, before this callback was invokved

EVIDX_OPAQUE, opaque

Read-Only.

The opaque data to be passed back to us when an event is triggered.

EVIDX_PLDATA, pldata

This is for perl-level data. This library does not modify it, so feel free to store whatever you want here.

syntax highlighting: