tools/android/forwarder2/daemon.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 TOOLS_ANDROID_FORWARDER2_DAEMON_H_
   6 #define TOOLS_ANDROID_FORWARDER2_DAEMON_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/memory/scoped_ptr.h"
  12
  13 namespace forwarder2 {
  14
  15 class Socket;
  16
  17 // Provides a way to spawn a daemon and communicate with it.
  18 class Daemon {
  19  public:
  20   // Callback used by the daemon to shutdown properly. See pipe_notifier.h for
  21   // more details.
  22   typedef int (*GetExitNotifierFDCallback)();
  23
  24   class ClientDelegate {
  25    public:
  26     virtual ~ClientDelegate() {}
  27
  28     // Called after the daemon is ready to receive commands.
  29     virtual void OnDaemonReady(Socket* daemon_socket) = 0;
  30   };
  31
  32   class ServerDelegate {
  33    public:
  34     virtual ~ServerDelegate() {}
  35
  36     // Called after the daemon bound its Unix Domain Socket. This can be used to
  37     // setup signal handlers or perform global initialization.
  38     virtual void Init() = 0;
  39
  40     virtual void OnClientConnected(scoped_ptr<Socket> client_socket) = 0;
  41   };
  42
  43   // |identifier| should be a unique string identifier. It is used to
  44   // bind/connect the underlying Unix Domain Socket.
  45   // Note that this class does not take ownership of |client_delegate| and
  46   // |server_delegate|.
  47   Daemon(const std::string& log_file_path,
  48          const std::string& identifier,
  49          ClientDelegate* client_delegate,
  50          ServerDelegate* server_delegate,
  51          GetExitNotifierFDCallback get_exit_fd_callback);
  52
  53   ~Daemon();
  54
  55   // Returns whether the daemon was successfully spawned. Note that this does
  56   // not necessarily mean that the current process was forked in case the daemon
  57   // is already running.
  58   bool SpawnIfNeeded();
  59
  60   // Kills the daemon and blocks until it exited. Returns whether it succeeded.
  61   bool Kill();
  62
  63  private:
  64   const std::string log_file_path_;
  65   const std::string identifier_;
  66   ClientDelegate* const client_delegate_;
  67   ServerDelegate* const server_delegate_;
  68   const GetExitNotifierFDCallback get_exit_fd_callback_;
  69
  70   DISALLOW_COPY_AND_ASSIGN(Daemon);
  71 };
  72
  73 }  // namespace forwarder2
  74
  75 #endif  // TOOLS_ANDROID_FORWARDER2_DAEMON_H_