src/content/child/webmessageportchannel_impl.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_CHILD_WEBMESSAGEPORTCHANNEL_IMPL_H_
   6 #define CONTENT_CHILD_WEBMESSAGEPORTCHANNEL_IMPL_H_
   7
   8 #include <queue>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "base/strings/string16.h"
  14 #include "base/synchronization/lock.h"
  15 #include "ipc/ipc_listener.h"
  16 #include "third_party/WebKit/public/platform/WebMessagePortChannel.h"
  17
  18 namespace base {
  19 class MessageLoopProxy;
  20 }
  21
  22 namespace content {
  23 class ChildThread;
  24
  25 // This is thread safe.
  26 class WebMessagePortChannelImpl
  27     : public blink::WebMessagePortChannel,
  28       public IPC::Listener,
  29       public base::RefCountedThreadSafe<WebMessagePortChannelImpl> {
  30  public:
  31   explicit WebMessagePortChannelImpl(base::MessageLoopProxy* child_thread_loop);
  32   WebMessagePortChannelImpl(int route_id,
  33                             int message_port_id,
  34                             base::MessageLoopProxy* child_thread_loop);
  35
  36   // Extracts port IDs for passing on to the browser process, and queues any
  37   // received messages. Takes ownership of the passed array (and deletes it).
  38   static std::vector<int> ExtractMessagePortIDs(
  39       blink::WebMessagePortChannelArray* channels);
  40
  41   // Queues received and incoming messages until there are no more in-flight
  42   // messages, then sends all of them to the browser process.
  43   void QueueMessages();
  44   int message_port_id() const { return message_port_id_; }
  45
  46  private:
  47   friend class base::RefCountedThreadSafe<WebMessagePortChannelImpl>;
  48   virtual ~WebMessagePortChannelImpl();
  49
  50   // WebMessagePortChannel implementation.
  51   virtual void setClient(blink::WebMessagePortChannelClient* client);
  52   virtual void destroy();
  53   virtual void entangle(blink::WebMessagePortChannel* channel);
  54   virtual void postMessage(const blink::WebString& message,
  55                            blink::WebMessagePortChannelArray* channels);
  56   virtual bool tryGetMessage(blink::WebString* message,
  57                              blink::WebMessagePortChannelArray& channels);
  58
  59   void Init();
  60   void Entangle(scoped_refptr<WebMessagePortChannelImpl> channel);
  61   void Send(IPC::Message* message);
  62   void PostMessage(const base::string16& message,
  63                    blink::WebMessagePortChannelArray* channels);
  64
  65   // IPC::Listener implementation.
  66   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
  67
  68   void OnMessage(const base::string16& message,
  69                  const std::vector<int>& sent_message_port_ids,
  70                  const std::vector<int>& new_routing_ids);
  71   void OnMessagesQueued();
  72
  73   struct Message {
  74     Message();
  75     ~Message();
  76
  77     base::string16 message;
  78     std::vector<WebMessagePortChannelImpl*> ports;
  79   };
  80
  81   typedef std::queue<Message> MessageQueue;
  82   MessageQueue message_queue_;
  83
  84   blink::WebMessagePortChannelClient* client_;
  85   base::Lock lock_;  // Locks access to above.
  86
  87   int route_id_;  // The routing id for this object.
  88   int message_port_id_;  // A globally unique identifier for this message port.
  89   scoped_refptr<base::MessageLoopProxy> child_thread_loop_;
  90
  91   DISALLOW_COPY_AND_ASSIGN(WebMessagePortChannelImpl);
  92 };
  93
  94 }  // namespace content
  95
  96 #endif  // CONTENT_CHILD_WEBMESSAGEPORTCHANNEL_IMPL_H_