DTLSSocket
DTLSSocket class hierarchy
DTLSSocket and DTLSSocketWrapper implement DTLS stream over the existing Socket transport. You can find design and implementation details in the Secure Socket page.
To use secure DTLS connections, application use the DTLSSocketWrapper through the Socket API, so existing applications and libraries are compatible.
DTLSSocketWrapper inherits TLSSocketWrapper and uses the same API. The only difference is that it uses timers to keep track of DTLS timeouts. Please see TLSSocket for an example.
DTLSSocket class reference
| Public Types |
| Public Member Functions | |
| DTLSSocket () | |
| Create an uninitialized DTLS socket. More... | |
| ~DTLSSocket () override | |
| Destroy the DTLSSocket and closes the transport. More... | |
| template<typename S > | |
| DTLSSocket (S *stack, const char *hostname=NULL) | |
| Create a socket on a network interface. More... | |
| nsapi_error_t | open (NetworkStack *stack) |
| Opens a socket. More... | |
| nsapi_error_t | close () override |
| Closes the socket. More... | |
| void | set_hostname (const char *hostname) |
| Set hostname. More... | |
| nsapi_error_t | set_root_ca_cert (const void *root_ca, size_t len) |
| Sets the certification of Root CA. More... | |
| nsapi_error_t | set_root_ca_cert (const char *root_ca_pem) |
| Sets the certification of Root CA. More... | |
| nsapi_error_t | set_client_cert_key (const void *client_cert, size_t client_cert_len, const void *client_private_key_pem, size_t client_private_key_len) |
| Sets client certificate, and client private key. More... | |
| nsapi_error_t | set_client_cert_key (const char *client_cert_pem, const char *client_private_key_pem) |
| Sets client certificate, and client private key. More... | |
| nsapi_error_t | send (const void *data, nsapi_size_t size) override |
| Send data over a TLS socket. More... | |
| nsapi_size_or_error_t | recv (void *data, nsapi_size_t size) override |
| Receive data over a TLS socket. More... | |
| nsapi_error_t | connect (const SocketAddress &address=SocketAddress()) override |
| Connect the transport socket and start handshake. More... | |
| nsapi_size_or_error_t | sendto (const SocketAddress &address, const void *data, nsapi_size_t size) override |
| Send a message on a socket. More... | |
| nsapi_size_or_error_t | recvfrom (SocketAddress *address, void *data, nsapi_size_t size) override |
| Receive a data from a socket. More... | |
| nsapi_size_or_error_t | sendto_control (const SocketAddress &address, const void *data, nsapi_size_t size, nsapi_msghdr_t *control, nsapi_size_t control_size) override |
| Send a message on a socket. More... | |
| nsapi_size_or_error_t | recvfrom_control (SocketAddress *address, void *data, nsapi_size_t size, nsapi_msghdr_t *control, nsapi_size_t control_size) override |
| Receive a data from a socket. More... | |
| nsapi_error_t | bind (const SocketAddress &address) override |
| Bind a specific address to a socket. More... | |
| void | set_blocking (bool blocking) override |
| Set blocking or non-blocking mode of the socket. More... | |
| void | set_timeout (int timeout) override |
| Set timeout on blocking socket operations. More... | |
| void | sigio (mbed::Callback< void()> func) override |
| Register a callback on state change of the socket. More... | |
| nsapi_error_t | setsockopt (int level, int optname, const void *optval, unsigned optlen) override |
| Set socket options. More... | |
| nsapi_error_t | getsockopt (int level, int optname, void *optval, unsigned *optlen) override |
| Get socket options. More... | |
| Socket * | accept (nsapi_error_t *error=NULL) override |
| Accepts a connection on a socket. More... | |
| nsapi_error_t | listen (int backlog=1) override |
| Listen for incoming connections. More... | |
| nsapi_error_t | getpeername (SocketAddress *address) override |
| Get the remote-end peer associated with this socket. More... | |
| mbedtls_x509_crt * | get_own_cert () |
| Get own certificate directly from Mbed TLS. More... | |
| int | set_own_cert (mbedtls_x509_crt *crt) |
| Set own certificate directly to Mbed TLS. More... | |
| mbedtls_x509_crt * | get_ca_chain () |
| Get CA chain structure. More... | |
| void | set_ca_chain (mbedtls_x509_crt *crt) |
| Set CA chain directly to Mbed TLS. More... | |
| mbedtls_ssl_config * | get_ssl_config () |
| Get internal Mbed TLS configuration structure. More... | |
| void | set_ssl_config (mbedtls_ssl_config *conf) |
| Override Mbed TLS configuration. More... | |
| mbedtls_ssl_context * | get_ssl_context () |
| Get internal Mbed TLS context structure. More... | |
DTLSSocket example
Please see the sockets example which can be configured to use a TLSSocket: