Main MRPT website > C++ reference for MRPT 1.5.6
List of all members | Public Member Functions | Private Member Functions | Private Attributes
mrpt::utils::CServerTCPSocket Class Reference

Detailed Description

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

Unless otherwise noticed, operations are blocking.

Definition at line 27 of file CServerTCPSocket.h.

#include <mrpt/utils/CServerTCPSocket.h>

Inheritance diagram for mrpt::utils::CServerTCPSocket:
Inheritance graph

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...
 
CClientTCPSocketaccept (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

mrpt::utils::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
listenPortThe port to bound to.
IPaddressThe interface to bound the socket to. By default is 127.0.0.1 for localhost, for all network interfaces use 0.0.0.0.
maxConnectionsWaitingMaximum 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::exceptionIf there is any error creating the socket, with a textual description of the error.
virtual mrpt::utils::CServerTCPSocket::~CServerTCPSocket ( )
virtual

Dtor.

Member Function Documentation

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_msThe timeout for the waiting, in milliseconds. Set this to "-1" to disable timeout (i.e. timeout=infinite)
Returns
The incoming connection, or NULL on timeout or error.

Definition at line 89 of file CServerTCPSocket_common.cpp.

References mrpt::format(), mrpt::system::os::fprintf(), getLastErrorStr(), INVALID_SOCKET, mrpt::utils::CClientTCPSocket::m_hSock, mrpt::utils::CClientTCPSocket::m_remotePartIP, mrpt::utils::CClientTCPSocket::m_remotePartPort, m_serverSock, MRPT_END, MRPT_LOG_DEBUG, MRPT_LOG_WARN, and MRPT_START.

std::string mrpt::utils::CServerTCPSocket::getLastErrorStr ( )
inlineprivate

Returns a description of the last Sockets error.

Definition at line 65 of file CServerTCPSocket.h.

References mrpt::utils::net::getLastSocketErrorStr().

Referenced by accept(), and setupSocket().

bool CServerTCPSocket::isListening ( )

Returns true if the socket was successfully open and it's bound to the desired port.

Definition at line 81 of file CServerTCPSocket_common.cpp.

References INVALID_SOCKET, and m_serverSock.

void CServerTCPSocket::setupSocket ( unsigned short  listenPort,
const std::string IPaddress,
int  maxConnectionsWaiting 
)
private

Common code called from the platform-dependant constructor.

Definition at line 42 of file CServerTCPSocket_common.cpp.

References mrpt::format(), getLastErrorStr(), INVALID_SOCKET, m_serverSock, MRPT_END, MRPT_LOG_DEBUG, MRPT_START, and THROW_EXCEPTION.

Member Data Documentation

int mrpt::utils::CServerTCPSocket::m_serverSock
private

The handle for the listening server TCP socket.

Definition at line 62 of file CServerTCPSocket.h.

Referenced by accept(), isListening(), and setupSocket().




Page generated by Doxygen 1.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018