qmsk/net/lib/event2/event.pyx
author Tero Marttila <terom@fixme.fi>
Sat, 26 Sep 2009 21:50:42 +0300
changeset 52 722fc70a197a
parent 50 da394bb715af
child 57 8c4032265c8c
permissions -rw-r--r--
change CallbackEvent to replace fd with ev, event2 doc/style tweaks
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
from qmsk.net.lib.event2.event cimport *
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
from qmsk.net.lib.event2.base cimport event_base
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
     3
cimport qmsk.net.py as py
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     4
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     5
cdef lib.timeval* build_timeout (lib.timeval *tv, object timeout = None) except? <lib.timeval *>-1 :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
    """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     7
        If a timeout is given, it is treated as a float and stored in *tv, which is returned. Otherwise, simply returns
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     8
        NULL.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     9
    """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
    cdef double t
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
41
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
    13
    if timeout is not None :
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
        t = timeout
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    15
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    16
        tv.tv_sec = <int>(t)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    17
        tv.tv_usec = <int>((t - <int> t) * 100000)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    18
        
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    19
        return tv
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    20
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    21
    else :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    22
        return NULL
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    23
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    24
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    25
# our shared callback handler
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    26
# this must aquire the GIL before invoking the python object
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    27
# this means that the libevent loop *must* be run with the GIL released!
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    28
cdef void ev_callback (lib.evutil_socket_t fd, short mask, void *arg) with gil :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    29
    """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    30
        Proxy event back to event object passed as arg
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    31
    """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    32
    
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    33
    # unpack opaque arg
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    34
    cdef event ev = <event>arg
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    36
    # drop self-ref if not pending anymore (keep the local ref)
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    37
    # XXX: does the event show up as non-pending here? :/
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    38
    ev._unmark()
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    39
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    40
    # invoke
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    41
    # XXX: logging?
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    42
    ev(fd, mask)
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    43
    
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    44
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    45
cdef class event :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    46
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    47
    def __init__ (self, event_base base not None, lib.evutil_socket_t fd, short events) :
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    48
        # we don't hold a self-reference yet
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    49
        self.alive = False
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    50
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    51
        # libevent seems to segfault otherwise...
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    52
        if events & (lib.EV_READ | lib.EV_WRITE) and fd < 0 :
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    53
            raise ValueError(fd)
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    54
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    55
        # construct event using our internal callback, with self as the arg
52
722fc70a197a change CallbackEvent to replace fd with ev, event2 doc/style tweaks
Tero Marttila <terom@fixme.fi>
parents: 50
diff changeset
    56
        self.ev = lib.event_new(base.ev_base, fd, events, ev_callback, <void *> self)
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    57
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    58
        if self.ev == NULL :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    59
            raise Exception("event_new")
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    60
    
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    61
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    62
    def assign (self, event_base base not None, lib.evutil_socket_t fd, short events) :
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    63
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    64
            Re-assign our event parameters to the given ones.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    65
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    66
            It is illegal to call this method after calling .add() but before del()/callback!
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    67
        """
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    68
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    69
        if self.alive :
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    70
            raise RuntimeError("Cannot change event while active")
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    71
        
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    72
        # interesting... no error return code
52
722fc70a197a change CallbackEvent to replace fd with ev, event2 doc/style tweaks
Tero Marttila <terom@fixme.fi>
parents: 50
diff changeset
    73
        lib.event_assign(self.ev, base.ev_base, fd, events, ev_callback, <void *> self)
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    74
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    75
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    76
    def add (self, timeout = None) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    77
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    78
            Add this event to our event_base's set of monitored events.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    79
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    80
            This event will be executed if any of the events specified in 'events' occurs, or the given timeout
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    81
            expires. If no timeout is given, no timeout will occur.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    82
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    83
            If this event already has a shceduled timeout, the old timeout will be replaced by the new one.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    84
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    85
                timeout     - a float representing the timeout length
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    86
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    87
            XXX: "The event in the ev argument must be already initialized by event_set() and may not be used in calls to event_set() until it has timed out or been removed with event_del()" -- enforce
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    88
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    89
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    90
        cdef lib.timeval tv
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    91
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    92
        # aquire self-ref
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    93
        self._mark()
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
    94
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    95
        if lib.event_add(self.ev, build_timeout(&tv, timeout)) < 0 :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    96
            raise Exception("event_new")
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    97
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    98
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    99
    def delete (self) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   100
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   101
            Remove this event from our event_base's set of monitored events.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   102
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   103
            If this event has already executed or has never been added this call with have no effect.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   104
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   105
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   106
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   107
        if lib.event_del(self.ev) < 0 :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   108
            raise Exception("event_del")
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   109
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   110
        # release self-ref
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   111
        self._unmark()
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   112
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   113
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   114
    def activate (self, int fd, short mask) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   115
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   116
            'Fake' this event as active, triggering the callback.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   117
        """
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   118
        
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   119
        # aquire self-ref
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   120
        self._mark()
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   121
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   122
        lib.event_active(self.ev, fd, mask)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   123
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   124
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   125
    cpdef pending (self, short mask = 0xffff) :
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   126
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   127
            Returns a bool indicating if this event is pending (that is, has been .add()'d).
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   128
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   129
            For convenience, this defaults to testing all possible flags, and so will return true if any events are
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   130
            pending.
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   131
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   132
            XXX: support returning timeout value?
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   133
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   134
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   135
        return bool(lib.event_pending(self.ev, mask, NULL))
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   136
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   137
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   138
    cdef object _mark (self) :
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   139
        """
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   140
            Refcount magic. Aquires an internal reference *if we don't have one yet*.
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   141
        """
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   142
        
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   143
        if not self.alive :
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   144
            self.alive = True
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   145
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   146
            py.Py_INCREF(self)
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   147
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   148
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   149
    cdef object _unmark (self) :
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   150
        """
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   151
            Refcout magic. Releses the internal reference *if we have one* and libevent doesn't think this event is
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   152
            pending anymore.
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   153
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   154
            XXX: this might cause ourselves to be destroyed... we can't break if that happens.
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   155
        """
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   156
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   157
        if self.alive and not self.pending() :
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   158
            py.Py_DECREF(self)
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   159
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   160
            self.alive = False
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   161
            
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   162
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   163
    property fd :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   164
        def __get__ (self) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   165
            """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   166
                Get the OS file descriptor associated with this event.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   167
            """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   168
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   169
            return lib.event_get_fd(self.ev)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   170
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   171
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   172
    def __call__ (self, lib.evutil_socket_t fd, short mask) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   173
        """
41
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   174
            The method invoked by the internal libevent callback when the event becomes active.
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   175
            
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   176
                fd          - OS file descriptor the event occured on, or -1
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   177
                mask        - bitmask of EV_* flags that represents the triggered event
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   178
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   179
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   180
            The default implementation of __call__ does nothing. The method's return value will be ignored, and should
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   181
            be None. Any errors raised by the callback will be printed out as warning messages, and ignored.
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   182
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   183
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   184
        pass
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   185
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   186
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   187
    def __dealloc__ (self) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   188
        """
50
da394bb715af try and keep lib.event2.event objects alive (via self-ref) while pending
Tero Marttila <terom@fixme.fi>
parents: 47
diff changeset
   189
            Release the event object usign event_free. This should be completely safe as regards our event_base.
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   190
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   191
            XXX: what happens if event_base's __dealloc__ is triggered, but there are still event objects alive?
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   192
        """
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   193
        
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   194
        if self.ev != NULL :
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   195
            lib.event_free(self.ev)
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   196
46
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   197
class CallbackEvent (event) :
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   198
    """
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   199
        Extends the event type to take a callback and additional arguments to invoke from the __call__ method.
52
722fc70a197a change CallbackEvent to replace fd with ev, event2 doc/style tweaks
Tero Marttila <terom@fixme.fi>
parents: 50
diff changeset
   200
722fc70a197a change CallbackEvent to replace fd with ev, event2 doc/style tweaks
Tero Marttila <terom@fixme.fi>
parents: 50
diff changeset
   201
        This will pass the event object itself to the callback in place of the fd.
46
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   202
    """
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   203
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   204
    def __init__ (self, event_base base, lib.evutil_socket_t fd, short events, object callback, *args, **kwargs) :
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   205
        # parent
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   206
        super(CallbackEvent, self).__init__(base, fd, events)
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   207
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   208
        # store
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   209
        self.callback = callback
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   210
        self.args = args
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   211
        self.kwargs = kwargs
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   212
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   213
    def __call__ (self, lib.evutil_socket_t fd, short mask) :
52
722fc70a197a change CallbackEvent to replace fd with ev, event2 doc/style tweaks
Tero Marttila <terom@fixme.fi>
parents: 50
diff changeset
   214
        self.callback(self, mask, *self.args, **self.kwargs)
46
64b4ffb44754 add CallbackEvent helper, and move getaddrinfo from endpoint into its own function
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   215