Transport modes.

Definition at line 62 of file TLSSocketWrapper.h.

Create an uninitialized DTLS socket.

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

Definition at line 45 of file DTLSSocket.h.

Destroy the DTLSSocket and closes the transport.

Create a socket on a network interface.

Creates and opens a socket on the network stack of the given network interface. If hostname is also given, user is not required to call set_hostname() later.

Parameters

stack	Network stack as target for socket.
hostname	Hostname used for certificate verification.

Definition at line 61 of file DTLSSocket.h.

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 to call close() 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.

Returns

Pointer to a socket.

Implements Socket.

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.

Closes the socket.

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

Returns

NSAPI_ERROR_OK on success. Negative subclass-dependent error code on failure.

Implements Socket.

Connect the transport socket and start handshake.

Note

: In case connect() returns an error, the state of the socket is unspecified. A new socket should be created before reconnecting.

See Socket::connect and start_handshake

Implements Socket.

Get CA chain structure.

Returns

Mbed TLS X509 certificate chain.

Get own certificate directly from Mbed TLS.

Returns

Internal Mbed TLS X509 structure.

Get internal Mbed TLS configuration structure.

Returns

Mbed TLS SSL config.

Get internal Mbed TLS context structure.

Returns

SSL context.

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.

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.

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

NSAPI_ERROR_OK on success, negative error code on failure.

Implements Socket.

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

NSAPI_ERROR_OK on success, negative error code on failure. See UDPSocket::open.

Definition at line 77 of file DTLSSocket.h.

Receive data over a TLS socket.

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

Parameters

data	Destination buffer for data received from 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.
NSAPI_ERROR_DEVICE_ERROR	in case of tls-related errors. See mbedtls_ssl_read.

Returns

0 if no data is available to be received and the peer has performed an orderly shutdown.

Implements Socket.

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 subclass-dependent error code on failure

Implements Socket.

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.

Additional information related to the message can be retrieved with the control data.

Note

recvfrom_control() 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 subclass-dependent error code on failure

Implements Socket.

Send data over a TLS socket.

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

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.
NSAPI_ERROR_DEVICE_ERROR	in case of tls-related errors. See mbedtls_ssl_write.

Implements Socket.

Send a message on a socket.

The sendto() function sends a message through a connection-mode or connectionless-mode socket. If the socket is a connectionless-mode socket, the message is sent to the address specified. If the socket is a connected-mode socket, 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 subclass-dependent error code on failure

Implements Socket.

Send a message on a socket.

The sendto_control() function sends a message through a connection-mode or connectionless-mode socket. If the socket is a connectionless-mode socket, the message is sent to the address specified. If the socket is a connected-mode socket, address is ignored.

Additional control information can be passed to the stack for specific operations.

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 subclass-dependent error code on failure

Implements Socket.

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.

Set CA chain directly to Mbed TLS.

Parameters

crt	Mbed TLS X509 certificate chain.

Sets client certificate, and client private key.

Parameters

client_cert	Client certification in PEM or DER format.
client_cert_len	Certificate size including the terminating null byte for PEM data.
client_private_key_pem	Client private key in PEM or DER format.
client_private_key_len	Key size including the terminating null byte for PEM data

Return values

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_PARAMETER	in case the provided root_ca parameter failed parsing.

Sets client certificate, and client private key.

Parameters

client_cert_pem	Client certification in PEM format.
client_private_key_pem	Client private key in PEM format.

Return values

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_PARAMETER	in case the provided root_ca parameter failed parsing.

Set hostname.

Note

Implementation is inside following defines: #if defined(MBEDTLS_X509_CRT_PARSE_C) && !defined(MBEDTLS_X509_REMOVE_HOSTNAME_VERIFICATION)

TLSSocket requires hostname used to verify the certificate. If hostname is not given in constructor, this function must be used before starting the TLS handshake.

Parameters

hostname

Hostname of the remote host, used for certificate checking.

Set own certificate directly to Mbed TLS.

Parameters

crt	Mbed TLS X509 certificate chain.

Returns

error code from mbedtls_ssl_conf_own_cert().

Sets the certification of Root CA.

Note

Must be called before calling connect()

Parameters

root_ca	Root CA Certificate in any Mbed TLS-supported format.
len	Length of certificate (including terminating 0 for PEM).

Return values

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_MEMORY	in case there is not enough memory to allocate certificate.
NSAPI_ERROR_PARAMETER	in case the provided root_ca parameter failed parsing.

Sets the certification of Root CA.

Note

Must be called before calling connect()

Parameters

root_ca_pem

Root CA Certificate in PEM format.

Return values

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_NO_MEMORY	in case there is not enough memory to allocate certificate.
NSAPI_ERROR_PARAMETER	in case the provided root_ca parameter failed parsing.

Override Mbed TLS configuration.

Parameters

conf	Mbed TLS SSL configuration structure.

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.

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.

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.