ipc/unixsocket/StreamSocketConsumer.h
author Thomas Zimmermann <tdz@users.sourceforge.net>
Tue, 26 May 2015 13:24:19 +0200
changeset 245587 516d575cfeea5104ef6a2bafa7d3f349ae92a5b9
child 246784 fd7c97d41cf392d9e8229e0031c5742d8d586f2b
permissions -rw-r--r--
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.

/* -*- 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