TCP socket connection. More...

#include <TCPSocket.h>

Inherited by TCPServer, and TCPSocketFriend.

Public Member Functions
	TCPSocket ()
	Create an uninitialized socket.
template<typename S >
	TCPSocket (S *stack)
	Create a socket on a network interface.
virtual	~TCPSocket ()
	Destroy a socket.
virtual int	join_multicast_group (const SocketAddress &address)
	Override multicast functions to return error for TCP.
nsapi_error_t	connect (const char *host, uint16_t port)
	Connects TCP socket to a remote host.
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)
	Opens a socket.
virtual nsapi_error_t	close ()
	Close the socket.
int	leave_multicast_group (const SocketAddress &address)
	Leave an IP multicast group.
nsapi_error_t	bind (uint16_t port)
	Bind a specific address to a socket.
nsapi_error_t	bind (const char *address, uint16_t port)
	Bind a specific address to a socket.
virtual nsapi_error_t	bind (const SocketAddress &address)
	Bind a specific address to a socket.
virtual void	set_blocking (bool blocking)
	Set blocking or non-blocking mode of the socket.
virtual void	set_timeout (int timeout)
	Set timeout on blocking socket operations.
virtual void	sigio (mbed::Callback< void()> func)
	Register a callback on state change of the socket.
template<typename T , typename M >
MBED_DEPRECATED_SINCE("mbed-os-5.4","The behaviour 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.

Detailed Description

TCP socket connection.

Definition at line 31 of file TCPSocket.h.

Constructor & Destructor Documentation

TCPSocket ( )

Create an uninitialized socket.

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

Definition at line 21 of file TCPSocket.cpp.

TCPSocket ( S * stack )

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 47 of file TCPSocket.h.

~TCPSocket ( ) [virtual]

Destroy a socket.

Closes socket if the socket is still open

Definition at line 25 of file TCPSocket.cpp.

Member Function Documentation

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

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 behaviour.

By default, accept blocks until incomming 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

Returns:: pointer to a socket

Implements Socket.

Definition at line 248 of file TCPSocket.cpp.

nsapi_error_t bind	(	const char *	address,
		uint16_t	port
	)		`[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	Null-terminated local address to bind
port	Local port to bind

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

Definition at line 116 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:: 0 on success, negative error code on failure.

Implements Socket.

Definition at line 123 of file InternetSocket.cpp.

nsapi_error_t bind ( uint16_t port ) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to receive data.

Parameters:

port	Local port to bind

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

Definition at line 109 of file InternetSocket.cpp.

nsapi_error_t close ( void ) [virtual, inherited]

Close the socket.

Closes any open connection and deallocates any memory associated with the socket. Called from destructor if socket is not closed.

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

Implements Socket.

Definition at line 54 of file InternetSocket.cpp.

nsapi_error_t connect	(	const char *	host,
		uint16_t	port
	)

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

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

Definition at line 93 of file TCPSocket.cpp.

nsapi_error_t connect ( const SocketAddress & address ) [virtual]

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

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

Implements Socket.

Definition at line 35 of file TCPSocket.cpp.

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

Override multicast functions to return error for TCP.

Reimplemented from InternetSocket.

Definition at line 61 of file TCPSocket.h.

int leave_multicast_group ( const SocketAddress & address ) [inherited]

Leave an IP multicast group.

Parameters:

address Multicast group IP address

Returns:: Negative error code on failure

Definition at line 103 of file InternetSocket.cpp.

nsapi_error_t listen ( int backlog = 1 ) [virtual]

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

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

Implements Socket.

Definition at line 233 of file TCPSocket.cpp.

MBED_DEPRECATED_SINCE ("mbed-os-5.4", "The behaviour 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

nsapi_error_t open ( NetworkStack * stack ) [inherited]

Opens a socket.

Creates a network socket on the network stack of the given network interface. Not needed if stack is passed to the socket's constructor.

Parameters:

stack Network stack as target for socket

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

Definition at line 29 of file InternetSocket.cpp.

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

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

Returns:: Number of received bytes on success, negative error code on failure. If no data is available to be received and the peer has performed an orderly shutdown, recv() returns 0.

Implements Socket.

Definition at line 178 of file TCPSocket.cpp.

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

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

Returns:: Number of received bytes on success, negative error code on failure

Implements Socket.

Definition at line 225 of file TCPSocket.cpp.

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

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

Returns:: Number of sent bytes on success, negative error code on failure

Implements Socket.

Definition at line 107 of file TCPSocket.cpp.

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

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

Returns:: Number of sent bytes on success, negative error code on failure

Implements Socket.

Definition at line 172 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 can not continue.

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

Parameters:

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

Implements Socket.

Definition at line 138 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 give 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 144 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 will be called on state changes such as when the socket can recv/send/accept successfully and on 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 recv/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 when the registered function is called is not guaranteed and susceptible to change.

Parameters:

func	Function to call on state change

Implements Socket.

Type:	Program
Mbed OS support:	Mbed OS
Created:	11 Oct 2018
Imports:	23
Forks:	0
Commits:	4
Dependents:	0
Dependencies:	1
Followers:	1

Important changes to repositories hosted on mbed.com

TCPSocket Class Reference
[Netsocket]

Public Member Functions

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

TCPSocket Class Reference [Netsocket]

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning

TCPSocket Class Reference
[Netsocket]