--- pth.pod 2002/11/03 11:15:04 1.159
+++ pth.pod 2002/11/05 19:39:09 1.160
@@ -93,7 +93,7 @@
pth_event_concat,
pth_event_isolate,
pth_event_walk,
-pth_event_occurred,
+pth_event_status,
pth_event_free.
=item B<Key-Based Storage>
@@ -970,11 +970,12 @@
This is the link between the scheduler and the event facility (see below for
the various pth_event_xxx() functions). It's modeled like select(2), i.e., one
gives this function one or more events (in the event ring specified by I<ev>)
-on which the current thread wants to wait. The scheduler awakes the thread
-when one ore more of them occurred after tagging them as occurred. The I<ev>
-argument is a I<pointer> to an event ring which isn't changed except for the
-tagging. pth_wait(3) returns the number of occurred events and the application
-can use pth_event_occurred(3) to test which events occurred.
+on which the current thread wants to wait. The scheduler awakes the
+thread when one ore more of them occurred or failed after tagging
+them as such. The I<ev> argument is a I<pointer> to an event ring
+which isn't changed except for the tagging. pth_wait(3) returns the
+number of occurred or failed events and the application can use
+pth_event_status(3) to test which events occurred or failed.
=item int B<pth_cancel>(pth_t I<tid>);
@@ -1236,12 +1237,15 @@
OR-ed into I<direction> to walk to the next/previous occurred event in the
ring I<ev>.
-=item int B<pth_event_occurred>(pth_event_t I<ev>);
+=item pth_status_t B<pth_event_status>(pth_event_t I<ev>);
-This checks whether the event I<ev> occurred. This is a fast operation because
-only a tag on I<ev> is checked which was either set or still not set by the
-scheduler. In other words: This doesn't check the event itself, it just checks
-the last knowledge of the scheduler.
+This returns the status of event I<ev>. This is a fast operation
+because only a tag on I<ev> is checked which was either set or still
+not set by the scheduler. In other words: This doesn't check the
+event itself, it just checks the last knowledge of the scheduler. The
+possible returned status codes are: C<PTH_STATUS_PENDING> (event is
+still pending), C<PTH_STATUS_OCCURRED> (event successfully occurred),
+C<PTH_STATUS_FAILED> (event failed).
=item int B<pth_event_free>(pth_event_t I<ev>, int I<mode>);
|
