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

Unified Diff: third_party/mojo/src/mojo/public/cpp/system/message_pipe.h

Issue 883843002: Update mojo sdk to rev 126532ce21c5c3c55a1e1693731411cb60169efd (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Response to review 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 side-by-side diff with in-line comments
Download patch
Index: third_party/mojo/src/mojo/public/cpp/system/message_pipe.h
diff --git a/third_party/mojo/src/mojo/public/cpp/system/message_pipe.h b/third_party/mojo/src/mojo/public/cpp/system/message_pipe.h
index b41469e9866bc122ba519f260d0ea18d10ad062a..e7a1e353c46e7b17b4606ec8f52dd2b766e8c182 100644
--- a/third_party/mojo/src/mojo/public/cpp/system/message_pipe.h
+++ b/third_party/mojo/src/mojo/public/cpp/system/message_pipe.h
@@ -2,6 +2,13 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
+// This file provides a C++ wrapping around the Mojo C API for message pipes,
+// replacing the prefix of "Mojo" with a "mojo" namespace, and using more
+// strongly-typed representations of |MojoHandle|s.
+//
+// Please see "mojo/public/c/system/message_pipe.h" for complete documentation
+// of the API.
+
#ifndef MOJO_PUBLIC_CPP_SYSTEM_MESSAGE_PIPE_H_
#define MOJO_PUBLIC_CPP_SYSTEM_MESSAGE_PIPE_H_
@@ -13,8 +20,8 @@
namespace mojo {
-// MessagePipeHandle -----------------------------------------------------------
-
+// A strongly-typed representation of a |MojoHandle| to one end of a message
+// pipe.
class MessagePipeHandle : public Handle {
public:
MessagePipeHandle() {}
@@ -30,6 +37,8 @@ typedef ScopedHandleBase<MessagePipeHandle> ScopedMessagePipeHandle;
static_assert(sizeof(ScopedMessagePipeHandle) == sizeof(MessagePipeHandle),
"Bad size for C++ ScopedMessagePipeHandle");
+// Creates a message pipe. See |MojoCreateMessagePipe()| for complete
+// documentation.
inline MojoResult CreateMessagePipe(const MojoCreateMessagePipeOptions* options,
ScopedMessagePipeHandle* message_pipe0,
ScopedMessagePipeHandle* message_pipe1) {
@@ -46,9 +55,16 @@ inline MojoResult CreateMessagePipe(const MojoCreateMessagePipeOptions* options,
return rv;
}
-// These "raw" versions fully expose the underlying API, but don't help with
-// ownership of handles (especially when writing messages).
-// TODO(vtl): Write "baked" versions.
+// The following "...Raw" versions fully expose the underlying API, and don't
+// help with ownership of handles (especially when writing messages). It is
+// expected that in most cases these methods will be called through generated
+// bindings anyway.
+// TODO(vtl): Write friendlier versions of these functions (using scoped
+// handles and/or vectors) if there is a demonstrated need for them.
+
+// Writes to a message pipe. If handles are attached, on success the handles
+// will no longer be valid (the receiver will receive equivalent, but logically
+// different, handles). See |MojoWriteMessage()| for complete documentation.
inline MojoResult WriteMessageRaw(MessagePipeHandle message_pipe,
const void* bytes,
uint32_t num_bytes,
@@ -59,6 +75,8 @@ inline MojoResult WriteMessageRaw(MessagePipeHandle message_pipe,
message_pipe.value(), bytes, num_bytes, handles, num_handles, flags);
}
+// Reads from a message pipe. See |MojoReadMessage()| for complete
+// documentation.
inline MojoResult ReadMessageRaw(MessagePipeHandle message_pipe,
void* bytes,
uint32_t* num_bytes,
« no previous file with comments | « third_party/mojo/src/mojo/public/cpp/system/macros.h ('k') | third_party/mojo/src/mojo/public/dart/application.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698