diff options
Diffstat (limited to 'src/gevent/gevent.h')
| -rw-r--r-- | src/gevent/gevent.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/gevent/gevent.h b/src/gevent/gevent.h index a2b962ec..3c5a0bd4 100644 --- a/src/gevent/gevent.h +++ b/src/gevent/gevent.h @@ -146,7 +146,6 @@ void geventDetachSource(GListener *pl, GSourceHandle gsh); * @brief Wait for an event on a listener from an assigned source. * @details The type of the event should be checked (pevent->type) and then pevent should * be typecast to the actual event type if it needs to be processed. - * timeout specifies the time to wait in system ticks. * TIME_INFINITE means no timeout - wait forever for an event. * TIME_IMMEDIATE means return immediately * @note The returned GEvent is released when this routine is called again @@ -154,9 +153,11 @@ void geventDetachSource(GListener *pl, GSourceHandle gsh); * allows the GEvent object to be reused earlier which can reduce missed events. The GEvent * object MUST NOT be used after this function is called (and is blocked waiting for the next * event) or after geventEventComplete() is called. + * The one listener object should not be waited on using more than one thread simultanously + * because of the implicit geventEventComplete() that occurs when this function is called. * * @param[in] pl The listener - * @param[in] timeout The timeout + * @param[in] timeout The timeout in milliseconds * * @return NULL on timeout */ @@ -216,7 +217,7 @@ GSourceListener *geventGetSourceListener(GSourceHandle gsh, GSourceListener *las * * @param[in] psl The source listener * - * @return NULL if the listener is not currently listening. + * @return NULL if the event buffer for this listener is currently in use. */ GEvent *geventGetEventBuffer(GSourceListener *psl); |