EDK: Move ref counting classes to mojo/edk/util.

mojo/edk/system/channel_endpoint.h

 // Copyright 2014 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_ENDPOINT_H_
 #define MOJO_EDK_SYSTEM_CHANNEL_ENDPOINT_H_
 
 #include <memory>
 
 #include "mojo/edk/system/channel_endpoint_id.h"
 #include "mojo/edk/system/message_in_transit_queue.h"
 #include "mojo/edk/system/mutex.h"
-#include "mojo/edk/system/ref_counted.h"
-#include "mojo/edk/system/ref_ptr.h"
+#include "mojo/edk/util/ref_counted.h"
+#include "mojo/edk/util/ref_ptr.h"
 #include "mojo/public/cpp/system/macros.h"
 
 namespace mojo {
 namespace system {
 
 class Channel;
 class ChannelEndpointClient;
 class MessageInTransit;
 
 // TODO(vtl): The plan:
@@ skipping 77 matching lines @@
 //         things proceed as in one of the above cases. The endpoint is *not*
 //         a zombie until it is detached (or a "remove" message is received).
 //         [TODO(vtl): Maybe we can get rid of this case? It'd only not yet be
 //         running since under the current scheme it wouldn't have a remote ID
 //         yet.]
 //       - Note that even if the local side is closed, it may still receive a
 //         "remove" message from the other side (if the other side is closed
 //         simultaneously, and both sides send "remove" messages). In that
 //         case, it must still remain alive until it receives the "remove
 //         ack" (and it must ack the "remove" message that it received).
-class ChannelEndpoint final : public RefCountedThreadSafe<ChannelEndpoint> {
+class ChannelEndpoint final
+    : public util::RefCountedThreadSafe<ChannelEndpoint> {
  public:
-  // Note: Use |MakeRefCounted<ChannelEndpoint>()|.
+  // Note: Use |util::MakeRefCounted<ChannelEndpoint>()|.
 
   // Methods called by |ChannelEndpointClient|:
 
   // Called to enqueue an outbound message. (If |AttachAndRun()| has not yet
   // been called, the message will be enqueued and sent when |AttachAndRun()| is
   // called.)
   bool EnqueueMessage(std::unique_ptr<MessageInTransit> message);
 
   // Called to *replace* current client with a new client (which must differ
   // from the existing client). This must not be called after
   // |DetachFromClient()| has been called.
   //
   // This returns true in the typical case, and false if this endpoint has been
   // detached from the channel, in which case the caller should probably call
   // its (new) client's |OnDetachFromChannel()|.
-  bool ReplaceClient(RefPtr<ChannelEndpointClient>&& client,
+  bool ReplaceClient(util::RefPtr<ChannelEndpointClient>&& client,
                      unsigned client_port);
 
   // Called before the |ChannelEndpointClient| gives up its reference to this
   // object.
   void DetachFromClient();
 
   // Methods called by |Channel|:
 
   // Called when the |Channel| takes a reference to this object. This will send
   // all queue messages (in |channel_message_queue_|).
@@ skipping 13 matching lines @@
   FRIEND_MAKE_REF_COUNTED(ChannelEndpoint);
 
   // Constructor for a |ChannelEndpoint| with the given client (specified by
   // |client| and |client_port|). Optionally takes messages from
   // |*message_queue| if |message_queue| is non-null.
   //
   // |client| may be null if this endpoint will never need to receive messages,
   // in which case |message_queue| should not be null. In that case, this
   // endpoint will simply send queued messages upon being attached to a
   // |Channel| and immediately detach itself.
-  ChannelEndpoint(RefPtr<ChannelEndpointClient>&& client,
+  ChannelEndpoint(util::RefPtr<ChannelEndpointClient>&& client,
                   unsigned client_port,
                   MessageInTransitQueue* message_queue = nullptr);
 
   ~ChannelEndpoint();
 
   bool WriteMessageNoLock(std::unique_ptr<MessageInTransit> message)
       MOJO_EXCLUSIVE_LOCKS_REQUIRED(mutex_);
 
   // Helper for |OnReadMessage()|, handling messages for the client.
   void OnReadMessageForClient(std::unique_ptr<MessageInTransit> message);
@@ skipping 10 matching lines @@
     // |AttachAndRun()| has been called, but not |DetachFromChannel()|
     // (|channel_| is non-null and valid).
     RUNNING,
     // |DetachFromChannel()| has been called (|channel_| is null).
     DEAD
   };
   State state_ MOJO_GUARDED_BY(mutex_);
 
   // |client_| must be valid whenever it is non-null. Before |*client_| gives up
   // its reference to this object, it must call |DetachFromClient()|.
-  // NOTE: This is a |RefPtr<>|, rather than a raw pointer, since the |Channel|
-  // needs to keep the client (e.g., |MessagePipe|) alive for the "proxy-proxy"
-  // case.
+  // NOTE: This is a |util:RefPtr<>|, rather than a raw pointer, since the
+  // |Channel| needs to keep the client (e.g., |MessagePipe|) alive for the
+  // "proxy-proxy" case.
   // WARNING: |ChannelEndpointClient| methods must not be called under |mutex_|.
   // Thus to make such a call, a reference must first be taken under |mutex_|
   // and the lock released.
   // TODO(vtl): Annotate the above rule using |MOJO_ACQUIRED_{BEFORE,AFTER}()|,
   // once clang actually checks such annotations.
   // https://github.com/domokit/mojo/issues/313
   // WARNING: Beware of interactions with |ReplaceClient()|. By the time the
   // call is made, the client may have changed. This must be detected and dealt
   // with.
-  RefPtr<ChannelEndpointClient> client_ MOJO_GUARDED_BY(mutex_);
+  util::RefPtr<ChannelEndpointClient> client_ MOJO_GUARDED_BY(mutex_);
   unsigned client_port_ MOJO_GUARDED_BY(mutex_);
 
   // |channel_| must be valid whenever it is non-null. Before |*channel_| gives
   // up its reference to this object, it must call |DetachFromChannel()|.
   // |local_id_| and |remote_id_| are valid if and only |channel_| is non-null.
   Channel* channel_ MOJO_GUARDED_BY(mutex_);
   ChannelEndpointId local_id_ MOJO_GUARDED_BY(mutex_);
   ChannelEndpointId remote_id_ MOJO_GUARDED_BY(mutex_);
 
   // This queue is used before we're running on a channel and ready to send
   // messages to the channel.
   MessageInTransitQueue channel_message_queue_ MOJO_GUARDED_BY(mutex_);
 
   MOJO_DISALLOW_COPY_AND_ASSIGN(ChannelEndpoint);
 };
 
 }  // namespace system
 }  // namespace mojo
 
 #endif  // MOJO_EDK_SYSTEM_CHANNEL_ENDPOINT_H_