diff options
| author | NIIBE Yutaka <gniibe@fsij.org> | 2016-06-30 16:41:32 +0900 |
|---|---|---|
| committer | NIIBE Yutaka <gniibe@fsij.org> | 2016-06-30 16:41:32 +0900 |
| commit | c7e571eca0c925008be99efb4e7ba3bc876a7309 (patch) | |
| tree | be91bced2f22c4d67de88ec07d9aaa6c6ca693ca | |
| parent | 0decd305b9b3c1fae4fb9a282bee1ab80a4e764a (diff) | |
update doc
| -rw-r--r-- | doc/chopstx-api.texi | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/chopstx-api.texi b/doc/chopstx-api.texi index 1bfeaf3..486907d 100644 --- a/doc/chopstx-api.texi +++ b/doc/chopstx-api.texi @@ -176,11 +176,15 @@ Returns old state which is 0 when it was enabled. @subheading chopstx_poll @anchor{chopstx_poll} -@deftypefun {int} {chopstx_poll} (uint32_t * @var{usec_p}, int @var{n}, @var{...}) +@deftypefun {int} {chopstx_poll} (uint32_t * @var{usec_p}, int @var{n}, struct chx_poll_head * [] @var{pd_array}) @var{usec_p}: Pointer to usec for timeout. Forever if NULL. @var{n}: Number of poll descriptors +@var{pd_array}: Pointer to an array of poll descriptor pointer which +should be one of: +chopstx_poll_cond_t, chopstx_poll_join_t, or chopstx_intr_t. + Returns number of active descriptors. @end deftypefun |