Chromium Code Reviews| Index: mojo/public/c/system/functions.h |
| diff --git a/mojo/public/c/system/functions.h b/mojo/public/c/system/functions.h |
| index 6045f2f462d32e6e75f883be6269a9351b0e18f4..89e82ea5e65dbccd0a22f328c3425901dfe23050 100644 |
| --- a/mojo/public/c/system/functions.h |
| +++ b/mojo/public/c/system/functions.h |
| @@ -101,6 +101,90 @@ MOJO_SYSTEM_EXPORT MojoResult MojoWaitMany(const MojoHandle* handles, |
| uint32_t num_handles, |
| MojoDeadline deadline); |
| +// Waits on the given handle until one of the following happens: |
| +// - a signal indicated by |signals| is satisfied. |
|
viettrungluu
2014/12/02 17:24:55
nit: Capitalize 'a'. (I suppose this is a list of
jimbe
2014/12/02 19:21:18
Done.
|
| +// - it becomes known that no signal indicated by |signals| will ever be |
|
viettrungluu
2014/12/02 17:24:56
Ditto. Also, the terminating period should be outs
jimbe
2014/12/02 19:21:19
Done. It's now an independent clause, so period st
|
| +// satisfied (see the description of the |MOJO_RESULT_CANCELLED| and |
| +// |MOJO_RESULT_FAILED_PRECONDITION| return values below.) |
| +// - until |deadline| has passed. |
|
viettrungluu
2014/12/02 17:24:55
" (etc.)
jimbe
2014/12/02 19:21:19
Done.
|
| +// |
| +// If |deadline| is |MOJO_DEADLINE_INDEFINITE|, this will wait "forever" (until |
| +// one of the other wait termination conditions is satisfied). If |deadline| is |
| +// 0, this will return |MOJO_RESULT_DEADLINE_EXCEEDED| only if one of the other |
| +// termination conditions (e.g., a signal is satisfied, or all signals are |
| +// unsatisfiable) is not already satisfied. |
| +// |
| +// |signals_state| (optional) See documentation for |MojoHandleSignalsState|. |
|
viettrungluu
2014/12/02 17:24:55
nit: colon after "(optional)"
jimbe
2014/12/02 19:21:18
Done.
|
| +// |
| +// Returns: |
| +// |MOJO_RESULT_OK| if some signal in |signals| was satisfied (or is already |
| +// satisfied). |
| +// |MOJO_RESULT_CANCELLED| if |handle| was closed (necessarily from another |
| +// thread) during the wait. |
| +// |MOJO_RESULT_INVALID_ARGUMENT| if |handle| is not a valid handle (e.g., if |
| +// it has already been closed). The |signals_state| value is unchanged. |
| +// |MOJO_RESULT_DEADLINE_EXCEEDED| if the deadline has passed without any of |
| +// the signals being satisfied. |
| +// |MOJO_RESULT_FAILED_PRECONDITION| if it becomes known that none of the |
| +// signals in |signals| can ever be satisfied (e.g., when waiting on one |
| +// end of a message pipe and the other end is closed). |
| +// |
| +// If there are multiple waiters (on different threads, obviously) waiting on |
| +// the same handle and signal, and that signal becomes is satisfied, all waiters |
| +// will be awoken. |
| +MOJO_SYSTEM_EXPORT MojoResult |
| +MojoNewWait(MojoHandle handle, |
| + MojoHandleSignals signals, |
| + MojoDeadline deadline, |
| + struct MojoHandleSignalsState* signals_state); // Optional out. |
| + |
| +// Waits on |handles[0]|, ..., |handles[num_handles-1]| until: |
| +// - (at least) one handle satisfies a signal indicated in its respective |
|
viettrungluu
2014/12/02 17:24:55
Needs punctuation, and possibly capitalization.
jimbe
2014/12/02 19:21:19
Done.
|
| +// |signals[0]|, ..., |signals[num_handles-1]| |
| +// - it becomes known that no signal in some |signals[i]| will ever be |
| +// satisfied |
| +// - |deadline| has passed |
| +// |
| +// This means that |MojoWaitMany()| behaves as if |MojoWait()| were called on |
| +// each handle/signals pair simultaneously, completing when the first |
| +// |MojoWait()| would complete. |
| +// |
| +// See |MojoWait()| for more details about |deadline|. |
| +// |
| +// |result_index| (optional) is returned to indicate the index of the handle |
| +// that caused the call to return. For example, the index |i| (from 0 to |
|
viettrungluu
2014/12/02 17:24:55
nit: "is returned" -> "is used to return"
jimbe
2014/12/02 19:21:19
Done.
|
| +// |num_handles-1|) if |handle[i]| satisfies a signal from |signals[i]|. You |
| +// must manually initialize this to -1 before you make this call because |
|
viettrungluu
2014/12/02 17:24:55
"-1" -> "a suitable sentinel value" (also add "(e.
jimbe
2014/12/02 19:21:18
Done.
|
| +// this value is not updated if there is no specific handle that causes the |
| +// function to return. Pass null if you don't need this value to be |
| +// returned. |
| +// |
| +// |signals_states| (optional) points to an array of size |num_handles| of |
| +// MojoHandleSignalsState. See |MojoHandleSignalsState| for more details |
| +// about the meaning of each array entry. This array is not an atomic |
| +// snapshot. The array will be updated if the function does not return |
| +// |MOJO_RESULT_INVALID_ARGUMENT| or |MOJO_RESULT_RESOURCE_EXHAUSTED|. |
| +// |
| +// Returns: |
| +// |MOJO_RESULT_CANCELLED| if some |handle[i]| was closed (necessarily from |
| +// another thread) during the wait. |
| +// |MOJO_RESULT_RESOURCE_EXHAUSTED| if there are too many handles. The |
|
viettrungluu
2014/12/02 17:24:55
nit: here and elsewhere: one space after '.'
jimbe
2014/12/02 19:21:18
Done.
|
| +// |signals_state| array is unchanged. |
| +// |MOJO_RESULT_INVALID_ARGUMENT| if some |handle[i]| is not a valid handle |
| +// (e.g., if it is NULL or if it has already been closed). The |
|
viettrungluu
2014/12/02 17:24:55
"NULL" here is incorrect.
jimbe
2014/12/02 19:21:18
Done.
|
| +// |signals_state| array is unchanged. |
| +// |MOJO_RESULT_DEADLINE_EXCEEDED| if the deadline has passed without any of |
| +// handles satisfying any of its signals. |
| +// |MOJO_RESULT_FAILED_PRECONDITION| if it is or becomes impossible that SOME |
| +// |handle[i]| will ever satisfy any of the signals in |signals[i]|. |
| +MOJO_SYSTEM_EXPORT MojoResult |
| +MojoNewWaitMany(const MojoHandle* handles, |
| + const MojoHandleSignals* signals, |
| + uint32_t num_handles, |
| + MojoDeadline deadline, |
| + uint32_t* result_index, // Optional out |
| + struct MojoHandleSignalsState* signals_states); // Optional out |
| + |
| #ifdef __cplusplus |
| } // extern "C" |
| #endif |