Detailed Description

A TCP socket that can be wait for client connections to enter.

Unless otherwise noticed, operations are blocking.

Definition at line 26 of file CServerTCPSocket.h.

#include <mrpt/comms/CServerTCPSocket.h>

Inheritance diagram for mrpt::comms::CServerTCPSocket:

Public Member Functions
	CServerTCPSocket (unsigned short listenPort, const std::string &IPaddress=std::string("127.0.0.1"), int maxConnectionsWaiting=50, mrpt::utils::VerbosityLevel verbosityLevel=mrpt::utils::LVL_INFO)
	Constructor that creates the socket, performs binding, and start listening mode. More...

virtual	~CServerTCPSocket ()
	Dtor. More...

bool	isListening ()
	Returns true if the socket was successfully open and it's bound to the desired port. More...

std::unique_ptr< CClientTCPSocket >	accept (int timeout_ms=-1)
	Waits for an incoming connection (indefinitely, or with a given timeout) The returned object represents the new connection, and MUST BE deleted by the user when no longer needed. More...

Private Member Functions
std::string	getLastErrorStr ()
	Returns a description of the last Sockets error. More...

void	setupSocket (unsigned short listenPort, const std::string &IPaddress, int maxConnectionsWaiting)
	Common code called from the platform-dependant constructor. More...

Private Attributes
int	m_serverSock
	The handle for the listening server TCP socket. More...

Constructor & Destructor Documentation

◆ CServerTCPSocket()

mrpt::comms::CServerTCPSocket::CServerTCPSocket	(	unsigned short	listenPort,
		const std::string &	IPaddress = `std::string("127.0.0.1")`,
		int	maxConnectionsWaiting = `50`,
		mrpt::utils::VerbosityLevel	verbosityLevel = `mrpt::utils::LVL_INFO`
	)

Constructor that creates the socket, performs binding, and start listening mode.

Parameters

listenPort	The port to bound to.
IPaddress	The interface to bound the socket to. By default is 127.0.0.1 for localhost, for all network interfaces use 0.0.0.0.
maxConnectionsWaiting	Maximum number of incoming connections waiting for "accept" before new ones are rejected. You can check if the socket has been created OK with "isListening".

See also: isListening

Exceptions

std::exception If there is any error creating the socket, with a textual description of the error.

◆ ~CServerTCPSocket()

virtual mrpt::comms::CServerTCPSocket::~CServerTCPSocket ( )

virtual

Dtor.

Member Function Documentation

◆ accept()

std::unique_ptr< CClientTCPSocket > CServerTCPSocket::accept ( int timeout_ms = -1 )

Waits for an incoming connection (indefinitely, or with a given timeout) The returned object represents the new connection, and MUST BE deleted by the user when no longer needed.

Parameters

timeout_ms The timeout for the waiting, in milliseconds. Set this to "-1" to disable timeout (i.e. timeout=infinite)