TCP socket server. More...

#include <TCPServer.h>

Public Member Functions
	MBED_DEPRECATED_SINCE ("mbed-os-5.10","TCPServer is deprecated, use TCPSocket") TCPServer()
	Create an uninitialized socket.
template<typename S >
	MBED_DEPRECATED_SINCE ("mbed-os-5.10","TCPServer is deprecated, use TCPSocket") TCPServer(S *stack)
	Create a socket on a network interface.
virtual	~TCPServer ()
	Destroy a socket.
	MBED_DEPRECATED_SINCE ("mbed-os-5.10","TCPServer::accept() is deprecated, use Socket Socket::accept() instead") nsapi_error_t accept(TCPSocket connection
	Accepts a connection on a TCP socket.
template<typename S >
	MBED_DEPRECATED_SINCE ("mbed-os-5.11","The TCPSocket(S stack) constructor is deprecated.""It discards the open() call return value.""Use another constructor and call open() explicitly, instead.") TCPSocket(S stack)
	Create a socket on a network interface.
	MBED_DEPRECATED_SINCE ("mbed-os-5.15","String-based APIs are deprecated") nsapi_error_t connect(const char *host
	Connects TCP socket to a remote host.
template<typename T , typename M >
MBED_DEPRECATED_SINCE("mbed-os-5.4","The behavior of Socket::attach differs from other attach functions in ""Mbed OS and has been known to cause confusion. Replaced by Socket::sigio.") void attach(mbed	MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method)).") void attach(T *obj
	Register a callback on state change of the socket.
virtual int	join_multicast_group (const SocketAddress &address)
	Override multicast functions to return error for TCP.
virtual nsapi_error_t	connect (const SocketAddress &address)
	Connects TCP socket to a remote host.
virtual nsapi_size_or_error_t	send (const void *data, nsapi_size_t size)
	Send data over a TCP socket.
virtual nsapi_size_or_error_t	recv (void *data, nsapi_size_t size)
	Receive data over a TCP socket.
virtual nsapi_size_or_error_t	sendto (const SocketAddress &address, const void *data, nsapi_size_t size)
	Send data on a socket.
virtual nsapi_size_or_error_t	recvfrom (SocketAddress address, void data, nsapi_size_t size)
	Receive a data from a socket.
virtual TCPSocket *	accept (nsapi_error_t *error=NULL)
	Accepts a connection on a socket.
virtual nsapi_error_t	listen (int backlog=1)
	Listen for incoming connections.
nsapi_error_t	open (NetworkStack *stack)
	Open a network socket on the network stack of the given network interface.
virtual nsapi_error_t	close ()
	Close any open connection, and deallocate any memory associated with the socket.
int	leave_multicast_group (const SocketAddress &address)
	Leave an IP multicast group.
nsapi_error_t	bind (uint16_t port)
	Bind the socket to a port on which to receive data.
virtual nsapi_error_t	bind (const SocketAddress &address)
virtual void	set_blocking (bool blocking)
virtual void	set_timeout (int timeout)
virtual nsapi_error_t	setsockopt (int level, int optname, const void *optval, unsigned optlen)
virtual nsapi_error_t	getsockopt (int level, int optname, void optval, unsigned optlen)
virtual void	sigio (mbed::Callback< void()> func)
virtual nsapi_error_t	getpeername (SocketAddress *address)
Friends
class	TCPServer
class	DTLSSocket

Detailed Description

TCP socket server.

Definition at line 32 of file TCPServer.h.

Constructor & Destructor Documentation

~TCPServer ( ) [virtual]

Destroy a socket.

Closes socket if the socket is still open

Definition at line 26 of file TCPServer.cpp.

Member Function Documentation

TCPSocket * accept ( nsapi_error_t * error = NULL ) [virtual, inherited]

Accepts a connection on a socket.

The server socket must be bound and set to listen for connections. On a new connection, returns connected network socket which user is expected to call close() and that deallocates the resources. Referencing a returned pointer after a close() call is not allowed and leads to undefined behavior.

By default, accept blocks until incoming connection occurs. If socket is set to non-blocking or times out, error is set to NSAPI_ERROR_WOULD_BLOCK.

Parameters:

error pointer to storage of the error value or NULL: NSAPI_ERROR_OK on success NSAPI_ERROR_WOULD_BLOCK if socket is set to non-blocking and would block NSAPI_ERROR_NO_SOCKET if the socket was not open

Returns:: pointer to a socket

Implements Socket.

Definition at line 275 of file TCPSocket.cpp.

nsapi_error_t bind ( uint16_t port ) [inherited]

Bind the socket to a port on which to receive data.

Parameters:

port	Local port to bind.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not open.
int	negative error codes for stack-related failures. See NetworkStack::socket_bind.

Definition at line 123 of file InternetSocket.cpp.

nsapi_error_t bind ( const SocketAddress & address ) [virtual, inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to receive data. If the IP address is zeroed, only the port is bound.

Parameters:

address Local address to bind.

Returns:: NSAPI_ERROR_OK on success, negative subclass-dependent error code on failure.

Implements Socket.

Definition at line 137 of file InternetSocket.cpp.

nsapi_error_t close ( void ) [virtual, inherited]

Close any open connection, and deallocate any memory associated with the socket.

Called from destructor if socket is not closed.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not open.
int	negative error codes for stack-related failures. See NetworkStack::socket_close.

Implements Socket.

Definition at line 64 of file InternetSocket.cpp.

nsapi_error_t connect ( const SocketAddress & address ) [virtual, inherited]

Connects TCP socket to a remote host.

Initiates a connection to a remote server specified by the indicated address.

Parameters:

address The SocketAddress of the remote host

Return values:

NSAPI_ERROR_OK	on success
NSAPI_ERROR_IN_PROGRESS	if the operation is ongoing
NSAPI_ERROR_NO_SOCKET	if the socket has not been allocated
NSAPI_ERROR_DNS_FAILURE	if the DNS address of host could not be resolved
NSAPI_ERROR_IS_CONNECTED	if the connection is already established
int	Other negative error codes for stack-related failures. See NetworkStack::socket_connect().

Implements Socket.

Reimplemented in TLSSocket.

Definition at line 46 of file TCPSocket.cpp.

nsapi_error_t getpeername ( SocketAddress * address ) [virtual, inherited]

Get the remote-end peer associated with this socket.

Copy the remote peer address to a SocketAddress structure pointed by address parameter. Socket must be connected to have a peer address associated.

Parameters:

address Pointer to SocketAddress structure.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not connected.
NSAPI_ERROR_NO_CONNECTION	if the remote peer was not set.

Implements Socket.

Definition at line 225 of file InternetSocket.cpp.

nsapi_error_t getsockopt	(	int	level,
		int	optname,
		void *	optval,
		unsigned *	optlen
	)		`[virtual, inherited]`

Get socket options.

getsockopt() allows an application to retrieve stack-specific options from the underlying stack using stack-specific level and option names, or to request generic options using levels from nsapi_socket_level_t.

For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.

Parameters:

level	Stack-specific protocol level or nsapi_socket_level_t.
optname	Level-specific option name.
optval	Destination for option value.
optlen	Length of the option value.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not open.
int	Negative error code on failure, see NetworkStack::getsockopt.

Implements Socket.

Definition at line 189 of file InternetSocket.cpp.

virtual int join_multicast_group ( const SocketAddress & address ) [virtual, inherited]

Override multicast functions to return error for TCP.

Reimplemented from InternetSocket.

Definition at line 68 of file TCPSocket.h.

int leave_multicast_group ( const SocketAddress & address ) [inherited]

Leave an IP multicast group.

Parameters:

address Multicast group IP address.

Returns:: NSAPI_ERROR_OK on success, negative error code on failure (

See also:: InternetSocket::setsockopt).

Definition at line 117 of file InternetSocket.cpp.

nsapi_error_t listen ( int backlog = 1 ) [virtual, inherited]

Listen for incoming connections.

Marks the socket as a passive socket that can be used to accept incoming connections.

Parameters:

backlog Number of pending connections that can be queued simultaneously, defaults to 1

Return values:

NSAPI_ERROR_OK	on success
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly
int	Other negative error codes for stack-related failures. See NetworkStack::socket_listen.

Implements Socket.

Definition at line 257 of file TCPSocket.cpp.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.11"	,
		"The TCPSocket(S *stack) constructor is deprecated.""It discards the open() call return value.""Use another constructor and call open()	explicitly,
		instead."
	)		`[inherited]`

Create a socket on a network interface.

Creates and opens a socket on the network stack of the given network interface.

Parameters:

stack Network stack as target for socket

Definition at line 50 of file TCPSocket.h.

MBED_DEPRECATED_SINCE ("mbed-os-5.4", "The behavior of Socket::attach differs from other attach functions in " "Mbed OS and has been known to cause confusion. Replaced by Socket::sigio.") void attach(mbed MBED_DEPRECATED_SINCE	(	"mbed-os-5.1"	,
		"The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method))."
	)		`[inherited]`

Register a callback on state change of the socket.

See also:: Socket::sigio

Register a callback on state change of the socket.

See also:: Socket::sigio

MBED_DEPRECATED_SINCE	(	"mbed-os-5.10"	,
		"TCPServer is	deprecated,
		use TCPSocket"
	)

Create a socket on a network interface.

Creates and opens a socket on the network stack of the given network interface.

Parameters:

stack Network stack as target for socket

Definition at line 50 of file TCPServer.h.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.10"	,
		"TCPServer::accept() is	deprecated,
		use Socket *Socket::accept() instead"
	)

Accepts a connection on a TCP socket.

The server socket must be bound and set to listen for connections. On a new connection, creates a network socket using the specified socket instance.

By default, accept blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters:

connection	TCPSocket instance that will handle the incoming connection.
address	Destination for the remote address or NULL

Returns:: 0 on success, negative error code on failure

MBED_DEPRECATED_SINCE	(	"mbed-os-5.15"	,
		"String-based APIs are deprecated"
	)		const `[inherited]`

Connects TCP socket to a remote host.

Initiates a connection to a remote server specified by either a domain name or an IP address and a port.

Parameters:

host	Hostname of the remote host
port	Port of the remote host

Return values:

NSAPI_ERROR_OK	on success
NSAPI_ERROR_IN_PROGRESS	if the operation is ongoing
NSAPI_ERROR_NO_SOCKET	if the socket has not been allocated
NSAPI_ERROR_DNS_FAILURE	if the DNS address of host could not be resolved
NSAPI_ERROR_IS_CONNECTED	if the connection is already established
int	Other negative error codes for stack-related failures. See NetworkStack::socket_connect().

Reimplemented from InternetSocket.

Reimplemented in TLSSocket.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.10"	,
		"TCPServer is	deprecated,
		use TCPSocket"
	)

Create an uninitialized socket.

Must call open to initialize the socket on a network stack.

nsapi_error_t open ( NetworkStack * stack ) [inherited]

Open a network socket on the network stack of the given network interface.

Note:: Not needed if stack is passed to the socket's constructor.

Parameters:

stack Network stack as target for socket.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_PARAMETER	in case the provided stack was invalid or a stack was already created and socket opened successfully.
int	negative error codes for stack-related failures. See NetworkStack::socket_open.

Reimplemented in TLSSocket.

Definition at line 38 of file InternetSocket.cpp.

nsapi_size_or_error_t recv	(	void *	data,
		nsapi_size_t	size
	)		`[virtual, inherited]`

Receive data over a TCP socket.

The socket must be connected to a remote host. Returns the number of bytes received into the buffer.

By default, recv blocks until some data is received. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK can be returned to indicate no data.

Parameters:

data	Destination buffer for data received from the host
size	Size of the buffer in bytes

Return values:

int	Number of received bytes on success
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately
int	Other negative error codes for stack-related failures. See NetworkStack::socket_recv.

Implements Socket.

Definition at line 201 of file TCPSocket.cpp.

nsapi_size_or_error_t recvfrom	(	SocketAddress *	address,
		void *	data,
		nsapi_size_t	size
	)		`[virtual, inherited]`

Receive a data from a socket.

Receives a data and stores the source address in address if address is not NULL. Returns the number of bytes written into the buffer.

By default, recvfrom blocks until a data is received. If socket is set to non-blocking or times out with no datagram, NSAPI_ERROR_WOULD_BLOCK is returned.

Parameters:

address	Destination for the source address or NULL
data	Destination buffer for datagram received from the host
size	Size of the buffer in bytes

Return values:

int	Number of received bytes on success
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately
int	Other negative error codes for stack-related failures. See NetworkStack::socket_recv.

Implements Socket.

Definition at line 249 of file TCPSocket.cpp.

nsapi_size_or_error_t send	(	const void *	data,
		nsapi_size_t	size
	)		`[virtual, inherited]`

Send data over a TCP socket.

The socket must be connected to a remote host. Returns the number of bytes sent from the buffer.

By default, send blocks until all data is sent. If socket is set to non-blocking or times out, a partial amount can be written. NSAPI_ERROR_WOULD_BLOCK is returned if no data was written.

Parameters:

data	Buffer of data to send to the host
size	Size of the buffer in bytes

Return values:

int	Number of sent bytes on success
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately
int	Other negative error codes for stack-related failures. See NetworkStack::socket_send.

Implements Socket.

Definition at line 129 of file TCPSocket.cpp.

nsapi_size_or_error_t sendto	(	const SocketAddress &	address,
		const void *	data,
		nsapi_size_t	size
	)		`[virtual, inherited]`

Send data on a socket.

TCP socket is connection oriented protocol, so address is ignored.

By default, sendto blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters:

address	Remote address
data	Buffer of data to send to the host
size	Size of the buffer in bytes

Return values:

int	Number of sent bytes on success
NSAPI_ERROR_NO_SOCKET	in case socket was not created correctly
NSAPI_ERROR_WOULD_BLOCK	in case non-blocking mode is enabled and send cannot be performed immediately
int	Other negative error codes for stack-related failures. See NetworkStack::socket_send.

Implements Socket.

Definition at line 195 of file TCPSocket.cpp.

void set_blocking ( bool blocking ) [virtual, inherited]

Set blocking or non-blocking mode of the socket.

Initially all sockets are in blocking mode. In non-blocking mode blocking operations such as send/recv/accept return NSAPI_ERROR_WOULD_BLOCK if they cannot continue.

set_blocking(false) is equivalent to set_timeout(0) set_blocking(true) is equivalent to set_timeout(-1)

Parameters:

blocking true for blocking mode, false for non-blocking mode.

Implements Socket.

Definition at line 152 of file InternetSocket.cpp.

void set_timeout ( int timeout ) [virtual, inherited]

Set timeout on blocking socket operations.

Initially all sockets have unbounded timeouts. NSAPI_ERROR_WOULD_BLOCK is returned if a blocking operation takes longer than the specified timeout. A timeout of 0 removes the timeout from the socket. A negative value gives the socket an unbounded timeout.

set_timeout(0) is equivalent to set_blocking(false) set_timeout(-1) is equivalent to set_blocking(true)

Parameters:

timeout Timeout in milliseconds

Implements Socket.

Definition at line 158 of file InternetSocket.cpp.

nsapi_error_t setsockopt	(	int	level,
		int	optname,
		const void *	optval,
		unsigned	optlen
	)		`[virtual, inherited]`

Set socket options.

setsockopt() allows an application to pass stack-specific options to the underlying stack using stack-specific level and option names, or to request generic options using levels from nsapi_socket_level_t.

For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.

Parameters:

level	Stack-specific protocol level or nsapi_socket_level_t.
optname	Level-specific option name.
optval	Option value.
optlen	Length of the option value.

Return values:

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_SOCKET	if socket is not open.
int	Negative error code on failure, see NetworkStack::setsockopt.

Implements Socket.

Definition at line 171 of file InternetSocket.cpp.

virtual void sigio ( mbed::Callback< void()> func ) [virtual, inherited]

Register a callback on state change of the socket.

The specified callback is called on state changes, such as when the socket can receive/send/accept successfully and when an error occurs. The callback may also be called spuriously without reason.

The callback may be called in an interrupt context and should not perform expensive operations such as receive/send calls.

Note! This is not intended as a replacement for a poll or attach-like asynchronous API, but rather as a building block for constructing such functionality. The exact timing of the registered function is not guaranteed and susceptible to change.

Parameters:

func	Function to call on state change.

Implements Socket.

Type:	Library
Created:	17 Dec 2019
Imports:	79
Forks:	0
Commits:	2
Dependents:	2
Dependencies:	0
Followers:	1

Important changes to repositories hosted on mbed.com

TCPServer Class Reference
[Netsocket]

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

TCPServer Class Reference [Netsocket]

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning

TCPServer Class Reference
[Netsocket]