qmsk/net/lib/event2/event.pyx
author Tero Marttila <terom@fixme.fi>
Mon, 31 Aug 2009 22:10:46 +0300
changeset 42 0ff56f7216ee
parent 41 02f7c0539843
child 47 b45a6648931c
permissions -rw-r--r--
fix some segfaults with event
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
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     3
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     4
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
     5
    """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
        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
     7
        NULL.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     8
    """
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
    cdef double t
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
41
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
    12
    if timeout is not None :
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    13
        t = timeout
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    15
        tv.tv_sec = <int>(t)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    16
        tv.tv_usec = <int>((t - <int> t) * 100000)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    17
        
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    18
        return tv
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    19
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    20
    else :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    21
        return NULL
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    22
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
# our shared callback handler
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    25
# this must aquire the GIL before invoking the python object
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    26
# 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
    27
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
    28
    """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    29
        Proxy event back to event object passed as arg
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    30
    """
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
    # unpack opaque arg
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    33
    cdef event ev = <event>arg
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    34
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
    # invoke
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
    # XXX: logging?
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
    ev(fd, mask)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    38
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    40
cdef class event :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    41
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    42
    def __init__ (self, event_base base not None, lib.evutil_socket_t fd, short events) :
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    43
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    44
        # libevent seems to segfault otherwise...
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    45
        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
    46
            raise ValueError(fd)
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    47
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    48
        # construct event using our internal callback, with self as the arg
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    49
        self.ev = lib.event_new(base.ev_base, fd, events, ev_callback, <void *>self)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    50
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    51
        if self.ev == NULL :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    52
            raise Exception("event_new")
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    53
    
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    54
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
    55
    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
    56
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    57
            Re-assign our event parameters to the given ones.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    58
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    59
            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
    60
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    61
        
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    62
        # interesting... no error return code
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    63
        lib.event_assign(self.ev, base.ev_base, fd, events, ev_callback, <void *>self)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    64
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
    def add (self, timeout = None) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    67
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    68
            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
    69
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    70
            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
    71
            expires. If no timeout is given, no timeout will occur.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    72
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    73
            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
    74
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    75
                timeout     - a float representing the timeout length
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    76
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    77
            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
    78
        """
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
        cdef lib.timeval tv
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    81
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    82
        if lib.event_add(self.ev, build_timeout(&tv, timeout)) < 0 :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    83
            raise Exception("event_new")
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
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    86
    def delete (self) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    87
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    88
            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
    89
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    90
            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
    91
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    92
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    93
        if lib.event_del(self.ev) < 0 :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    94
            raise Exception("event_del")
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    95
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    96
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    97
    def activate (self, int fd, short mask) :
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
            'Fake' this event as active, triggering the callback.
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
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   102
        lib.event_active(self.ev, fd, mask)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   103
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   104
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   105
    def pending (self, short mask = 0xffff) :
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   106
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   107
            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
   108
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   109
            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
   110
            pending.
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   111
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   112
            XXX: support returning timeout value?
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
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   115
        return bool(lib.event_pending(self.ev, mask, NULL))
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   116
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   117
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   118
    property fd :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   119
        def __get__ (self) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   120
            """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   121
                Get the OS file descriptor associated with this event.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   122
            """
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
            return lib.event_get_fd(self.ev)
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   125
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
    def __call__ (self, lib.evutil_socket_t fd, short mask) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   128
        """
41
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   129
            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
   130
            
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   131
                fd          - OS file descriptor the event occured on, or -1
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   132
                mask        - bitmask of EV_* flags that represents the triggered event
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   133
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   134
02f7c0539843 * fix timeout=0.0
Tero Marttila <terom@fixme.fi>
parents: 39
diff changeset
   135
            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
   136
            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
   137
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   138
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   139
        pass
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   140
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   141
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   142
    def __dealloc__ (self) :
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   143
        """
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   144
            Release the event object usign event_free. This should be completely safe as regards out event_base.
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   145
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   146
            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
   147
        """
42
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   148
        
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   149
        if self.ev != NULL :
0ff56f7216ee fix some segfaults with event
Tero Marttila <terom@fixme.fi>
parents: 41
diff changeset
   150
            lib.event_free(self.ev)
39
075eaafa80a7 initial lib.event2 code
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
   151