Update mojo sdk to rev cc531b32182099a5a034a99daff35ed5d38a61c8

mojo/edk/system/channel.h

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef MOJO_EDK_SYSTEM_CHANNEL_H_
 #define MOJO_EDK_SYSTEM_CHANNEL_H_
 
 #include <stdint.h>
 
 #include "base/containers/hash_tables.h"
@@ skipping 13 matching lines @@
 #include "mojo/public/c/system/types.h"
 
 namespace mojo {
 
 namespace embedder {
 class PlatformSupport;
 }
 
 namespace system {
 
-class ChannelEndpoint;
+class ChannelEndpointClient;
 class ChannelManager;
+class MessageInTransitQueue;
 
 // This class is mostly thread-safe. It must be created on an I/O thread.
 // |Init()| must be called on that same thread before it becomes thread-safe (in
 // particular, before references are given to any other thread) and |Shutdown()|
 // must be called on that same thread before destruction. Its public methods are
 // otherwise thread-safe. (Many private methods are restricted to the creation
 // thread.) It may be destroyed on any thread, in the sense that the last
 // reference to it may be released on any thread, with the proviso that
 // |Shutdown()| must have been called first (so the pattern is that a "main"
 // reference is kept on its creation thread and is released after |Shutdown()|
@@ skipping 52 matching lines @@
 
   // Removes the given endpoint from this channel (|local_id| and |remote_id|
   // are specified as an optimization; the latter should be an invalid
   // |ChannelEndpointId| if the endpoint is not yet running). Note: If this is
   // called, the |Channel| will *not* call
   // |ChannelEndpoint::DetachFromChannel()|.
   void DetachEndpoint(ChannelEndpoint* endpoint,
                       ChannelEndpointId local_id,
                       ChannelEndpointId remote_id);
 
-  // Returns the size of a serialized endpoint (see |SerializeEndpoint()| and
+  // Returns the size of a serialized endpoint (see |SerializeEndpoint...()| and
   // |DeserializeEndpoint()| below). This value will remain constant for a given
   // instance of |Channel|.
   size_t GetSerializedEndpointSize() const;
 
-  // Serializes the given endpoint, writing to |destination| auxiliary
-  // information to be transmitted to the peer |Channel| via some other means.
-  // |destination| should point to a buffer of (at least) the size returned by
+  // Endpoint serialization methods: From the |Channel|'s point of view, there
+  // are three cases (discussed further below) and thus three methods.
+  //
+  // All three methods have a |destination| argument, which should be a buffer
+  // to which auxiliary information will be written and which should be
+  // transmitted to the peer |Channel| by some other means, but using this
+  // |Channel|. It should be a buffer of (at least) the size returned by
   // |GetSerializedEndpointSize()| (exactly that much data will be written).
-  void SerializeEndpoint(scoped_refptr<ChannelEndpoint> endpoint,
-                         void* destination);
+  //
+  // All three also have a |message_queue| argument, which if non-null is the
+  // queue of messages already received by the endpoint to be serialized.
+  //
+  // Note that "serialize" really means "send" -- the |endpoint| will be sent
+  // "immediately". The contents of the |destination| buffer can then be used to
+  // claim the rematerialized endpoint from the peer |Channel|. (|destination|
+  // must be sent using this |Channel|, since otherwise it may be received
+  // before it is valid to the peer |Channel|.)
+  //
+  // Case 1: The endpoint's peer is already closed.
+  //
+  // Case 2: The endpoint's peer is local (i.e., it has a
+  // |ChannelEndpointClient| but no peer |ChannelEndpoint|).
+  //
+  // Case 3: The endpoint's peer is remote (i.e., it has a peer
+  // |ChannelEndpoint|). (This has two subcases: the peer endpoint may be on
+  // this |Channel| or another |Channel|.)
+  void SerializeEndpointWithClosedPeer(void* destination,
+                                       MessageInTransitQueue* message_queue);
+  // This one returns the |ChannelEndpoint| for the serialized endpoint (which
+  // can be used by, e.g., a |ProxyMessagePipeEndpoint|.
+  scoped_refptr<ChannelEndpoint> SerializeEndpointWithLocalPeer(
+      void* destination,
+      MessageInTransitQueue* message_queue,
+      ChannelEndpointClient* endpoint_client,
+      unsigned endpoint_client_port);
+  void SerializeEndpointWithRemotePeer(
+      void* destination,
+      MessageInTransitQueue* message_queue,
+      scoped_refptr<ChannelEndpoint> peer_endpoint);
 
   // Deserializes an endpoint that was sent from the peer |Channel| (using
-  // |SerializeEndpoint()|. |source| should be (a copy of) the data that
-  // |SerializeEndpoint()| wrote, and must be (at least)
+  // |SerializeEndpoint...()|. |source| should be (a copy of) the data that
+  // |SerializeEndpoint...()| wrote, and must be (at least)
   // |GetSerializedEndpointSize()| bytes. This returns the deserialized
   // |IncomingEndpoint| (which can be converted into a |MessagePipe|) or null on
   // error.
   scoped_refptr<IncomingEndpoint> DeserializeEndpoint(const void* source);
 
   // See |RawChannel::GetSerializedPlatformHandleSize()|.
   size_t GetSerializedPlatformHandleSize() const;
 
   embedder::PlatformSupport* platform_support() const {
     return platform_support_;
@@ skipping 26 matching lines @@
   // Handles "remove endpoint ack" messages.
   bool OnRemoveEndpointAck(ChannelEndpointId local_id);
 
   // Handles errors (e.g., invalid messages) from the remote side. Callable from
   // any thread.
   void HandleRemoteError(const base::StringPiece& error_message);
   // Handles internal errors/failures from the local side. Callable from any
   // thread.
   void HandleLocalError(const base::StringPiece& error_message);
 
-  // Helper for |SerializeEndpoint()|: Attaches the given (non-bootstrap)
+  // Helper for |SerializeEndpoint...()|: Attaches the given (non-bootstrap)
   // endpoint to this channel and runs it. This assigns the endpoint both local
   // and remote IDs. This will also send a |kSubtypeChannelAttachAndRunEndpoint|
   // message to the remote side to tell it to create an endpoint as well. This
   // returns the *remote* ID (one for which |is_remote()| returns true).
   //
   // TODO(vtl): Maybe limit the number of attached message pipes.
   ChannelEndpointId AttachAndRunEndpoint(
       scoped_refptr<ChannelEndpoint> endpoint);
 
   // Helper to send channel control messages. Returns true on success. Should be
   // called *without* |lock_| held. Callable from any thread.
   bool SendControlMessage(MessageInTransit::Subtype subtype,
                           ChannelEndpointId source_id,
                           ChannelEndpointId destination_id);
 
   base::ThreadChecker creation_thread_checker_;
 
   embedder::PlatformSupport* const platform_support_;
 
   // Note: |ChannelEndpointClient|s (in particular, |MessagePipe|s) MUST NOT be
   // used under |lock_|. E.g., |lock_| can only be acquired after
   // |MessagePipe::lock_|, never before. Thus to call into a
-  // |ChannelEndpointClinet|, a reference should be acquired from
+  // |ChannelEndpointClient|, a reference should be acquired from
   // |local_id_to_endpoint_map_| under |lock_| and then the lock released.
   base::Lock lock_;  // Protects the members below.
 
   scoped_ptr<RawChannel> raw_channel_;
   bool is_running_;
   // Set when |WillShutdownSoon()| is called.
   bool is_shutting_down_;
 
   // Has a reference to us.
   ChannelManager* channel_manager_;
@@ skipping 15 matching lines @@
   // if/when we wrap).
   RemoteChannelEndpointIdGenerator remote_id_generator_;
 
   DISALLOW_COPY_AND_ASSIGN(Channel);
 };
 
 }  // namespace system
 }  // namespace mojo
 
 #endif  // MOJO_EDK_SYSTEM_CHANNEL_H_