Handles the internal socket instance, interacting with the asynchronous io_service calls. More...

#include <StreamSocket.h>

Inheritance diagram for Eris::StreamSocket:

Collaboration diagram for Eris::StreamSocket:

Classes
struct	Callbacks
	Methods that are used as callbacks. More...

Public Types
enum	Status { INVALID_STATUS = 0 , CONNECTING , CONNECTING_TIMEOUT , CONNECTING_FAILED , NEGOTIATE , NEGOTIATE_TIMEOUT , NEGOTIATE_FAILED , CONNECTED , CONNECTION_FAILED , DISCONNECTED , DISCONNECTING }

Public Member Functions
	StreamSocket (boost::asio::io_service &io_service, const std::string &client_name, Atlas::Bridge &bridge, Callbacks callbacks)

void	detach ()
	Detaches the callbacks. More...

Atlas::Codec &	getCodec ()
	Gets the codec object. More...

Atlas::Objects::ObjectsEncoder &	getEncoder ()
	Gets the encoder object. More...

virtual void	write ()=0
	Send any unsent data. More...

Protected Types
enum	{ read_buffer_size = 2048 }

Protected Member Functions
virtual void	do_read ()=0

virtual void	negotiate_read ()=0

void	startNegotiation ()

Atlas::Negotiate::State	negotiate ()

Protected Attributes
boost::asio::io_service &	m_io_service

Atlas::Bridge &	_bridge

Callbacks	_callbacks

std::unique_ptr< boost::asio::streambuf >	mWriteBuffer

std::unique_ptr< boost::asio::streambuf >	mSendBuffer

boost::asio::streambuf	mReadBuffer

std::istream	mInStream

std::ostream	mOutStream

bool	mShouldSend

bool	mIsSending

std::unique_ptr< Atlas::Net::StreamConnect >	_sc
	negotiation object (nullptr after connection!) More...

boost::asio::steady_timer	_negotiateTimer

boost::asio::steady_timer	_connectTimer

std::unique_ptr< Atlas::Codec >	m_codec

std::unique_ptr< Atlas::Objects::ObjectsEncoder >	m_encoder

bool	m_is_connected

Detailed Description

Handles the internal socket instance, interacting with the asynchronous io_service calls.

Since this will be used to make asynchronous calls it must be wrapped in a shared_ptr. When the owner instance is destroyed it must call "detach" to make sure the connection is severed.

Definition at line 54 of file StreamSocket.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Definition at line 121 of file StreamSocket.h.

◆ Status

enum Eris::StreamSocket::Status

Enumerator
INVALID_STATUS	indicates an illegal state
CONNECTING	stream / socket connection in progress
CONNECTING_TIMEOUT	timeout when trying to establish a connection
CONNECTING_FAILED	failure when trying to establish a connection
NEGOTIATE	Atlas negotiation in progress.
NEGOTIATE_TIMEOUT	timeout when negotiating
NEGOTIATE_FAILED	failure when negotiating
CONNECTED	connection fully established
CONNECTION_FAILED	connection failed
DISCONNECTED	finished disconnection
DISCONNECTING	clean disconnection in progress

Definition at line 58 of file StreamSocket.h.

Constructor & Destructor Documentation

◆ StreamSocket()

Eris::StreamSocket::StreamSocket	(	boost::asio::io_service &	io_service,
		const std::string &	client_name,
		Atlas::Bridge &	bridge,
		Callbacks	callbacks
	)

Definition at line 36 of file StreamSocket.cpp.

Member Function Documentation

◆ detach()

void Eris::StreamSocket::detach ( )

Detaches the callbacks.

Call this when the owner instance is destroyed, or you otherwise don't want any callbacks.

Definition at line 58 of file StreamSocket.cpp.

◆ getCodec()

Atlas::Codec & Eris::StreamSocket::getCodec ( )

Gets the codec object.

Note: Only call this after the socket has successfully negotiated.

Returns

Definition at line 123 of file StreamSocket.cpp.

◆ getEncoder()

Atlas::Objects::ObjectsEncoder & Eris::StreamSocket::getEncoder ( )

Gets the encoder object.

Note: Only call this after the socket has successfully negotiated.

Returns

Definition at line 128 of file StreamSocket.cpp.

◆ negotiate()

Atlas::Negotiate::State Eris::StreamSocket::negotiate ( )

protected

Definition at line 86 of file StreamSocket.cpp.

◆ startNegotiation()

void Eris::StreamSocket::startNegotiation ( )

protected

Definition at line 62 of file StreamSocket.cpp.

◆ write()

virtual void Eris::StreamSocket::write ( )

pure virtual

Send any unsent data.

Implemented in Eris::AsioStreamSocket< ProtocolT >.

Member Data Documentation

◆ _bridge

Atlas::Bridge& Eris::StreamSocket::_bridge

protected

Definition at line 126 of file StreamSocket.h.

◆ _callbacks

Callbacks Eris::StreamSocket::_callbacks

protected

Definition at line 127 of file StreamSocket.h.

◆ _connectTimer

boost::asio::steady_timer Eris::StreamSocket::_connectTimer

protected

Definition at line 168 of file StreamSocket.h.

◆ _negotiateTimer

boost::asio::steady_timer Eris::StreamSocket::_negotiateTimer

protected

Definition at line 167 of file StreamSocket.h.

◆ _sc

std::unique_ptr<Atlas::Net::StreamConnect> Eris::StreamSocket::_sc

protected

negotiation object (nullptr after connection!)

Definition at line 166 of file StreamSocket.h.

◆ m_codec

std::unique_ptr<Atlas::Codec> Eris::StreamSocket::m_codec

protected

Definition at line 169 of file StreamSocket.h.

◆ m_encoder

std::unique_ptr<Atlas::Objects::ObjectsEncoder> Eris::StreamSocket::m_encoder

protected

Definition at line 170 of file StreamSocket.h.

◆ m_io_service

boost::asio::io_service& Eris::StreamSocket::m_io_service

protected

Definition at line 125 of file StreamSocket.h.

◆ m_is_connected

bool Eris::StreamSocket::m_is_connected

protected

Definition at line 171 of file StreamSocket.h.

◆ mInStream

std::istream Eris::StreamSocket::mInStream

protected

Stream for data being received.

Definition at line 149 of file StreamSocket.h.

◆ mIsSending

bool Eris::StreamSocket::mIsSending

protected

True if we're currently sending through an async_write (and thus shouldn't touch mSendBuffer).

Definition at line 164 of file StreamSocket.h.

◆ mOutStream

std::ostream Eris::StreamSocket::mOutStream

protected

Stream for data being sent out.

Definition at line 154 of file StreamSocket.h.

◆ mReadBuffer

boost::asio::streambuf Eris::StreamSocket::mReadBuffer

protected

Buffer for data being read from the socket.

Definition at line 144 of file StreamSocket.h.

◆ mSendBuffer

std::unique_ptr<boost::asio::streambuf> Eris::StreamSocket::mSendBuffer

protected

Buffer of data which is being sent. This should not be touched until the async_write call completes.

Definition at line 139 of file StreamSocket.h.

◆ mShouldSend

bool Eris::StreamSocket::mShouldSend

protected

True if we should send again as soon as an ongoing async_write operation completes.

Definition at line 159 of file StreamSocket.h.

◆ mWriteBuffer

std::unique_ptr<boost::asio::streambuf> Eris::StreamSocket::mWriteBuffer

protected

Buffer used to write data to be sent. Swapped with mSendBuffer once data is being sent.

Definition at line 133 of file StreamSocket.h.

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ Status

Constructor & Destructor Documentation

◆ StreamSocket()

Member Function Documentation

◆ detach()

◆ getCodec()

◆ getEncoder()

◆ negotiate()

◆ startNegotiation()

◆ write()

Member Data Documentation

◆ _bridge

◆ _callbacks

◆ _connectTimer

◆ _negotiateTimer

◆ _sc

◆ m_codec

◆ m_encoder

◆ m_io_service

◆ m_is_connected

◆ mInStream

◆ mIsSending

◆ mOutStream

◆ mReadBuffer

◆ mSendBuffer

◆ mShouldSend

◆ mWriteBuffer