OLD | NEW |
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 types/constants and functions specific to message pipes. | 5 // This file contains types/constants and functions specific to message pipes. |
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_MESSAGE_PIPE_H_ | 9 #ifndef MOJO_PUBLIC_C_SYSTEM_MESSAGE_PIPE_H_ |
10 #define MOJO_PUBLIC_C_SYSTEM_MESSAGE_PIPE_H_ | 10 #define MOJO_PUBLIC_C_SYSTEM_MESSAGE_PIPE_H_ |
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
83 // | 83 // |
84 // On success, |*message_pipe_handle0| and |*message_pipe_handle1| are set to | 84 // On success, |*message_pipe_handle0| and |*message_pipe_handle1| are set to |
85 // handles for the two endpoints (ports) for the message pipe. | 85 // handles for the two endpoints (ports) for the message pipe. |
86 // | 86 // |
87 // Returns: | 87 // Returns: |
88 // |MOJO_RESULT_OK| on success. | 88 // |MOJO_RESULT_OK| on success. |
89 // |MOJO_RESULT_INVALID_ARGUMENT| if some argument was invalid (e.g., | 89 // |MOJO_RESULT_INVALID_ARGUMENT| if some argument was invalid (e.g., |
90 // |*options| is invalid). | 90 // |*options| is invalid). |
91 // |MOJO_RESULT_RESOURCE_EXHAUSTED| if a process/system/quota/etc. limit has | 91 // |MOJO_RESULT_RESOURCE_EXHAUSTED| if a process/system/quota/etc. limit has |
92 // been reached. | 92 // been reached. |
93 // | |
94 // TODO(vtl): Add an options struct pointer argument. | |
95 MOJO_SYSTEM_EXPORT MojoResult MojoCreateMessagePipe( | 93 MOJO_SYSTEM_EXPORT MojoResult MojoCreateMessagePipe( |
96 const struct MojoCreateMessagePipeOptions* options, // Optional. | 94 const struct MojoCreateMessagePipeOptions* options, // Optional. |
97 MojoHandle* message_pipe_handle0, // Out. | 95 MojoHandle* message_pipe_handle0, // Out. |
98 MojoHandle* message_pipe_handle1); // Out. | 96 MojoHandle* message_pipe_handle1); // Out. |
99 | 97 |
100 // Writes a message to the message pipe endpoint given by |message_pipe_handle|, | 98 // Writes a message to the message pipe endpoint given by |message_pipe_handle|, |
101 // with message data specified by |bytes| of size |num_bytes| and attached | 99 // with message data specified by |bytes| of size |num_bytes| and attached |
102 // handles specified by |handles| of count |num_handles|, and options specified | 100 // handles specified by |handles| of count |num_handles|, and options specified |
103 // by |flags|. If there is no message data, |bytes| may be null, in which case | 101 // by |flags|. If there is no message data, |bytes| may be null, in which case |
104 // |num_bytes| must be zero. If there are no attached handles, |handles| may be | 102 // |num_bytes| must be zero. If there are no attached handles, |handles| may be |
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
170 uint32_t* num_bytes, // Optional in/out. | 168 uint32_t* num_bytes, // Optional in/out. |
171 MojoHandle* handles, // Optional out. | 169 MojoHandle* handles, // Optional out. |
172 uint32_t* num_handles, // Optional in/out. | 170 uint32_t* num_handles, // Optional in/out. |
173 MojoReadMessageFlags flags); | 171 MojoReadMessageFlags flags); |
174 | 172 |
175 #ifdef __cplusplus | 173 #ifdef __cplusplus |
176 } // extern "C" | 174 } // extern "C" |
177 #endif | 175 #endif |
178 | 176 |
179 #endif // MOJO_PUBLIC_C_SYSTEM_MESSAGE_PIPE_H_ | 177 #endif // MOJO_PUBLIC_C_SYSTEM_MESSAGE_PIPE_H_ |
OLD | NEW |