Bug 1093025: Move |UnixSocketConnector| to separate file, r=kyle

|UnixSocketConnector| will be shared by |UnixSocketConsumer| and the upcoming listen and stream sockets.
2014-12-02 15:00:36 -08:00
parent 01513d1fce
commit c3e44e64d3
4 changed files with 110 additions and 81 deletions
--- a/ipc/unixsocket/UnixSocketConnector.h
+++ b/ipc/unixsocket/UnixSocketConnector.h
@@ -0,0 +1,85 @@
+/* -*- Mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 40 -*- */
+/* vim: set ts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef mozilla_ipc_unixsocketconnector_h
+#define mozilla_ipc_unixsocketconnector_h
+
+#include "mozilla/ipc/UnixSocketWatcher.h"
+#include "nsString.h"
+
+namespace mozilla {
+namespace ipc {
+
+/**
+ * |UnixSocketConnector| defines the socket creation and connection/listening
+ * functions for |UnixSocketConsumer|, et al. Due to the fact that socket setup
+ * can vary between protocols (unix sockets, tcp sockets, bluetooth sockets, etc),
+ * this allows the user to create whatever connection mechanism they need while
+ * still depending on libevent for non-blocking communication handling.
+ */
+class UnixSocketConnector
+{
+public:
+  virtual ~UnixSocketConnector();
+
+  /**
+   * Establishs a file descriptor for a socket.
+   *
+   * @return File descriptor for socket
+   */
+  virtual int Create() = 0;
+
+  /**
+   * Since most socket specifics are related to address formation into a
+   * sockaddr struct, this function is defined by subclasses and fills in the
+   * structure as needed for whatever connection it is trying to build
+   *
+   * @param aIsServer True is we are acting as a server socket
+   * @param aAddrSize Size of the struct
+   * @param aAddr Struct to fill
+   * @param aAddress If aIsServer is false, Address to connect to. nullptr otherwise.
+   *
+   * @return True if address is filled correctly, false otherwise
+   */
+  virtual bool CreateAddr(bool aIsServer,
+                          socklen_t& aAddrSize,
+                          sockaddr_any& aAddr,
+                          const char* aAddress) = 0;
+
+  /**
+   * Does any socket type specific setup that may be needed, only for socket
+   * created by ConnectSocket()
+   *
+   * @param aFd File descriptor for opened socket
+   *
+   * @return true is successful, false otherwise
+   */
+  virtual bool SetUp(int aFd) = 0;
+
+  /**
+   * Perform socket setup for socket created by ListenSocket(), after listen().
+   *
+   * @param aFd File descriptor for opened socket
+   *
+   * @return true is successful, false otherwise
+   */
+  virtual bool SetUpListenSocket(int aFd) = 0;
+
+  /**
+   * Get address of socket we're currently connected to. Return null string if
+   * not connected.
+   *
+   * @param aAddr Address struct
+   * @param aAddrStr String to store address to
+   */
+  virtual void GetSocketAddr(const sockaddr_any& aAddr,
+                             nsAString& aAddrStr) = 0;
+};
+
+}
+}
+
+#endif