Socket implementation that uses IP network stack. More...

#include <InternetSocket.h>

Inherits Socket.

Inherited by stubInternetSocket, TCPSocket, and UDPSocket.

Public Member Functions
virtual	~InternetSocket ()
	Destroy a socket.
nsapi_error_t	open (NetworkStack *stack)
	Opens a socket.
virtual nsapi_error_t	close ()
	Close the socket.
int	join_multicast_group (const SocketAddress &address)
	Subscribes to an IP multicast group.
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.
virtual nsapi_error_t	connect (const SocketAddress &address)=0
	Connects socket to a remote address.
virtual nsapi_size_or_error_t	send (const void *data, nsapi_size_t size)=0
	Send data on a socket.
virtual nsapi_size_or_error_t	recv (void *data, nsapi_size_t size)=0
	Receive data from a socket.
virtual nsapi_size_or_error_t	sendto (const SocketAddress &address, const void *data, nsapi_size_t size)=0
	Send a message on a socket.
virtual nsapi_size_or_error_t	recvfrom (SocketAddress address, void data, nsapi_size_t size)=0
	Receive a data from a socket.
virtual Socket *	accept (nsapi_error_t *error=NULL)=0
	Accepts a connection on a socket.
virtual nsapi_error_t	listen (int backlog=1)=0
	Listen for incoming connections.

Detailed Description

Socket implementation that uses IP network stack.

Not to be directly used by applications. Cannot be directly instantiated.

Definition at line 33 of file InternetSocket.h.

Constructor & Destructor Documentation

virtual ~InternetSocket ( ) [virtual]

Destroy a socket.

Closes socket if the socket is still open

Definition at line 39 of file InternetSocket.h.

Member Function Documentation

virtual Socket* accept ( nsapi_error_t * error = NULL ) [pure 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 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

Implemented in TCPSocket, and UDPSocket.

nsapi_error_t bind ( uint16_t port )

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 bind ( const SocketAddress & address ) [virtual]

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	(	const char *	address,
		uint16_t	port
	)

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

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.

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

Connects socket to a remote address.

Attempt to make connection on connection-mode protocol or set or reset the peer address on connectionless protocol.

Also connectionless protocols use the connected address to filter incoming packets for recv() and recvfrom() calls.

To reset the peer address, zero initialised(default constructor) SocketAddress object have to be in the address parameter.

Parameters:

address The SocketAddress of the remote peer

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

Implemented in TCPSocket, and UDPSocket.

int join_multicast_group ( const SocketAddress & address )

Subscribes to an IP multicast group.

Parameters:

address Multicast group IP address

Returns:: Negative error code on failure

Reimplemented in TCPSocket.

Definition at line 98 of file InternetSocket.cpp.

int leave_multicast_group ( const SocketAddress & address )

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.

virtual nsapi_error_t listen ( int backlog = 1 ) [pure 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

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

Implemented in TCPSocket, and UDPSocket.

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))."
	)

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 )

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.

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

Receive data from a socket.

Receive data from connected socket or in case of connectionless socket this is equivalent of calling recvfrom(NULL, data, size).

If socket is connected, only packets coming from connected peer address are accepted.

Note:: recv() is allowed write to data buffer even if error occurs.

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.

Implemented in TCPSocket, and UDPSocket.

virtual nsapi_size_or_error_t recvfrom	(	SocketAddress *	address,
		void *	data,
		nsapi_size_t	size
	)		`[pure 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.

If socket is connected, only packets coming from connected peer address are accepted.

Note:: recvfrom() is allowed write to address and data buffers even if error occurs.

By default, recvfrom blocks until a datagram is received. If socket is set to non-blocking or times out with no data, 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

Implemented in TCPSocket, and UDPSocket.

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

Send data on a socket.

The socket must be connected to a remote host before send() call. Returns the number of bytes sent from the buffer. In case of connectionless socket, send data to pre-specified remote.

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.

Implemented in TCPSocket, and UDPSocket.

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

Send a message on a socket.

The sendto() function shall send a message through a connection-mode or connectionless-mode socket. If the socket is connectionless-mode, the message shall be sent to the address specified. If the socket is connection-mode, address shall be 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

Implemented in TCPSocket, and UDPSocket.

void set_blocking ( bool blocking ) [virtual]

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]

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]

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

InternetSocket 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

InternetSocket 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

InternetSocket Class Reference
[Netsocket]