content/browser/message_port_service.h

   1 // Copyright 2013 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_BROWSER_MESSAGE_PORT_SERVICE_H_
   6 #define CONTENT_BROWSER_MESSAGE_PORT_SERVICE_H_
   7
   8 #include <map>
   9 #include <utility>
  10 #include <vector>
  11
  12 #include "base/basictypes.h"
  13 #include "base/memory/singleton.h"
  14 #include "base/strings/string16.h"
  15 #include "content/common/content_export.h"
  16 #include "content/public/common/message_port_types.h"
  17 #include "ipc/ipc_message.h"
  18
  19 namespace content {
  20 class MessagePortDelegate;
  21
  22 class CONTENT_EXPORT MessagePortService {
  23  public:
  24   typedef std::vector<std::pair<content::MessagePortMessage,
  25                                 std::vector<TransferredMessagePort>>>
  26       QueuedMessages;
  27
  28   // Returns the MessagePortService singleton.
  29   static MessagePortService* GetInstance();
  30
  31   // These methods correspond to the message port related IPCs.
  32   void Create(int route_id,
  33               MessagePortDelegate* delegate,
  34               int* message_port_id);
  35   void Destroy(int message_port_id);
  36   void Entangle(int local_message_port_id, int remote_message_port_id);
  37   void PostMessage(
  38       int sender_message_port_id,
  39       const MessagePortMessage& message,
  40       const std::vector<TransferredMessagePort>& sent_message_ports);
  41   void QueueMessages(int message_port_id);
  42   void SendQueuedMessages(int message_port_id,
  43                           const QueuedMessages& queued_messages);
  44   void ReleaseMessages(int message_port_id);
  45
  46   // Updates the information needed to reach a message port when it's sent to a
  47   // (possibly different) process.
  48   void UpdateMessagePort(int message_port_id,
  49                          MessagePortDelegate* delegate,
  50                          int routing_id);
  51
  52   // Returns the current information by which a message port can be reached.
  53   // Either |delegate| or |routing_id| can be null, in which case that bit of
  54   // information is not returned.
  55   void GetMessagePortInfo(int message_port_id,
  56                           MessagePortDelegate** delegate,
  57                           int* routing_id);
  58
  59   // The message port is being transferred to a new renderer process, but the
  60   // code doing that isn't able to immediately update the message port with a
  61   // new filter and routing_id. This queues up all messages sent to this port
  62   // until later ReleaseMessages is called for this port (this will happen
  63   // automatically as soon as a WebMessagePortChannelImpl instance is created
  64   // for this port in the renderer. The browser side code is still responsible
  65   // for updating the port with a new filter before that happens. If ultimately
  66   // transfering the port to a new process fails, ClosePort should be called to
  67   // clean up the port.
  68   void HoldMessages(int message_port_id);
  69
  70   // Closes and cleans up the message port.
  71   void ClosePort(int message_port_id);
  72
  73   void OnMessagePortDelegateClosing(MessagePortDelegate* filter);
  74
  75   // Attempts to send the queued messages for a message port.
  76   void SendQueuedMessagesIfPossible(int message_port_id);
  77
  78  private:
  79   friend struct DefaultSingletonTraits<MessagePortService>;
  80
  81   MessagePortService();
  82   ~MessagePortService();
  83
  84   void PostMessageTo(
  85       int message_port_id,
  86       const MessagePortMessage& message,
  87       const std::vector<TransferredMessagePort>& sent_message_ports);
  88
  89   // Handles the details of removing a message port id. Before calling this,
  90   // verify that the message port id exists.
  91   void Erase(int message_port_id);
  92
  93   struct MessagePort;
  94   typedef std::map<int, MessagePort> MessagePorts;
  95   MessagePorts message_ports_;
  96
  97   // We need globally unique identifiers for each message port.
  98   int next_message_port_id_;
  99
 100   DISALLOW_COPY_AND_ASSIGN(MessagePortService);
 101 };
 102
 103 }  // namespace content
 104
 105 #endif  // CONTENT_BROWSER_MESSAGE_PORT_SERVICE_H_