chrome/service/service_ipc_server.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 CHROME_SERVICE_SERVICE_IPC_SERVER_H_
   6 #define CHROME_SERVICE_SERVICE_IPC_SERVER_H_
   7
   8 #include <vector>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/memory/scoped_vector.h"
  12 #include "ipc/ipc_channel_handle.h"
  13 #include "ipc/ipc_listener.h"
  14 #include "ipc/ipc_sync_channel.h"
  15 #include "ipc/ipc_sender.h"
  16
  17 namespace base {
  18
  19 class HistogramDeltaSerialization;
  20 class WaitableEvent;
  21
  22 }  // namespace base
  23
  24 // This class handles IPC commands for the service process.
  25 class ServiceIPCServer : public IPC::Listener, public IPC::Sender {
  26  public:
  27   class MessageHandler {
  28    public:
  29     virtual ~MessageHandler() {}
  30     // Must return true if the message is handled.
  31     virtual bool HandleMessage(const IPC::Message& message) = 0;
  32   };
  33
  34   class Client {
  35    public:
  36     virtual ~Client() {}
  37
  38     // Called when the service process must shut down.
  39     virtual void OnShutdown() = 0;
  40
  41     // Called when a product update is available.
  42     virtual void OnUpdateAvailable() = 0;
  43
  44     // Called when the IPC channel is closed. A return value of true indicates
  45     // that the IPC server should continue listening for new connections.
  46     virtual bool OnIPCClientDisconnect() = 0;
  47   };
  48
  49   ServiceIPCServer(
  50       Client* client,
  51       const scoped_refptr<base::SingleThreadTaskRunner>& io_task_runner,
  52       const IPC::ChannelHandle& handle,
  53       base::WaitableEvent* shutdown_event);
  54   ~ServiceIPCServer() override;
  55
  56   bool Init();
  57
  58   // IPC::Sender implementation.
  59   bool Send(IPC::Message* msg) override;
  60
  61   // Registers a MessageHandler with the ServiceIPCServer. When an IPC message
  62   // is received that is not handled by the ServiceIPCServer itself, the
  63   // handlers will be called to handle the message in first-add first-call order
  64   // until it is handled or there are no more handlers.
  65   void AddMessageHandler(scoped_ptr<MessageHandler> handler);
  66
  67   bool is_ipc_client_connected() const { return ipc_client_connected_; }
  68
  69  private:
  70   friend class ServiceIPCServerTest;
  71   friend class MockServiceIPCServer;
  72
  73   // IPC::Listener implementation.
  74   bool OnMessageReceived(const IPC::Message& msg) override;
  75   void OnChannelConnected(int32 peer_pid) override;
  76   void OnChannelError() override;
  77
  78   // IPC message handlers.
  79   void OnGetHistograms();
  80   void OnShutdown();
  81   void OnUpdateAvailable();
  82
  83   // Helper method to create the sync channel.
  84   void CreateChannel();
  85
  86   Client* client_;
  87   scoped_refptr<base::SingleThreadTaskRunner> io_task_runner_;
  88   IPC::ChannelHandle channel_handle_;
  89   scoped_ptr<IPC::SyncChannel> channel_;
  90   base::WaitableEvent* shutdown_event_;
  91   ScopedVector<MessageHandler> message_handlers_;
  92
  93   // Indicates whether an IPC client is currently connected to the channel.
  94   bool ipc_client_connected_;
  95
  96   // Calculates histograms deltas.
  97   scoped_ptr<base::HistogramDeltaSerialization> histogram_delta_serializer_;
  98
  99   DISALLOW_COPY_AND_ASSIGN(ServiceIPCServer);
 100 };
 101
 102 #endif  // CHROME_SERVICE_SERVICE_IPC_SERVER_H_