#include <Socket.h>

Inheritance diagram for Trinity::Net::Socket< Stream >:

Classes
struct	Endpoint

Public Member Functions
template<typename... Args>
	Socket (IoContextTcpSocket &&socket, Args &&... args)

template<typename... Args>
	Socket (Asio::IoContext &context, Args &&... args)

	Socket (Socket const &other)=delete

	Socket (Socket &&other)=delete

Socket &	operator= (Socket const &other)=delete

Socket &	operator= (Socket &&other)=delete

virtual	~Socket ()

virtual void	Start ()

template<BOOST_ASIO_COMPLETION_TOKEN_FOR(void(boost::system::error_code, boost::asio::ip::tcp::endpoint)) Callback>
decltype(auto)	Connect (boost::asio::ip::tcp::endpoint const &endpoint, Callback &&callback)

template<BOOST_ASIO_COMPLETION_TOKEN_FOR(void(boost::system::error_code, boost::asio::ip::tcp::endpoint)) Callback>
decltype(auto)	Connect (std::vector< boost::asio::ip::tcp::endpoint > const &endpoints, Callback &&callback)

virtual bool	Update ()

boost::asio::ip::address const &	GetRemoteIpAddress () const

uint16	GetRemotePort () const

void	SetRemoteEndpoint (boost::asio::ip::tcp::endpoint const &endpoint)

template<invocable_r< SocketReadCallbackResult > Callback>
void	AsyncRead (Callback &&callback)

void	QueuePacket (MessageBuffer &&buffer)

bool	IsOpen () const

void	CloseSocket ()

void	DelayedCloseSocket ()
	Marks the socket for closing after write buffer becomes empty.

MessageBuffer &	GetReadBuffer ()

Stream &	underlying_stream ()

Protected Member Functions
virtual void	OnClose ()

virtual SocketReadCallbackResult	ReadHandler ()

bool	AsyncProcessQueue ()

void	SetNoDelay (bool enable)

Private Member Functions
bool	ReadHandlerInternal (boost::system::error_code const &error, size_t transferredBytes)

void	QueuedBufferWriteDone ()

void	WriteHandlerWrapper (boost::system::error_code const &)

bool	HandleQueue ()

Private Attributes
Stream	_socket

struct Trinity::Net::Socket::Endpoint	_remoteEndpoint

MessageBuffer	_readBuffer = MessageBuffer(0x1000)

std::queue< MessageBuffer >	_writeQueue

std::atomic< uint8 >	_openState

bool	_isWritingAsync = false

Static Private Attributes
static constexpr uint8	OpenState_Open = 0x0

static constexpr uint8	OpenState_Closing = 0x1
	Transition to Closed state after sending all queued data.

static constexpr uint8	OpenState_Closed = 0x2

Detailed Description

template<class Stream = IoContextTcpSocket>
class Trinity::Net::Socket< Stream >

Base async socket implementation

Template Parameters

Stream stream type used for operations on socket Stream must implement the following methods:

executor_type get_executor();

bool is_open() const;

void close(boost::system::error_code& error);

void shutdown(boost::asio::socket_base::shutdown_type what, boost::system::error_code& shutdownError);

template<typename ConnectHandlerType> void async_connect(boost::asio::ip::tcp::endpoint const& endpoint, ConnectHandlerType&& handler);

template<typename MutableBufferSequence, typename ReadHandlerType> void async_read_some(MutableBufferSequence const& buffers, ReadHandlerType&& handler);

template<typename ConstBufferSequence, typename WriteHandlerType> void async_write_some(ConstBufferSequence const& buffers, WriteHandlerType&& handler);

template<typename ConstBufferSequence> std::size_t write_some(ConstBufferSequence const& buffers, boost::system::error_code& error);

template<typename WaitHandlerType> void async_wait(boost::asio::socket_base::wait_type type, WaitHandlerType&& handler);

template<typename SettableSocketOption> void set_option(SettableSocketOption const& option, boost::system::error_code& error);

tcp::socket::endpoint_type remote_endpoint() const;

Definition at line 126 of file Socket.h.

Constructor & Destructor Documentation

◆ Socket() [1/4]

template<class Stream = IoContextTcpSocket>

template<typename... Args>

Trinity::Net::Socket< Stream >::Socket	(	IoContextTcpSocket< Stream > &&	socket,
		Args &&...	args
	)

inlineexplicit

Definition at line 130 of file Socket.h.

◆ Socket() [2/4]

template<class Stream = IoContextTcpSocket>

template<typename... Args>

Trinity::Net::Socket< Stream >::Socket	(	Asio::IoContext &	context,
		Args &&...	args
	)

inlineexplicit

Definition at line 136 of file Socket.h.

◆ Socket() [3/4]

template<class Stream = IoContextTcpSocket>

Trinity::Net::Socket< Stream >::Socket ( Socket< Stream > const & other )

delete

◆ Socket() [4/4]

template<class Stream = IoContextTcpSocket>

Trinity::Net::Socket< Stream >::Socket ( Socket< Stream > && other )

delete

◆ ~Socket()

template<class Stream = IoContextTcpSocket>

virtual Trinity::Net::Socket< Stream >::~Socket ( )

inlinevirtual

Reimplemented in Trinity::Net::Http::Socket.

Definition at line 146 of file Socket.h.

References Trinity::Net::Socket< Stream >::_openState, Trinity::Net::Socket< Stream >::_socket, and Trinity::Net::Socket< Stream >::OpenState_Closed.

Member Function Documentation

◆ AsyncProcessQueue()

template<class Stream = IoContextTcpSocket>

bool Trinity::Net::Socket< Stream >::AsyncProcessQueue ( )

inlineprotected

Definition at line 265 of file Socket.h.

References Trinity::Net::Socket< Stream >::_isWritingAsync, Trinity::Net::Socket< Stream >::_socket, Trinity::Net::Socket< Stream >::_writeQueue, MessageBuffer::GetActiveSize(), and MessageBuffer::GetReadPointer().

Referenced by Trinity::Net::Socket< Stream >::HandleQueue(), and Trinity::Net::Socket< Stream >::QueuePacket().

◆ AsyncRead()

template<class Stream = IoContextTcpSocket>

template<invocable_r< SocketReadCallbackResult > Callback>

void Trinity::Net::Socket< Stream >::AsyncRead ( Callback && callback )

inline

Definition at line 203 of file Socket.h.

References Trinity::Net::Socket< Stream >::_readBuffer, Trinity::Net::Socket< Stream >::_socket, Trinity::Net::Socket< Stream >::IsOpen(), Trinity::Net::KeepReading, and Trinity::Net::PrepareReadBuffer().

Referenced by WorldSocketProtocolInitializer::AsyncRead(), WorldSocket::HandleAuthContinuedSessionCallback(), WorldSocket::HandleAuthSessionCallback(), and Trinity::Net::ReadConnectionInitializer< AsyncReadObjectType, ReadHandlerObjectType >::Start().

◆ CloseSocket()

template<class Stream = IoContextTcpSocket>

void Trinity::Net::Socket< Stream >::CloseSocket ( )

inline

Definition at line 228 of file Socket.h.

References Trinity::Net::Socket< Stream >::_openState, Trinity::Net::Socket< Stream >::_socket, Trinity::Net::Socket< Stream >::GetRemoteIpAddress(), Trinity::Net::Socket< Stream >::OnClose(), Trinity::Net::Socket< Stream >::OpenState_Closed, and TC_LOG_DEBUG.

Referenced by Trinity::Net::Socket< Stream >::DelayedCloseSocket(), WorldSocketProtocolInitializer::HandleDataReady(), Trinity::Net::Impl::Operations::Connect< Socket >::HandleError(), WorldSocket::InitializeCompression(), Trinity::Net::Socket< Stream >::QueuedBufferWriteDone(), WorldSocket::ReadHandler(), and Trinity::Net::Socket< Stream >::ReadHandlerInternal().

◆ Connect() [1/2]

template<class Stream = IoContextTcpSocket>

template<BOOST_ASIO_COMPLETION_TOKEN_FOR(void(boost::system::error_code, boost::asio::ip::tcp::endpoint)) Callback>

decltype(auto) Trinity::Net::Socket< Stream >::Connect	(	boost::asio::ip::tcp::endpoint const &	endpoint,
		Callback &&	callback
	)

inline

Definition at line 156 of file Socket.h.

References Trinity::Net::Socket< Stream >::_openState, Trinity::Net::Socket< Stream >::OpenState_Open, and Trinity::Net::Socket< Stream >::underlying_stream().

◆ Connect() [2/2]

template<class Stream = IoContextTcpSocket>

template<BOOST_ASIO_COMPLETION_TOKEN_FOR(void(boost::system::error_code, boost::asio::ip::tcp::endpoint)) Callback>

decltype(auto) Trinity::Net::Socket< Stream >::Connect	(	std::vector< boost::asio::ip::tcp::endpoint > const &	endpoints,
		Callback &&	callback
	)

inline

Definition at line 164 of file Socket.h.

References Trinity::Net::Socket< Stream >::_openState, Trinity::Net::Socket< Stream >::OpenState_Open, and Trinity::Net::Socket< Stream >::underlying_stream().

◆ DelayedCloseSocket()

template<class Stream = IoContextTcpSocket>

void Trinity::Net::Socket< Stream >::DelayedCloseSocket ( )

inline

Marks the socket for closing after write buffer becomes empty.

Definition at line 243 of file Socket.h.

References Trinity::Net::Socket< Stream >::_openState, Trinity::Net::Socket< Stream >::_writeQueue, Trinity::Net::Socket< Stream >::CloseSocket(), Trinity::Net::Socket< Stream >::OpenState_Closing, and Trinity::Net::Socket< Stream >::OpenState_Open.

Referenced by WorldSocket::HandleAuthContinuedSession(), WorldSocket::HandleAuthContinuedSessionCallback(), WorldSocket::HandleAuthSession(), and WorldSocket::HandleAuthSessionCallback().

◆ GetReadBuffer()

template<class Stream = IoContextTcpSocket>

MessageBuffer & Trinity::Net::Socket< Stream >::GetReadBuffer ( )

inline

Definition at line 253 of file Socket.h.

References Trinity::Net::Socket< Stream >::_readBuffer.

Referenced by WorldSocketProtocolInitializer::ReadHandler(), and WorldSocket::ReadHandler().

◆ GetRemoteIpAddress()

template<class Stream = IoContextTcpSocket>

boost::asio::ip::address const & Trinity::Net::Socket< Stream >::GetRemoteIpAddress ( ) const

inline

◆ GetRemotePort()

template<class Stream = IoContextTcpSocket>

uint16 Trinity::Net::Socket< Stream >::GetRemotePort ( ) const

inline

Definition at line 192 of file Socket.h.

References Trinity::Net::Socket< Stream >::_remoteEndpoint, and Trinity::Net::Socket< Stream >::Endpoint::Port.

Referenced by WorldSocket::ReadDataHandler(), and WorldSocket::SendPacket().

◆ HandleQueue()

template<class Stream = IoContextTcpSocket>

bool Trinity::Net::Socket< Stream >::HandleQueue ( )

inlineprivate

Definition at line 345 of file Socket.h.

References Trinity::Net::Socket< Stream >::_socket, Trinity::Net::Socket< Stream >::_writeQueue, Trinity::Net::Socket< Stream >::AsyncProcessQueue(), MessageBuffer::GetActiveSize(), MessageBuffer::GetReadPointer(), Trinity::Net::Socket< Stream >::QueuedBufferWriteDone(), and MessageBuffer::ReadCompleted().

Referenced by Trinity::Net::Socket< Stream >::Update(), and Trinity::Net::Socket< Stream >::WriteHandlerWrapper().

◆ IsOpen()

template<class Stream = IoContextTcpSocket>

bool Trinity::Net::Socket< Stream >::IsOpen ( ) const

inline

Definition at line 226 of file Socket.h.

References Trinity::Net::Socket< Stream >::_openState, and Trinity::Net::Socket< Stream >::OpenState_Open.

Referenced by Trinity::Net::Socket< Stream >::AsyncRead(), Trinity::Net::Socket< Stream >::ReadHandlerInternal(), and WorldSocket::SendPacket().

◆ OnClose()

template<class Stream = IoContextTcpSocket>

virtual void Trinity::Net::Socket< Stream >::OnClose ( )

inlineprotectedvirtual

Reimplemented in WorldSocket.

Definition at line 261 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::CloseSocket().

◆ operator=() [1/2]

template<class Stream = IoContextTcpSocket>

Socket & Trinity::Net::Socket< Stream >::operator= ( Socket< Stream > && other )

delete

◆ operator=() [2/2]

template<class Stream = IoContextTcpSocket>

Socket & Trinity::Net::Socket< Stream >::operator= ( Socket< Stream > const & other )

delete

◆ QueuedBufferWriteDone()

template<class Stream = IoContextTcpSocket>

void Trinity::Net::Socket< Stream >::QueuedBufferWriteDone ( )

inlineprivate

Definition at line 312 of file Socket.h.

References Trinity::Net::Socket< Stream >::_openState, Trinity::Net::Socket< Stream >::_writeQueue, Trinity::Net::Socket< Stream >::CloseSocket(), and Trinity::Net::Socket< Stream >::OpenState_Closing.

Referenced by Trinity::Net::Socket< Stream >::HandleQueue().

◆ QueuePacket()

template<class Stream = IoContextTcpSocket>

void Trinity::Net::Socket< Stream >::QueuePacket ( MessageBuffer && buffer )

inline

Definition at line 217 of file Socket.h.

References Trinity::Net::Socket< Stream >::_writeQueue, and Trinity::Net::Socket< Stream >::AsyncProcessQueue().

Referenced by WorldSocketProtocolInitializer::Start(), and WorldSocket::Update().

◆ ReadHandler()

template<class Stream = IoContextTcpSocket>

virtual SocketReadCallbackResult Trinity::Net::Socket< Stream >::ReadHandler ( )

inlineprotectedvirtual

Reimplemented in Trinity::Net::Http::BaseSocket< Stream >, Trinity::Net::Http::BaseSocket< Impl::BoostBeastSocketWrapper >, Trinity::Net::Http::BaseSocket< SslStream< Impl::BoostBeastSocketWrapper > >, and WorldSocket.

Definition at line 263 of file Socket.h.

References Trinity::Net::KeepReading.

Referenced by Trinity::Net::InvokeReadHandlerCallback< SocketType >::operator()().

◆ ReadHandlerInternal()

template<class Stream = IoContextTcpSocket>

bool Trinity::Net::Socket< Stream >::ReadHandlerInternal	(	boost::system::error_code const &	error,
		size_t	transferredBytes
	)

inlineprivate

Definition at line 300 of file Socket.h.

References Trinity::Net::Socket< Stream >::_readBuffer, Trinity::Net::Socket< Stream >::CloseSocket(), Trinity::Net::Socket< Stream >::IsOpen(), and MessageBuffer::WriteCompleted().

◆ SetNoDelay()

template<class Stream = IoContextTcpSocket>

void Trinity::Net::Socket< Stream >::SetNoDelay ( bool enable )

inlineprotected

Definition at line 290 of file Socket.h.

References Trinity::Net::Socket< Stream >::_socket, Trinity::Net::Socket< Stream >::GetRemoteIpAddress(), and TC_LOG_DEBUG.

Referenced by WorldSocket::ReadDataHandler().

◆ SetRemoteEndpoint()

template<class Stream = IoContextTcpSocket>

void Trinity::Net::Socket< Stream >::SetRemoteEndpoint ( boost::asio::ip::tcp::endpoint const & endpoint )

inline

Definition at line 197 of file Socket.h.

References Trinity::Net::Socket< Stream >::_remoteEndpoint.

◆ Start()

template<class Stream = IoContextTcpSocket>

virtual void Trinity::Net::Socket< Stream >::Start ( )

inlinevirtual

Reimplemented in Trinity::Net::Http::BaseSocket< Stream >, Trinity::Net::Http::BaseSocket< Impl::BoostBeastSocketWrapper >, Trinity::Net::Http::BaseSocket< SslStream< Impl::BoostBeastSocketWrapper > >, Trinity::Net::Http::Socket, Trinity::Net::Http::SslSocket, and WorldSocket.

Definition at line 153 of file Socket.h.

◆ underlying_stream()

template<class Stream = IoContextTcpSocket>

Stream & Trinity::Net::Socket< Stream >::underlying_stream ( )

inline

Definition at line 255 of file Socket.h.

References Trinity::Net::Socket< Stream >::_socket.

Referenced by Trinity::Net::Socket< Stream >::Connect(), and Trinity::Net::Socket< Stream >::Connect().

◆ Update()

template<class Stream = IoContextTcpSocket>

virtual bool Trinity::Net::Socket< Stream >::Update ( )

inlinevirtual

Reimplemented in Trinity::Net::Http::BaseSocket< Stream >, Trinity::Net::Http::BaseSocket< Impl::BoostBeastSocketWrapper >, Trinity::Net::Http::BaseSocket< SslStream< Impl::BoostBeastSocketWrapper > >, and WorldSocket.

Definition at line 171 of file Socket.h.

References Trinity::Net::Socket< Stream >::_isWritingAsync, Trinity::Net::Socket< Stream >::_openState, Trinity::Net::Socket< Stream >::_writeQueue, Trinity::Net::Socket< Stream >::HandleQueue(), Trinity::Net::Socket< Stream >::OpenState_Closed, and Trinity::Net::Socket< Stream >::OpenState_Open.

◆ WriteHandlerWrapper()

template<class Stream = IoContextTcpSocket>

void Trinity::Net::Socket< Stream >::WriteHandlerWrapper ( boost::system::error_code const & )

inlineprivate

Definition at line 339 of file Socket.h.

References Trinity::Net::Socket< Stream >::_isWritingAsync, and Trinity::Net::Socket< Stream >::HandleQueue().

Member Data Documentation

◆ _isWritingAsync

template<class Stream = IoContextTcpSocket>

bool Trinity::Net::Socket< Stream >::_isWritingAsync = false

private

Definition at line 403 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::AsyncProcessQueue(), Trinity::Net::Socket< Stream >::Update(), and Trinity::Net::Socket< Stream >::WriteHandlerWrapper().

◆ _openState

template<class Stream = IoContextTcpSocket>

std::atomic<uint8> Trinity::Net::Socket< Stream >::_openState

private

Definition at line 401 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::CloseSocket(), Trinity::Net::Socket< Stream >::Connect(), Trinity::Net::Socket< Stream >::Connect(), Trinity::Net::Socket< Stream >::DelayedCloseSocket(), Trinity::Net::Socket< Stream >::IsOpen(), Trinity::Net::Socket< Stream >::QueuedBufferWriteDone(), Trinity::Net::Socket< Stream >::Update(), and Trinity::Net::Socket< Stream >::~Socket().

◆ _readBuffer

template<class Stream = IoContextTcpSocket>

MessageBuffer Trinity::Net::Socket< Stream >::_readBuffer = MessageBuffer(0x1000)

private

Definition at line 393 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::AsyncRead(), Trinity::Net::Socket< Stream >::GetReadBuffer(), and Trinity::Net::Socket< Stream >::ReadHandlerInternal().

◆ _remoteEndpoint

template<class Stream = IoContextTcpSocket>

struct Trinity::Net::Socket::Endpoint Trinity::Net::Socket< Stream >::_remoteEndpoint

private

Referenced by Trinity::Net::Socket< Stream >::GetRemoteIpAddress(), Trinity::Net::Socket< Stream >::GetRemotePort(), and Trinity::Net::Socket< Stream >::SetRemoteEndpoint().

◆ _socket

template<class Stream = IoContextTcpSocket>

Stream Trinity::Net::Socket< Stream >::_socket

private

Definition at line 382 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::AsyncProcessQueue(), Trinity::Net::Socket< Stream >::AsyncRead(), Trinity::Net::Socket< Stream >::CloseSocket(), Trinity::Net::Socket< Stream >::HandleQueue(), Trinity::Net::Socket< Stream >::SetNoDelay(), Trinity::Net::Socket< Stream >::underlying_stream(), and Trinity::Net::Socket< Stream >::~Socket().

◆ _writeQueue

template<class Stream = IoContextTcpSocket>

std::queue<MessageBuffer> Trinity::Net::Socket< Stream >::_writeQueue

private

Definition at line 394 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::AsyncProcessQueue(), Trinity::Net::Socket< Stream >::DelayedCloseSocket(), Trinity::Net::Socket< Stream >::HandleQueue(), Trinity::Net::Socket< Stream >::QueuedBufferWriteDone(), Trinity::Net::Socket< Stream >::QueuePacket(), and Trinity::Net::Socket< Stream >::Update().

◆ OpenState_Closed

template<class Stream = IoContextTcpSocket>

constexpr uint8 Trinity::Net::Socket< Stream >::OpenState_Closed = 0x2

staticconstexprprivate

Definition at line 399 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::CloseSocket(), Trinity::Net::Socket< Stream >::Update(), and Trinity::Net::Socket< Stream >::~Socket().

◆ OpenState_Closing

template<class Stream = IoContextTcpSocket>

constexpr uint8 Trinity::Net::Socket< Stream >::OpenState_Closing = 0x1

staticconstexprprivate

Transition to Closed state after sending all queued data.

Definition at line 398 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::DelayedCloseSocket(), and Trinity::Net::Socket< Stream >::QueuedBufferWriteDone().

◆ OpenState_Open

template<class Stream = IoContextTcpSocket>

constexpr uint8 Trinity::Net::Socket< Stream >::OpenState_Open = 0x0

staticconstexprprivate

Definition at line 397 of file Socket.h.

Referenced by Trinity::Net::Socket< Stream >::Connect(), Trinity::Net::Socket< Stream >::Connect(), Trinity::Net::Socket< Stream >::DelayedCloseSocket(), Trinity::Net::Socket< Stream >::IsOpen(), and Trinity::Net::Socket< Stream >::Update().

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

common/network/Socket.h

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Socket() [1/4]

◆ Socket() [2/4]

◆ Socket() [3/4]

◆ Socket() [4/4]

◆ ~Socket()

Member Function Documentation

◆ AsyncProcessQueue()

◆ AsyncRead()

◆ CloseSocket()

◆ Connect() [1/2]

◆ Connect() [2/2]

◆ DelayedCloseSocket()

◆ GetReadBuffer()

◆ GetRemoteIpAddress()

◆ GetRemotePort()

◆ HandleQueue()

◆ IsOpen()

◆ OnClose()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ QueuedBufferWriteDone()

◆ QueuePacket()

◆ ReadHandler()

◆ ReadHandlerInternal()

◆ SetNoDelay()

◆ SetRemoteEndpoint()

◆ Start()

◆ underlying_stream()

◆ Update()

◆ WriteHandlerWrapper()

Member Data Documentation

◆ _isWritingAsync

◆ _openState

◆ _readBuffer

◆ _remoteEndpoint

◆ _socket

◆ _writeQueue

◆ OpenState_Closed

◆ OpenState_Closing

◆ OpenState_Open