1

"""

     2

    Core `struct event` type.

     3

"""

     4

     5

cimport qmsk.net.lib.event2.lib as lib

     6

     9

# internal helper method for handling timeout arguments

    10

cdef lib.timeval* build_timeout (lib.timeval *tv, object timeout = ?) except? <lib.timeval *>-1

    11

    12

cdef class event :

    13

    """

    14

        Create a new event object with the given parameters.

    15

    16

        An event tracks a single OS file descriptor with some set of events (EV_READ/EV_WRITE) and an optional timeout.

    17

    18

        An event is associated with some event_base, which handles the event mechanism.

    19

    20

        Arguments:

    21

            base        - event_base to use for this event

    22

            fd          - OS file descriptor to watch, or -1

    23

            events      - bitmask of EV_* flags that represents the events to wait for

    24

    25

        When the event fires, it will "call" this event object (see docs for __call__()).

    26

    27

        The lifetime of event objects is slightly non-trivial, in that they will actually hold a reference to

    28

        themselves while "active". In other words, .add() will aquire an internal reference, which will be released

    29

        before the __call__().

    30

    31

        XXX: propagate errors (including e.g. KeyboardInterrupt?) from __call__ to event_base.loop()?

    32

    """

    33

    37

    # the underlying event object

    38

    cdef lib.event *ev

    39

    40

    # slightly different meaning from libevent's "active", this is used to track our own refcount

    41

    cdef readonly bool alive

    42

    43

    # self-refcount scheme

    44

    cdef object _mark (self)

    45

    cdef object _unmark (self)

    46

    47

    # methods also used internally

    48

    cpdef pending (self, short mask = ?)