TCP socket connection. More...

#include <TCPSocket.h>

Inherits Socket.

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.
nsapi_error_t	connect (const char *host, uint16_t port)
	Connects TCP socket to a remote host.
nsapi_error_t	connect (const SocketAddress &address)
	Connects TCP socket to a remote host.
nsapi_size_or_error_t	send (const void *data, nsapi_size_t size)
	Send data over a TCP socket.
nsapi_size_or_error_t	recv (void *data, nsapi_size_t size)
	Receive data over a TCP socket.
nsapi_error_t	open (NetworkStack *stack)
	Opens a socket.
nsapi_error_t	close ()
	Close the socket.
int	close (bool shutdown=true)
	Close the socket.
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.
nsapi_error_t	bind (const SocketAddress &address)
	Bind a specific address to a socket.
void	set_blocking (bool blocking)
	Set blocking or non-blocking mode of the socket.
void	set_blocking (bool blocking, unsigned int timeout=1500)
	Set blocking or non-blocking mode of the socket and a timeout on blocking socket operations.
void	set_timeout (int timeout)
	Set timeout on blocking socket operations.
void	attach (mbed::Callback< void()> func)
	Register a callback on state change of the socket.
template<typename T , typename M >
	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.
int	set_option (int level, int optname, const void *optval, socklen_t optlen)
	Set socket options.
int	get_option (int level, int optname, void optval, socklen_t optlen)
	Get socket options.
Friends
class	TCPServer

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 27 of file TCPSocket.cpp.

Member Function Documentation

void attach ( mbed::Callback< void()> func ) [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.

Parameters:

func	Function to call on state change

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 recieve data.

Parameters:

port	Local port to bind

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

Definition at line 73 of file netsocket/Socket.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 recieve 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 80 of file netsocket/Socket.cpp.

nsapi_error_t bind ( const SocketAddress & address ) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to recieve 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.

Definition at line 87 of file netsocket/Socket.cpp.

nsapi_error_t close ( void ) [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

Reimplemented in HTTPSClient.

Definition at line 52 of file netsocket/Socket.cpp.

int close ( bool shutdown = true ) [inherited]

Close the socket.

Parameters:

shutdown free the left-over data in message queues

Definition at line 72 of file unsupported/net/lwip/Socket/Socket.cpp.

nsapi_error_t connect ( const SocketAddress & address )

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

Definition at line 37 of file TCPSocket.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 89 of file TCPSocket.cpp.

int get_option	(	int	level,
		int	optname,
		void *	optval,
		socklen_t *	optlen
	)		`[inherited]`

Get socket options.

Parameters:

level	stack level (see: lwip/sockets.h)
optname	option ID
optval	buffer pointer where to write the option value
socklen_t	length of the option value

Returns:: 0 on success, -1 on failure

Definition at line 48 of file unsupported/net/lwip/Socket/Socket.cpp.

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.

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.

Parameters:

obj	Pointer to object to call method on
method	Method to call on state change

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 27 of file netsocket/Socket.cpp.

nsapi_size_or_error_t recv	(	void *	data,
		nsapi_size_t	size
	)

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 data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

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

Definition at line 146 of file TCPSocket.cpp.

nsapi_size_or_error_t send	(	const void *	data,
		nsapi_size_t	size
	)

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 data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

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

Definition at line 103 of file TCPSocket.cpp.

void set_blocking ( bool blocking ) [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.

Definition at line 102 of file netsocket/Socket.cpp.

void set_blocking	(	bool	blocking,
		unsigned int	timeout = `1500`
	)		`[inherited]`

Set blocking or non-blocking mode of the socket and a timeout on blocking socket operations.

Parameters:

blocking	true for blocking mode, false for non-blocking mode.
timeout	timeout in ms [Default: (1500)ms].

Definition at line 27 of file unsupported/net/lwip/Socket/Socket.cpp.

int set_option	(	int	level,
		int	optname,
		const void *	optval,
		socklen_t	optlen
	)		`[inherited]`

Set socket options.

Parameters:

level	stack level (see: lwip/sockets.h)
optname	option ID
optval	option value
socklen_t	length of the option value

Returns:: 0 on success, -1 on failure

Definition at line 44 of file unsupported/net/lwip/Socket/Socket.cpp.

void set_timeout ( int timeout ) [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

Definition at line 108 of file netsocket/Socket.cpp.

Type:	Library
Created:	25 Jan 2017
Imports:	32
Forks:	0
Commits:	2
Dependents:	3
Dependencies:	0
Followers:	15

Important changes to repositories hosted on mbed.com

TCPSocket 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

TCPSocket 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

TCPSocket Class Reference
[Netsocket]