From 6dc6f61bb67f852eda1210cc748ec0cada57fa9b Mon Sep 17 00:00:00 2001
From: Thomas Zimmermann <tdz@users.sourceforge.net>
Date: Tue, 26 May 2015 13:24:19 +0200
Subject: [PATCH] Bug 1166638: Add |StreamSocketConsumer|, r=kmachulis

|StreamSocketConsumer| receives events and data from a stream
socket. It unifies all existing consumer and listener classes
of the socket I/O users.
---
 ipc/unixsocket/StreamSocketConsumer.cpp | 20 +++++++++
 ipc/unixsocket/StreamSocketConsumer.h   | 60 +++++++++++++++++++++++++
 ipc/unixsocket/moz.build                |  2 +
 3 files changed, 82 insertions(+)
 create mode 100644 ipc/unixsocket/StreamSocketConsumer.cpp
 create mode 100644 ipc/unixsocket/StreamSocketConsumer.h

diff --git a/ipc/unixsocket/StreamSocketConsumer.cpp b/ipc/unixsocket/StreamSocketConsumer.cpp
new file mode 100644
index 00000000000..bac9c1fe70b
--- /dev/null
+++ b/ipc/unixsocket/StreamSocketConsumer.cpp
@@ -0,0 +1,20 @@
+/* -*- 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/. */
+
+#include "StreamSocketConsumer.h"
+
+namespace mozilla {
+namespace ipc {
+
+//
+// StreamSocketConsumer
+//
+
+StreamSocketConsumer::~StreamSocketConsumer()
+{ }
+
+}
+}
diff --git a/ipc/unixsocket/StreamSocketConsumer.h b/ipc/unixsocket/StreamSocketConsumer.h
new file mode 100644
index 00000000000..a283e714e1c
--- /dev/null
+++ b/ipc/unixsocket/StreamSocketConsumer.h
@@ -0,0 +1,60 @@
+/* -*- 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_streamsocketconsumer_h
+#define mozilla_ipc_streamsocketconsumer_h
+
+#include "nsAutoPtr.h"
+
+namespace mozilla {
+namespace ipc {
+
+class UnixSocketBuffer;
+
+/**
+ * |StreamSocketConsumer| handles socket events and received data.
+ */
+class StreamSocketConsumer
+{
+public:
+  /**
+   * Method to be called whenever data is received. Main-thread only.
+   *
+   * @param aIndex The index that has been given to the stream socket.
+   * @param aBuffer Data received from the socket.
+   */
+  virtual void ReceiveSocketData(int aIndex,
+                                 nsAutoPtr<UnixSocketBuffer>& aBuffer) = 0;
+
+  /**
+   * Callback for socket success. Main-thread only.
+   *
+   * @param aIndex The index that has been given to the stream socket.
+   */
+  virtual void OnConnectSuccess(int aIndex) = 0;
+
+  /**
+   * Callback for socket errors. Main-thread only.
+   *
+   * @param aIndex The index that has been given to the stream socket.
+   */
+  virtual void OnConnectError(int aIndex) = 0;
+
+  /**
+   * Callback for socket disconnect. Main-thread only.
+   *
+   * @param aIndex The index that has been given to the stream socket.
+   */
+  virtual void OnDisconnect(int aIndex) = 0;
+
+protected:
+  virtual ~StreamSocketConsumer();
+};
+
+}
+}
+
+#endif
diff --git a/ipc/unixsocket/moz.build b/ipc/unixsocket/moz.build
index faa88d17f60..1bf4a6f9bfb 100644
--- a/ipc/unixsocket/moz.build
+++ b/ipc/unixsocket/moz.build
@@ -10,6 +10,7 @@ EXPORTS.mozilla.ipc += [
     'ListenSocket.h',
     'SocketBase.h',
     'StreamSocket.h',
+    'StreamSocketConsumer.h',
     'UnixSocketConnector.h'
 ]
 
@@ -19,6 +20,7 @@ SOURCES += [
     'ListenSocket.cpp',
     'SocketBase.cpp',
     'StreamSocket.cpp',
+    'StreamSocketConsumer.cpp',
     'UnixSocketConnector.cpp'
 ]