A server (listening) socket for StreamSocket (TCP) connections. More...

#include <ServerSocket.h++>

Inheritance diagram for ServerSocket:

Collaboration diagram for ServerSocket:

Public Member Functions
	ServerSocket (uint16_t port, uint_t backlog=3)
	Construct a new ServerSocket that will listen on the given port. More...

	ServerSocket (uint16_t port, const NetworkInterface &ixface, uint_t backlog=3)
	Construct a new ServerSocket that will listen on the given port and network interface. More...

	~ServerSocket ()
	Destructor. More...

void	init ()
	Initialize the socket. More...

void	shutdown ()
	Shut down the socket. More...

void	listen ()
	Begin listening for connections on the socket. More...

bool	isListening () const
	Determine if the socket is in a listening state. More...

void	accept (StreamSocket &socket)
	Accept a connection on the socket. More...

virtual void	connect (const String &addr, uint16_t port)
	Connect the socket to a remote endpoint. More...

virtual void	connect (const SocketAddress &addr)
	Connect the socket to a remote endpoint. More...

void	setTimeout (timespan_ms_t timeout)
	Set the timeout for the socket. More...

void	setReceiveBufSize (size_t size)
	Set the size of the socket's internal receive buffer. More...

size_t	getReceiveBufSize () const
	Get the size of the socket's internal receive buffer. More...

void	setSendBufSize (size_t size)
	Set the size of the socket's internal send buffer. More...

size_t	getSendBufSize () const
	Get the size of the socket's internal send buffer. More...

void	setLingerTime (timespan_s_t timeout)
	Set the linger time for the socket. More...

timespan_s_t	getLingerTime () const
	Get the linger time for the socket. More...

void	setReuseAddress (bool enable)
	Enable or disable the SO_REUSEADDR option on the socket. More...

bool	getReuseAddress () const
	Determine if the SO_REUSEADDR option is enabled or disabled. More...

void	setKeepAlive (bool enable)
	Enable or disable the SO_KEEPALIVE option on the socket. More...

bool	getKeepAlive ()
	Determine if the SO_KEEPALIVE option is enabled or disabled. More...

void	setTCPDelay (bool enable)
	Enable or disable the Nagle algorithm for send coalescing. More...

bool	getTCPDelay ()
	Determine if the Nagle algorithm is enabled or disabled. More...

bool	isInitialized () const
	Determine if the socket has been initialized. More...

bool	isConnected () const
	Determine if the socket is connected. More...

NetProtocol	getType () const
	Get the socket type. More...

const SocketAddress &	getLocalAddress () const
	Get the address of the local end of the socket. More...

const SocketAddress &	getRemoteAddress () const
	Get the address of the remote (peer) end of the socket. More...

Protected Types
enum	IOWaitMode { WaitWrite, WaitRead }

Protected Member Functions
SocketHandle	getSocketHandle () const
	Get the underlying socket handle for this socket. More...

void	waitForIO (IOWaitMode mode)
	Wait for the socket to become ready for reading or writing. More...

Protected Attributes
NetProtocol	_type
	The socket type. More...

SocketHandle	_socket
	A handle to the socket itself. More...

SocketAddress	_raddr
	The remote address. More...

SocketAddress	_laddr
	The local address. More...

int	_sotimeout
	The timeout value. More...

Detailed Description

A server (listening) socket for StreamSocket (TCP) connections.

Author: Mark Lindner

Member Enumeration Documentation

◆ IOWaitMode

enum IOWaitMode

protectedinherited

Enumerator
WaitWrite
WaitRead

Constructor & Destructor Documentation

◆ ServerSocket() [1/2]

ServerSocket	(	uint16_t	port,
		uint_t	backlog = `3`
	)

Construct a new ServerSocket that will listen on the given port.

Parameters

port	The port number to listen on.
backlog	The size of the connection backlog.

◆ ServerSocket() [2/2]

ServerSocket	(	uint16_t	port,
		const NetworkInterface &	ixface,
		uint_t	backlog = `3`
	)

Construct a new ServerSocket that will listen on the given port and network interface.

Parameters

port	The port number to listen on.
ixface	The network interface to listen on.
backlog	The size of the connection backlog.

◆ ~ServerSocket()

~ServerSocket ( )

Destructor.

Shuts down the socket.

Member Function Documentation

◆ accept()

void accept ( StreamSocket & socket )

Accept a connection on the socket.

This method blocks until a new connection is pending, unless a timeout has been set on the socket, in which case a TimeoutException is thrown if no connection is pending by the time the timeout expires.

Parameters

socket A socket object which will be initialized to represent the newly-established connection.

Exceptions

TimeoutException	If the operation times out.
SocketException	If a socket error occurs.

◆ connect() [1/2]

void connect	(	const String &	addr,
		uint16_t	port
	)

virtualinherited

Connect the socket to a remote endpoint.

Note that if this call fails, the socket will revert to an uninitialized state; call init() again to reuse the socket.

Parameters

addr	The address, which may either be a dot-separated IP address or a DNS name.
port	The port number.

Exceptions

IOException If an error occurs.

Reimplemented in DatagramSocket, and StreamSocket.

◆ connect() [2/2]

void connect ( const SocketAddress & addr )

virtualinherited

Connect the socket to a remote endpoint.

Note that if this call fails, the socket will revert to an uninitialized state; call init() again to reuse the socket.

Parameters

addr	The address.

Exceptions

IOException If an error occurs.

Reimplemented in DatagramSocket, and StreamSocket.

◆ getKeepAlive()

bool getKeepAlive ( )

inherited

Determine if the SO_KEEPALIVE option is enabled or disabled.

Returns: true if the option is enabled, false otherwise.

Exceptions

SocketException If a socket error occurs.

◆ getLingerTime()

timespan_s_t getLingerTime ( ) const

inherited

Get the linger time for the socket.

Returns: The linger time, in seconds, or -1 if the feature is disabled.

Exceptions

SocketException If the linger time could not be retrieved.

◆ getLocalAddress()

const SocketAddress& getLocalAddress ( ) const

inlineinherited

Get the address of the local end of the socket.

◆ getReceiveBufSize()

size_t getReceiveBufSize ( ) const

inherited

Get the size of the socket's internal receive buffer.

Returns: The size, in bytes.

Exceptions

SocketException If the size could not be changed.

◆ getRemoteAddress()

const SocketAddress& getRemoteAddress ( ) const

inlineinherited

Get the address of the remote (peer) end of the socket.

◆ getReuseAddress()

bool getReuseAddress ( ) const

inherited

Determine if the SO_REUSEADDR option is enabled or disabled.

Returns: true if the option is enabled, false otherwise.

Exceptions

SocketException If a socket error occurs.

◆ getSendBufSize()

size_t getSendBufSize ( ) const

inherited

Get the size of the socket's internal send buffer.

Returns: The size, in bytes.

Exceptions

SocketException If the size could not be changed.

◆ getSocketHandle()

SocketHandle getSocketHandle ( ) const

inlineprotectedinherited

Get the underlying socket handle for this socket.

◆ getTCPDelay()

bool getTCPDelay ( )

inherited

Determine if the Nagle algorithm is enabled or disabled.

Returns: true if the Nagle algorithm is enabled (TCP_NODELAY off), false otherwise.

Exceptions

SocketException If a socket error occurs.

◆ getType()

NetProtocol getType ( ) const

inlineinherited

Get the socket type.

◆ init()

void init ( )

virtual

Initialize the socket.

This method creates the underlying socket object.

Exceptions

SocketException If the socket could not be created.

Reimplemented from Socket.

◆ isConnected()

bool isConnected ( ) const

inlineinherited

Determine if the socket is connected.

◆ isInitialized()

bool isInitialized ( ) const

inlineinherited

Determine if the socket has been initialized.

◆ isListening()

bool isListening ( ) const

inline

Determine if the socket is in a listening state.

◆ listen()

void listen ( )

Begin listening for connections on the socket.

Exceptions

SocketException If a socket error occurs.

◆ setKeepAlive()

void setKeepAlive ( bool enable )

inherited

Enable or disable the SO_KEEPALIVE option on the socket.

Parameters

enable true to enable the option false to disable it.

Exceptions

SocketException If a socket error occurs.

◆ setLingerTime()

void setLingerTime ( timespan_s_t timeout )

inherited

Set the linger time for the socket.

Parameters

timeout The new linger time, in seconds; a negative value disables the linger feature.

Exceptions

SocketException If the linger time could not be changed.

◆ setReceiveBufSize()

void setReceiveBufSize ( size_t size )

inherited

Set the size of the socket's internal receive buffer.

Parameters

size	The new size, in bytes.

Exceptions

SocketException If the size could not be changed.

◆ setReuseAddress()

void setReuseAddress ( bool enable )

inherited

Enable or disable the SO_REUSEADDR option on the socket.

This method may only be called before the socket has been initialized. This option is off by default in newly created sockets.

Parameters

enable true to enable the option false to disable it.

Exceptions

SocketException If a socket error occurs, or if the call was made after the socket was initialized.

◆ setSendBufSize()

void setSendBufSize ( size_t size )

inherited

Set the size of the socket's internal send buffer.

Parameters

size	The new size, in bytes.

Exceptions

SocketException If the size could not be changed.

◆ setTCPDelay()

void setTCPDelay ( bool enable )

inherited

Enable or disable the Nagle algorithm for send coalescing.

Parameters

enable true to enable the Nagle algorithm (TCP_NODELAY off), false to disable it (TCP_NODELAY on).

Exceptions

SocketException If a socket error occurs.

◆ setTimeout()

void setTimeout ( timespan_ms_t timeout )

inherited

Set the timeout for the socket.

The timeout affects both I/O and connections.

Parameters

timeout The timeout, in milliseconds.

Exceptions

SocketException If an error occurs.

◆ shutdown()

void shutdown ( )

virtual

Shut down the socket.

Closes the connection and destroys the underlying socket object.

Reimplemented from Socket.

◆ waitForIO()

void waitForIO ( IOWaitMode mode )

protectedinherited

Wait for the socket to become ready for reading or writing.

Parameters

mode	The wait mode; one of WaitWrite or WaitRead.

Exceptions

IOException On timeout or other error.

Member Data Documentation

◆ _laddr

SocketAddress _laddr

protectedinherited

The local address.

◆ _raddr

SocketAddress _raddr

protectedinherited

The remote address.

◆ _socket

SocketHandle _socket

protectedinherited

A handle to the socket itself.

◆ _sotimeout

int _sotimeout

protectedinherited

The timeout value.

◆ _type

NetProtocol _type

protectedinherited

The socket type.

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ IOWaitMode

Constructor & Destructor Documentation

◆ ServerSocket() [1/2]

◆ ServerSocket() [2/2]

◆ ~ServerSocket()

Member Function Documentation

◆ accept()

◆ connect() [1/2]

◆ connect() [2/2]

◆ getKeepAlive()

◆ getLingerTime()

◆ getLocalAddress()

◆ getReceiveBufSize()

◆ getRemoteAddress()

◆ getReuseAddress()

◆ getSendBufSize()

◆ getSocketHandle()

◆ getTCPDelay()

◆ getType()

◆ init()

◆ isConnected()

◆ isInitialized()

◆ isListening()

◆ listen()

◆ setKeepAlive()

◆ setLingerTime()

◆ setReceiveBufSize()

◆ setReuseAddress()

◆ setSendBufSize()

◆ setTCPDelay()

◆ setTimeout()

◆ shutdown()

◆ waitForIO()

Member Data Documentation

◆ _laddr

◆ _raddr

◆ _socket

◆ _sotimeout

◆ _type