gecko-dev/ipc/unixsocket/StreamSocket.h
Thomas Zimmermann 8cd71c82de Bug 1093025: Add |StreamSocket|, r=kyle
|StreamSocket| implements a |ConnectionOrientedSocket| for stream
sockets. It utilizes |ListenSocket| to wait for incoming connection
requests.
2014-12-02 15:00:36 -08:00

94 lines
2.5 KiB
C++

/* -*- 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_streamsocket_h
#define mozilla_ipc_streamsocket_h
#include "mozilla/ipc/SocketBase.h"
#include "ConnectionOrientedSocket.h"
namespace mozilla {
namespace ipc {
class StreamSocketIO;
class UnixSocketConnector;
class StreamSocket : public SocketConsumerBase
, public ConnectionOrientedSocket
{
public:
StreamSocket();
/**
* Queue data to be sent to the socket on the IO thread. Can only be called on
* originating thread.
*
* @param aMessage Data to be sent to socket
*
* @return true if data is queued, false otherwise (i.e. not connected)
*/
bool SendSocketData(UnixSocketRawData* aMessage);
/**
* Convenience function for sending strings to the socket (common in bluetooth
* profile usage). Converts to a UnixSocketRawData struct. Can only be called
* on originating thread.
*
* @param aMessage String to be sent to socket
*
* @return true if data is queued, false otherwise (i.e. not connected)
*/
bool SendSocketData(const nsACString& aMessage);
/**
* Starts a task on the socket that will try to connect to a socket in a
* non-blocking manner.
*
* @param aConnector Connector object for socket type specific functions
* @param aAddress Address to connect to.
* @param aDelayMs Time delay in milli-seconds.
*
* @return true on connect task started, false otherwise.
*/
bool Connect(UnixSocketConnector* aConnector,
const char* aAddress,
int aDelayMs = 0);
/**
* Queues the internal representation of socket for deletion. Can be called
* from main thread.
*/
void Close();
/**
* Get the current sockaddr for the socket
*/
void GetSocketAddr(nsAString& aAddrStr);
protected:
virtual ~StreamSocket();
// Prepares an instance of |StreamSocket| in DISCONNECTED state
// for accepting a connection. Subclasses implementing |GetIO|
// need to call this method.
ConnectionOrientedSocketIO* PrepareAccept(UnixSocketConnector* aConnector);
private:
// Legacy interface from |SocketBase|; should be replaced by |Close|.
void CloseSocket() MOZ_OVERRIDE
{
Close();
}
StreamSocketIO* mIO;
};
} // namespace ipc
} // namepsace mozilla
#endif // mozilla_ipc_streamsocket_h