Abstract base class for all point-to-point network connections. More...

#include <NetworkConnections.h>

Inheritance diagram for cmlabs::NetworkConnection:

Collaboration diagram for cmlabs::NetworkConnection:

Public Member Functions
	NetworkConnection ()
	~NetworkConnection ()
virtual bool	disconnect (uint16 error=0)
	Close the connection and release the socket.
virtual bool	reconnect (uint32 timeoutMS)=0
	Re-establish the connection to the previously known remote endpoint.
virtual bool	didConnect (int timeout=0)
	Check/complete an in-progress (delayed) connect on the existing socket.
virtual bool	didConnect (SOCKET s, int timeout)
	Variant of didConnect() testing an explicit socket handle.
virtual bool	isConnected (int timeout=0)
	Test whether the connection is currently alive.
virtual bool	isRemote ()
virtual uint64	getRemoteAddress ()
bool	setConnectTimeout (uint32 timeoutMS)
	Set the timeout used by subsequent connect()/reconnect() attempts.
virtual bool	send (const char *data, uint32 size, uint64 receiver=0)=0
	Send raw bytes on the connection.
virtual bool	receive (char *data, uint32 size, uint32 timeout, bool peek=false)
	Receive exactly `size` bytes into `data`, waiting up to `timeout` ms.
virtual bool	receiveAvailable (char *data, uint32 &size, uint32 maxSize, uint32 timeout, bool peek=false)
	Receive whatever bytes are available (up to `maxSize`).
virtual bool	discard (uint32 size)
	Drop `size` bytes from the front of the receive buffer (after a peek).
virtual uint32	clearBuffer ()
	Discard all currently buffered input.
virtual bool	waitForDataToRead (uint32 timeout)
	Block until data is readable (buffered or on the socket).
virtual bool	waitForDataToBeWritten (uint32 timeout)
	Block until the socket is writable.
virtual uint32	getOutputSpeed ()
virtual uint32	getInputSpeed ()
virtual uint8	getConnectionType ()
bool	setGreetingData (const char *data, uint32 size)
	Set greeting bytes sent automatically right after a connection is established (used e.g.
Public Member Functions inherited from cmlabs::Runnable
	Runnable ()
	Initialise flags: not running, allowed to continue.
virtual	~Runnable ()
	Destructor requests a stop (with the default timeout) before destruction proceeds.
virtual bool	stop (uint32 timeout=200)
	Ask the worker loop to finish and wait for it to do so.

Public Attributes
char *	greetingData
	Owned copy of the greeting bytes (NULL if unset).
uint32	greetingSize
	Size of ::greetingData in bytes.

Protected Member Functions
void	disconnectInternal (uint16 error)
virtual int32	readIntoBuffer ()
virtual bool	resizeBuffer (uint32 len)
virtual bool	run ()

Protected Attributes
uint8	type
uint64	remoteAddress
uint64	localAddress
uint64	lastActivity
uint32	threadID
SOCKET	socket
bool	remote
uint32	bufferLen
uint32	bufferContentLen
uint32	bufferContentPos
NetworkDataReceiver *	receiver
utils::Mutex	mutex
utils::Mutex	sendMutex
char *	buffer
uint32	connectTimeoutMS
uint32	inputSpeed
uint32	outputSpeed
uint64	inputBytes
uint64	outputBytes
Protected Attributes inherited from cmlabs::Runnable
uint32	threadID
	ThreadManager slot ID of the worker thread (0 until known).
bool	shouldContinue
	Loop-continuation flag; cleared by stop().
bool	isRunning
	Set by the worker while its loop is active.

Detailed Description

Abstract base class for all point-to-point network connections.

Owns the socket, an elastic receive buffer (starting at INITIALBUFFERSIZE and grown on demand), throughput statistics and the connect-timeout setting. Concrete subclasses (TCPConnection, UDPConnection, SSLConnection) implement send(), reconnect() and the socket-specific read path.

Pull vs push: Data can be consumed in pull mode — the owner calls receive() / receiveAvailable() with a timeout — or in push mode by passing a NetworkDataReceiver to connect(), which starts an internal reader thread.

Thread-safety: The receive buffer is protected by mutex and sends are serialised by sendMutex, so one consumer plus concurrent producers are safe. Blocking calls take millisecond timeouts and never block indefinitely.

Definition at line 522 of file NetworkConnections.h.

Constructor & Destructor Documentation

◆ NetworkConnection()

cmlabs::NetworkConnection::NetworkConnection ( )

Definition at line 306 of file NetworkConnections.cpp.

References buffer, bufferContentLen, bufferContentPos, bufferLen, CHECKNETWORKINIT, connectTimeoutMS, greetingData, greetingSize, INITIALBUFFERSIZE, inputBytes, inputSpeed, INVALID_SOCKET, lastActivity, localAddress, outputBytes, outputSpeed, receiver, remote, remoteAddress, resizeBuffer(), socket, threadID, and type.

Referenced by cmlabs::SSLConnection::SSLConnection(), cmlabs::TCPConnection::TCPConnection(), and cmlabs::UDPConnection::UDPConnection().

◆ ~NetworkConnection()

cmlabs::NetworkConnection::~NetworkConnection ( )

Definition at line 329 of file NetworkConnections.cpp.

References buffer, bufferContentLen, bufferContentPos, bufferLen, disconnect(), greetingData, greetingSize, INVALID_SOCKET, lastActivity, localAddress, receiver, remote, remoteAddress, socket, and threadID.

Member Function Documentation

◆ clearBuffer()

uint32 cmlabs::NetworkConnection::clearBuffer ( )

virtual

Discard all currently buffered input.

Returns: The number of bytes discarded.

Definition at line 689 of file NetworkConnections.cpp.

References bufferContentLen, bufferContentPos, inputBytes, LOG_NETWORK, LogPrint, mutex, and readIntoBuffer().

Referenced by cmlabs::NetworkChannel::sendReceiveTelnetLine().

◆ didConnect() [1/2]

bool cmlabs::NetworkConnection::didConnect ( int timeout = 0 )

virtual

Check/complete an in-progress (delayed) connect on the existing socket.

Parameters

timeout Milliseconds to wait for the connect to complete (0 = poll).

Returns: true once the socket is writable, i.e. connected.

Reimplemented in cmlabs::SSLConnection.

Definition at line 949 of file NetworkConnections.cpp.

References cmlabs::utils::GetLastOSErrorNumber(), INVALID_SOCKET, mutex, and socket.

Referenced by cmlabs::TCPConnection::connect(), and cmlabs::SSLConnection::didConnect().

◆ didConnect() [2/2]

bool cmlabs::NetworkConnection::didConnect	(	SOCKET	s,
		int	timeout )

virtual

Variant of didConnect() testing an explicit socket handle.

Parameters

s	Socket to test.
timeout	Milliseconds to wait.

Returns: true once s is connected.

Definition at line 864 of file NetworkConnections.cpp.

References cmlabs::utils::GetLastOSErrorNumber(), and SOCKET.

◆ discard()

bool cmlabs::NetworkConnection::discard ( uint32 size )

virtual

Drop size bytes from the front of the receive buffer (after a peek).

Parameters

size	Number of bytes to discard.

Returns: true on success.

Definition at line 672 of file NetworkConnections.cpp.

References bufferContentLen, bufferContentPos, inputBytes, mutex, and readIntoBuffer().

Referenced by cmlabs::HTTPProtocol::ReceiveHTTPReply(), cmlabs::HTTPProtocol::ReceiveHTTPRequest(), cmlabs::TelnetProtocol::ReceiveTelnetLine(), and cmlabs::HTTPProtocol::ReceiveWebsocketData().

◆ disconnect()

bool cmlabs::NetworkConnection::disconnect ( uint16 error = 0 )

virtual

Close the connection and release the socket.

Parameters

error Optional NETWORKERROR_* reason forwarded to a data receiver.

Returns: true when disconnected. Safe to call repeatedly.

Reimplemented in cmlabs::SSLConnection.

Definition at line 395 of file NetworkConnections.cpp.

References disconnectInternal(), and mutex.

Referenced by cmlabs::NetworkChannel::HTTPClientRun(), cmlabs::LLMConnection::interactStream(), cmlabs::NetworkChannel::MessageConnectionRun(), cmlabs::TCPConnection::reconnect(), cmlabs::UDPConnection::reconnect(), run(), cmlabs::TCPConnection::send(), cmlabs::UDPConnection::send(), and ~NetworkConnection().

◆ disconnectInternal()

void cmlabs::NetworkConnection::disconnectInternal ( uint16 error )

protected

◆ getConnectionType()

uint8 cmlabs::NetworkConnection::getConnectionType ( )

virtual

Returns: The transport type: TCPCON, UDPCON, SSLCON or AESCON.

Definition at line 1102 of file NetworkConnections.cpp.

References type.

Referenced by cmlabs::NetworkChannel::getConnectionType().

◆ getInputSpeed()

uint32 cmlabs::NetworkConnection::getInputSpeed ( )

virtual

Returns: Recent inbound throughput in bytes/second (moving estimate).

Definition at line 1098 of file NetworkConnections.cpp.

References inputSpeed.

Referenced by cmlabs::NetworkChannel::getInputSpeed().

◆ getOutputSpeed()

uint32 cmlabs::NetworkConnection::getOutputSpeed ( )

virtual

Returns: Recent outbound throughput in bytes/second (moving estimate).

Definition at line 1094 of file NetworkConnections.cpp.

References outputSpeed.

Referenced by cmlabs::NetworkChannel::getOutputSpeed().

◆ getRemoteAddress()

uint64 cmlabs::NetworkConnection::getRemoteAddress ( )

virtual

Returns: The remote endpoint packed as a uint64 (IPv4 address + port), or 0 if unknown.

Definition at line 370 of file NetworkConnections.cpp.

References remoteAddress.

Referenced by cmlabs::NetworkChannel::getRemoteAddress(), cmlabs::NetworkChannel::MessageConnectionRun(), cmlabs::HTTPProtocol::ReceiveHTTPReply(), cmlabs::HTTPProtocol::ReceiveHTTPRequest(), cmlabs::TelnetProtocol::ReceiveTelnetLine(), cmlabs::TelnetProtocol::ReceiveTelnetLine(), and cmlabs::HTTPProtocol::ReceiveWebsocketData().

◆ isConnected()

bool cmlabs::NetworkConnection::isConnected ( int timeout = 0 )

virtual

Test whether the connection is currently alive.

Parameters

timeout Milliseconds to allow for probing the socket (0 = immediate).

Returns: true if connected.

Reimplemented in cmlabs::SSLConnection.

Definition at line 718 of file NetworkConnections.cpp.

References disconnectInternal(), cmlabs::utils::GetLastOSErrorNumber(), INVALID_SOCKET, mutex, cmlabs::utils::SetSocketNonBlockingMode(), socket, SOCKETTRYAGAIN, SOCKETWOULDBLOCK, type, and UDPCON.

Referenced by cmlabs::NetworkChannel::HTTPClientRun(), cmlabs::NetworkChannel::HTTPServerRun(), cmlabs::NetworkChannel::isConnected(), cmlabs::NetworkChannel::MessageConnectionRun(), cmlabs::NetworkTest_TCPClient(), cmlabs::NetworkTest_TCPServer(), and cmlabs::NetworkChannel::TelnetServerRun().

◆ isRemote()

bool cmlabs::NetworkConnection::isRemote ( )

virtual

Returns: true if this connection was accepted from a remote peer (server side), false if it was initiated locally (client side).

Definition at line 374 of file NetworkConnections.cpp.

References remote.

◆ readIntoBuffer()

int32 cmlabs::NetworkConnection::readIntoBuffer ( )

protectedvirtual

Reimplemented in cmlabs::SSLConnection.

Definition at line 442 of file NetworkConnections.cpp.

References buffer, bufferContentLen, bufferContentPos, bufferLen, disconnectInternal(), cmlabs::utils::GetLastOSErrorNumber(), cmlabs::GetTimeAge(), cmlabs::GetTimeNow(), LOG_NETWORK, LogPrint, NETWORKERROR_RECEIVE, resizeBuffer(), socket, SOCKET_ERROR, SOCKETTRYAGAIN, SOCKETWOULDBLOCK, TCPCON, type, UDPCON, and cmlabs::utils::WaitForSocketReadability().

Referenced by clearBuffer(), discard(), receive(), and receiveAvailable().

◆ receive()

bool cmlabs::NetworkConnection::receive	(	char *	data,
		uint32	size,
		uint32	timeout,
		bool	peek = false )

virtual

Receive exactly size bytes into data, waiting up to timeout ms.

Parameters

data	Destination buffer of at least `size` bytes.
size	Exact number of bytes required.
timeout	Maximum wait in milliseconds.
peek	When true the bytes remain in the internal buffer (subsequent reads see them again).

Returns: true if size bytes were delivered before the timeout.

Reimplemented in cmlabs::SSLConnection.

Definition at line 606 of file NetworkConnections.cpp.

References buffer, bufferContentLen, bufferContentPos, cmlabs::GetTimeAge(), cmlabs::GetTimeAgeMS(), cmlabs::GetTimeNow(), inputBytes, inputSpeed, mutex, readIntoBuffer(), socket, and cmlabs::utils::WaitForSocketReadability().

Referenced by cmlabs::NetworkTest_SendReceiveData(), cmlabs::NetworkTest_TCPClient(), cmlabs::NetworkTest_TCPServer(), cmlabs::HTTPProtocol::ReceiveHTTPReply(), cmlabs::HTTPProtocol::ReceiveHTTPRequest(), cmlabs::MessageProtocol::ReceiveMessage(), cmlabs::TelnetProtocol::ReceiveTelnetLine(), cmlabs::HTTPProtocol::ReceiveWebsocketData(), and run().

◆ receiveAvailable()

bool cmlabs::NetworkConnection::receiveAvailable	(	char *	data,
		uint32 &	size,
		uint32	maxSize,
		uint32	timeout,
		bool	peek = false )

virtual

Receive whatever bytes are available (up to maxSize).

Parameters

data	Destination buffer.
size	Out: number of bytes actually delivered.
maxSize	Capacity of `data`.
timeout	Maximum wait in milliseconds for at least one byte.
peek	When true the bytes remain buffered.

Returns: true if any bytes were delivered.

Reimplemented in cmlabs::SSLConnection.

Definition at line 537 of file NetworkConnections.cpp.

References buffer, bufferContentLen, bufferContentPos, bufferLen, disconnectInternal(), cmlabs::GetTimeAgeMS(), cmlabs::GetTimeNow(), INITIALBUFFERSIZE, inputBytes, LOG_NETWORK, LogPrint, mutex, NETWORKERROR_RECEIVE, readIntoBuffer(), resizeBuffer(), socket, and cmlabs::utils::WaitForSocketReadability().

Referenced by cmlabs::NetworkChannel::ConnectionAutodetectRun(), cmlabs::HTTPProtocol::ReceiveHTTPReply(), cmlabs::HTTPProtocol::ReceiveHTTPRequest(), cmlabs::TelnetProtocol::ReceiveTelnetLine(), and cmlabs::HTTPProtocol::ReceiveWebsocketData().

◆ reconnect()

virtual bool cmlabs::NetworkConnection::reconnect ( uint32 timeoutMS )

pure virtual

Re-establish the connection to the previously known remote endpoint.

Parameters

timeoutMS Maximum time to spend connecting, in milliseconds.

Returns: true on success. Pure virtual; UDP treats this as a rebind.

Implemented in cmlabs::SSLConnection, cmlabs::TCPConnection, and cmlabs::UDPConnection.

References SOCKET.

Referenced by cmlabs::NetworkChannel::HTTPClientRun(), and cmlabs::NetworkChannel::MessageConnectionRun().

◆ resizeBuffer()

bool cmlabs::NetworkConnection::resizeBuffer ( uint32 len )

protectedvirtual

Definition at line 402 of file NetworkConnections.cpp.

References buffer, bufferContentLen, bufferContentPos, and bufferLen.

Referenced by NetworkConnection(), readIntoBuffer(), cmlabs::SSLConnection::readIntoBuffer(), cmlabs::SSLConnection::receive(), receiveAvailable(), and cmlabs::SSLConnection::receiveAvailable().

◆ run()

bool cmlabs::NetworkConnection::run ( )

protectedvirtual

Definition at line 1049 of file NetworkConnections.cpp.

References disconnect(), GETIPADDRESSQUAD, GETIPPORT, INITIALBUFFERSIZE, cmlabs::Runnable::isRunning, LOG_NETWORK, LogPrint, NETWORKERROR_MEMORYFULL, receive(), receiver, remoteAddress, and cmlabs::Runnable::shouldContinue.

Referenced by cmlabs::SSLConnection::SSLConnectionRun, cmlabs::TCPConnection::TCPConnectionRun, and cmlabs::UDPConnection::UDPConnectionRun.

◆ send()

virtual bool cmlabs::NetworkConnection::send	(	const char *	data,
		uint32	size,
		uint64	receiver = 0 )

pure virtual

Send raw bytes on the connection.

Parameters

data	Bytes to send (caller retains ownership).
size	Number of bytes to send.
receiver	Destination endpoint (uint64 address+port); used by UDP, ignored by stream transports.

Returns: true if all bytes were written.

Note: Serialised by an internal send mutex; may block until the OS buffer accepts the data or a send timeout occurs.

Implemented in cmlabs::SSLConnection, cmlabs::TCPConnection, and cmlabs::UDPConnection.

References receiver.

Referenced by cmlabs::NetworkChannel::HTTPClientRun(), cmlabs::NetworkChannel::MessageConnectionRun(), cmlabs::NetworkTest_TCPServer(), cmlabs::HTTPProtocol::SendHTTPReply(), cmlabs::HTTPProtocol::SendHTTPRequest(), cmlabs::MessageProtocol::SendMessage(), cmlabs::TelnetProtocol::SendTelnetLine(), and cmlabs::HTTPProtocol::SendWebsocketData().

◆ setConnectTimeout()

bool cmlabs::NetworkConnection::setConnectTimeout ( uint32 timeoutMS )

Set the timeout used by subsequent connect()/reconnect() attempts.

Parameters

timeoutMS Timeout in milliseconds.

Returns: true always.

Definition at line 365 of file NetworkConnections.cpp.

References connectTimeoutMS.

Referenced by cmlabs::NetworkChannel::startConnection().

◆ setGreetingData()

bool cmlabs::NetworkConnection::setGreetingData	(	const char *	data,
		uint32	size )

Set greeting bytes sent automatically right after a connection is established (used e.g.

to identify the peer or select a protocol).

Parameters

data	Greeting bytes (copied).
size	Byte count.

Returns: true on success.

Definition at line 351 of file NetworkConnections.cpp.

References greetingData, and greetingSize.

Referenced by cmlabs::NetworkChannel::addTCPConnection(), and cmlabs::NetworkChannel::addTCPConnection().

◆ waitForDataToBeWritten()

bool cmlabs::NetworkConnection::waitForDataToBeWritten ( uint32 timeout )

virtual

Block until the socket is writable.

Parameters

timeout Maximum wait in milliseconds.

Returns: true if writable before the timeout.

Definition at line 713 of file NetworkConnections.cpp.

References socket, and cmlabs::utils::WaitForSocketWriteability().

◆ waitForDataToRead()

bool cmlabs::NetworkConnection::waitForDataToRead ( uint32 timeout )

virtual

Block until data is readable (buffered or on the socket).

Parameters

timeout Maximum wait in milliseconds.

Returns: true if data is available before the timeout.

Definition at line 705 of file NetworkConnections.cpp.

References bufferContentLen, bufferContentPos, socket, and cmlabs::utils::WaitForSocketReadability().

Referenced by cmlabs::HTTPProtocol::ReceiveHTTPReply(), cmlabs::HTTPProtocol::ReceiveHTTPRequest(), cmlabs::TelnetProtocol::ReceiveTelnetLine(), cmlabs::TelnetProtocol::ReceiveTelnetLine(), and cmlabs::HTTPProtocol::ReceiveWebsocketData().

Member Data Documentation

◆ buffer

char* cmlabs::NetworkConnection::buffer

protected

Definition at line 629 of file NetworkConnections.h.

Referenced by NetworkConnection(), readIntoBuffer(), cmlabs::SSLConnection::readIntoBuffer(), receive(), cmlabs::SSLConnection::receive(), receiveAvailable(), cmlabs::SSLConnection::receiveAvailable(), resizeBuffer(), and ~NetworkConnection().

◆ bufferContentLen

uint32 cmlabs::NetworkConnection::bufferContentLen

protected

Definition at line 624 of file NetworkConnections.h.

Referenced by clearBuffer(), cmlabs::SSLConnection::connect(), cmlabs::SSLConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::TCPConnection::connect(), discard(), NetworkConnection(), readIntoBuffer(), cmlabs::SSLConnection::readIntoBuffer(), receive(), cmlabs::SSLConnection::receive(), receiveAvailable(), cmlabs::SSLConnection::receiveAvailable(), resizeBuffer(), waitForDataToRead(), and ~NetworkConnection().

◆ bufferContentPos

uint32 cmlabs::NetworkConnection::bufferContentPos

protected

Definition at line 625 of file NetworkConnections.h.

Referenced by clearBuffer(), cmlabs::SSLConnection::connect(), cmlabs::SSLConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::TCPConnection::connect(), discard(), NetworkConnection(), readIntoBuffer(), cmlabs::SSLConnection::readIntoBuffer(), receive(), cmlabs::SSLConnection::receive(), receiveAvailable(), cmlabs::SSLConnection::receiveAvailable(), resizeBuffer(), waitForDataToRead(), and ~NetworkConnection().

◆ bufferLen

uint32 cmlabs::NetworkConnection::bufferLen

protected

Definition at line 623 of file NetworkConnections.h.

Referenced by NetworkConnection(), readIntoBuffer(), cmlabs::SSLConnection::readIntoBuffer(), cmlabs::SSLConnection::receive(), receiveAvailable(), cmlabs::SSLConnection::receiveAvailable(), resizeBuffer(), and ~NetworkConnection().

◆ connectTimeoutMS

uint32 cmlabs::NetworkConnection::connectTimeoutMS

protected

Definition at line 630 of file NetworkConnections.h.

Referenced by cmlabs::SSLConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::SSLConnection::delayedConnect(), cmlabs::TCPConnection::delayedConnect(), NetworkConnection(), and setConnectTimeout().

◆ greetingData

char* cmlabs::NetworkConnection::greetingData

Owned copy of the greeting bytes (NULL if unset).

Definition at line 610 of file NetworkConnections.h.

Referenced by cmlabs::NetworkChannel::HTTPClientRun(), cmlabs::NetworkChannel::MessageConnectionRun(), NetworkConnection(), setGreetingData(), and ~NetworkConnection().

◆ greetingSize

uint32 cmlabs::NetworkConnection::greetingSize

Size of ::greetingData in bytes.

Definition at line 611 of file NetworkConnections.h.

Referenced by cmlabs::NetworkChannel::HTTPClientRun(), cmlabs::NetworkChannel::MessageConnectionRun(), NetworkConnection(), setGreetingData(), and ~NetworkConnection().

◆ inputBytes

uint64 cmlabs::NetworkConnection::inputBytes

protected

Definition at line 633 of file NetworkConnections.h.

Referenced by clearBuffer(), discard(), NetworkConnection(), receive(), cmlabs::SSLConnection::receive(), receiveAvailable(), and cmlabs::SSLConnection::receiveAvailable().

◆ inputSpeed

uint32 cmlabs::NetworkConnection::inputSpeed

protected

Definition at line 631 of file NetworkConnections.h.

Referenced by getInputSpeed(), NetworkConnection(), receive(), and cmlabs::SSLConnection::receive().

◆ lastActivity

uint64 cmlabs::NetworkConnection::lastActivity

protected

Definition at line 619 of file NetworkConnections.h.

Referenced by NetworkConnection(), and ~NetworkConnection().

◆ localAddress

uint64 cmlabs::NetworkConnection::localAddress

protected

Definition at line 618 of file NetworkConnections.h.

Referenced by cmlabs::SSLConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::UDPConnection::connect(), cmlabs::UDPConnection::getLocalAddress(), NetworkConnection(), cmlabs::UDPConnection::reconnect(), and ~NetworkConnection().

◆ mutex

utils::Mutex cmlabs::NetworkConnection::mutex

protected

◆ outputBytes

uint64 cmlabs::NetworkConnection::outputBytes

protected

Definition at line 634 of file NetworkConnections.h.

Referenced by NetworkConnection(), cmlabs::SSLConnection::send(), cmlabs::TCPConnection::send(), and cmlabs::UDPConnection::send().

◆ outputSpeed

uint32 cmlabs::NetworkConnection::outputSpeed

protected

Definition at line 632 of file NetworkConnections.h.

Referenced by getOutputSpeed(), NetworkConnection(), cmlabs::SSLConnection::send(), cmlabs::TCPConnection::send(), and cmlabs::UDPConnection::send().

◆ receiver

NetworkDataReceiver* cmlabs::NetworkConnection::receiver

protected

Definition at line 626 of file NetworkConnections.h.

◆ remote

bool cmlabs::NetworkConnection::remote

protected

Definition at line 622 of file NetworkConnections.h.

Referenced by cmlabs::SSLConnection::connect(), cmlabs::SSLConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::SSLConnection::delayedConnect(), cmlabs::TCPConnection::delayedConnect(), isRemote(), NetworkConnection(), and ~NetworkConnection().

◆ remoteAddress

uint64 cmlabs::NetworkConnection::remoteAddress

protected

Definition at line 617 of file NetworkConnections.h.

Referenced by cmlabs::SSLConnection::connect(), cmlabs::SSLConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::SSLConnection::delayedConnect(), cmlabs::TCPConnection::delayedConnect(), getRemoteAddress(), NetworkConnection(), cmlabs::SSLConnection::reconnect(), cmlabs::TCPConnection::reconnect(), run(), and ~NetworkConnection().

◆ sendMutex

utils::Mutex cmlabs::NetworkConnection::sendMutex

protected

Definition at line 628 of file NetworkConnections.h.

Referenced by cmlabs::SSLConnection::send(), cmlabs::TCPConnection::send(), and cmlabs::UDPConnection::send().

◆ socket

SOCKET cmlabs::NetworkConnection::socket

protected

◆ threadID

uint32 cmlabs::NetworkConnection::threadID

protected

Definition at line 620 of file NetworkConnections.h.

Referenced by cmlabs::SSLConnection::connect(), cmlabs::SSLConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::TCPConnection::connect(), cmlabs::UDPConnection::connect(), cmlabs::SSLConnection::delayedConnect(), cmlabs::TCPConnection::delayedConnect(), NetworkConnection(), and ~NetworkConnection().

◆ type

uint8 cmlabs::NetworkConnection::type

protected

Definition at line 616 of file NetworkConnections.h.

Referenced by getConnectionType(), isConnected(), cmlabs::SSLConnection::isConnected(), NetworkConnection(), readIntoBuffer(), cmlabs::SSLConnection::SSLConnection(), cmlabs::TCPConnection::TCPConnection(), and cmlabs::UDPConnection::UDPConnection().

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

/home/ubuntu/c/partner/psyclone2/CMSDK/include/NetworkConnections.h
/home/ubuntu/c/partner/psyclone2/CMSDK/src/NetworkConnections.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NetworkConnection()

◆ ~NetworkConnection()

Member Function Documentation

◆ clearBuffer()

◆ didConnect() [1/2]

◆ didConnect() [2/2]

◆ discard()

◆ disconnect()

◆ disconnectInternal()

◆ getConnectionType()

◆ getInputSpeed()

◆ getOutputSpeed()

◆ getRemoteAddress()

◆ isConnected()

◆ isRemote()

◆ readIntoBuffer()

◆ receive()

◆ receiveAvailable()

◆ reconnect()

◆ resizeBuffer()

◆ run()

◆ send()

◆ setConnectTimeout()

◆ setGreetingData()

◆ waitForDataToBeWritten()

◆ waitForDataToRead()

Member Data Documentation

◆ buffer

◆ bufferContentLen

◆ bufferContentPos

◆ bufferLen

◆ connectTimeoutMS

◆ greetingData

◆ greetingSize

◆ inputBytes

◆ inputSpeed

◆ lastActivity

◆ localAddress

◆ mutex

◆ outputBytes

◆ outputSpeed

◆ receiver

◆ remote

◆ remoteAddress

◆ sendMutex

◆ socket

◆ threadID

◆ type