Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(801)

Side by Side Diff: mojo/public/c/system/functions.h

Issue 847703006: Minor tweaks to API documentation and code comments. (Closed) Base URL: https://github.com/domokit/mojo.git@master
Patch Set: Created 5 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright 2014 The Chromium Authors. All rights reserved. 1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 // This file contains basic functions common to different Mojo system APIs. 5 // This file contains basic functions common to different Mojo system APIs.
6 // 6 //
7 // Note: This header should be compilable as C. 7 // Note: This header should be compilable as C.
8 8
9 #ifndef MOJO_PUBLIC_C_SYSTEM_FUNCTIONS_H_ 9 #ifndef MOJO_PUBLIC_C_SYSTEM_FUNCTIONS_H_
10 #define MOJO_PUBLIC_C_SYSTEM_FUNCTIONS_H_ 10 #define MOJO_PUBLIC_C_SYSTEM_FUNCTIONS_H_
11 11
12 // Note: This header should be compilable as C.
13
14 #include "mojo/public/c/system/system_export.h" 12 #include "mojo/public/c/system/system_export.h"
15 #include "mojo/public/c/system/types.h" 13 #include "mojo/public/c/system/types.h"
16 14
17 #ifdef __cplusplus 15 #ifdef __cplusplus
18 extern "C" { 16 extern "C" {
19 #endif 17 #endif
20 18
21 // Note: Pointer parameters that are labelled "optional" may be null (at least 19 // Note: Pointer parameters that are labelled "optional" may be null (at least
22 // under some circumstances). Non-const pointer parameters are also labeled 20 // under some circumstances). Non-const pointer parameters are also labeled
23 // "in", "out", or "in/out", to indicate how they are used. (Note that how/if 21 // "in", "out", or "in/out", to indicate how they are used. (Note that how/if
24 // such a parameter is used may depend on other parameters or the requested 22 // such a parameter is used may depend on other parameters or the requested
25 // operation's success/failure. E.g., a separate |flags| parameter may control 23 // operation's success/failure. E.g., a separate |flags| parameter may control
26 // whether a given "in/out" parameter is used for input, output, or both.) 24 // whether a given "in/out" parameter is used for input, output, or both.)
27 25
28 // Platform-dependent monotonically increasing tick count representing "right 26 // Returns a platform-dependent, monotonically increasing tick count
29 // now." The resolution of this clock is ~1-15ms. Resolution varies depending 27 // representing "right now." The resolution of this clock is ~1-15ms.
30 // on hardware/operating system configuration. 28 // Resolution varies depending on hardware/operating system configuration.
31 MOJO_SYSTEM_EXPORT MojoTimeTicks MojoGetTimeTicksNow(void); 29 MOJO_SYSTEM_EXPORT MojoTimeTicks MojoGetTimeTicksNow(void);
32 30
33 // Closes the given |handle|. 31 // Closes the given |handle|.
34 // 32 //
35 // Returns: 33 // Returns:
36 // |MOJO_RESULT_OK| on success. 34 // |MOJO_RESULT_OK| on success.
37 // |MOJO_RESULT_INVALID_ARGUMENT| if |handle| is not a valid handle. 35 // |MOJO_RESULT_INVALID_ARGUMENT| if |handle| is not a valid handle.
38 // 36 //
39 // Concurrent operations on |handle| may succeed (or fail as usual) if they 37 // Concurrent operations on |handle| may succeed (or fail as usual) if they
40 // happen before the close, be cancelled with result |MOJO_RESULT_CANCELLED| if 38 // happen before the close, be cancelled with result |MOJO_RESULT_CANCELLED| if
(...skipping 23 matching lines...) Expand all
64 // thread) during the wait. 62 // thread) during the wait.
65 // |MOJO_RESULT_INVALID_ARGUMENT| if |handle| is not a valid handle (e.g., if 63 // |MOJO_RESULT_INVALID_ARGUMENT| if |handle| is not a valid handle (e.g., if
66 // it has already been closed). The |signals_state| value is unchanged. 64 // it has already been closed). The |signals_state| value is unchanged.
67 // |MOJO_RESULT_DEADLINE_EXCEEDED| if the deadline has passed without any of 65 // |MOJO_RESULT_DEADLINE_EXCEEDED| if the deadline has passed without any of
68 // the signals being satisfied. 66 // the signals being satisfied.
69 // |MOJO_RESULT_FAILED_PRECONDITION| if it becomes known that none of the 67 // |MOJO_RESULT_FAILED_PRECONDITION| if it becomes known that none of the
70 // signals in |signals| can ever be satisfied (e.g., when waiting on one 68 // signals in |signals| can ever be satisfied (e.g., when waiting on one
71 // end of a message pipe and the other end is closed). 69 // end of a message pipe and the other end is closed).
72 // 70 //
73 // If there are multiple waiters (on different threads, obviously) waiting on 71 // If there are multiple waiters (on different threads, obviously) waiting on
74 // the same handle and signal, and that signal becomes is satisfied, all waiters 72 // the same handle and signal, and that signal becomes satisfied, all waiters
75 // will be awoken. 73 // will be awoken.
76 MOJO_SYSTEM_EXPORT MojoResult 74 MOJO_SYSTEM_EXPORT MojoResult
77 MojoWait(MojoHandle handle, 75 MojoWait(MojoHandle handle,
78 MojoHandleSignals signals, 76 MojoHandleSignals signals,
79 MojoDeadline deadline, 77 MojoDeadline deadline,
80 struct MojoHandleSignalsState* signals_state); // Optional out. 78 struct MojoHandleSignalsState* signals_state); // Optional out.
81 79
82 // Waits on |handles[0]|, ..., |handles[num_handles-1]| until: 80 // Waits on |handles[0]|, ..., |handles[num_handles-1]| until:
83 // - (At least) one handle satisfies a signal indicated in its respective 81 // - (At least) one handle satisfies a signal indicated in its respective
84 // |signals[0]|, ..., |signals[num_handles-1]|. 82 // |signals[0]|, ..., |signals[num_handles-1]|.
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after
124 uint32_t num_handles, 122 uint32_t num_handles,
125 MojoDeadline deadline, 123 MojoDeadline deadline,
126 uint32_t* result_index, // Optional out 124 uint32_t* result_index, // Optional out
127 struct MojoHandleSignalsState* signals_states); // Optional out 125 struct MojoHandleSignalsState* signals_states); // Optional out
128 126
129 #ifdef __cplusplus 127 #ifdef __cplusplus
130 } // extern "C" 128 } // extern "C"
131 #endif 129 #endif
132 130
133 #endif // MOJO_PUBLIC_C_SYSTEM_FUNCTIONS_H_ 131 #endif // MOJO_PUBLIC_C_SYSTEM_FUNCTIONS_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698