Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/DTLSSocket.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /** @file DTLSSocket.h DTLSSocket */
kenjiArai 0:5b88d5760320 2 /*
kenjiArai 0:5b88d5760320 3 * Copyright (c) 2018 ARM Limited
kenjiArai 0:5b88d5760320 4 * SPDX-License-Identifier: Apache-2.0
kenjiArai 0:5b88d5760320 5 *
kenjiArai 0:5b88d5760320 6 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 7 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 8 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 9 *
kenjiArai 0:5b88d5760320 10 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 11 *
kenjiArai 0:5b88d5760320 12 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 13 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 15 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 16 * limitations under the License.
kenjiArai 0:5b88d5760320 17 */
kenjiArai 0:5b88d5760320 18 /** @addtogroup netsocket
kenjiArai 0:5b88d5760320 19 * @{
kenjiArai 0:5b88d5760320 20 */
kenjiArai 0:5b88d5760320 21
kenjiArai 0:5b88d5760320 22 #ifndef DTLSSOCKET_H
kenjiArai 0:5b88d5760320 23 #define DTLSSOCKET_H
kenjiArai 0:5b88d5760320 24
kenjiArai 0:5b88d5760320 25 #include "DTLSSocketWrapper.h"
kenjiArai 0:5b88d5760320 26 #include "SocketAddress.h"
kenjiArai 0:5b88d5760320 27 #include "UDPSocket.h"
kenjiArai 0:5b88d5760320 28
kenjiArai 0:5b88d5760320 29 // This class requires Mbed TLS SSL/TLS client code
kenjiArai 0:5b88d5760320 30 #if defined(MBEDTLS_SSL_CLI_C) || defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 31
kenjiArai 0:5b88d5760320 32 /**
kenjiArai 0:5b88d5760320 33 * \brief DTLSSocket implement DTLS stream over UDP Socket.
kenjiArai 0:5b88d5760320 34 *
kenjiArai 0:5b88d5760320 35 * This is a helper class that uses DTLSSocketWrapper with
kenjiArai 0:5b88d5760320 36 * internal UDPSocket.
kenjiArai 0:5b88d5760320 37 */
kenjiArai 0:5b88d5760320 38
kenjiArai 0:5b88d5760320 39 class DTLSSocket : public DTLSSocketWrapper {
kenjiArai 0:5b88d5760320 40 public:
kenjiArai 0:5b88d5760320 41 /** Create an uninitialized DTLS socket.
kenjiArai 0:5b88d5760320 42 *
kenjiArai 0:5b88d5760320 43 * Must call open to initialize the socket on a network stack.
kenjiArai 0:5b88d5760320 44 */
kenjiArai 0:5b88d5760320 45 DTLSSocket() : DTLSSocketWrapper(&_udp_socket) {}
kenjiArai 0:5b88d5760320 46
kenjiArai 0:5b88d5760320 47 /** Destroy the DTLSSocket and closes the transport.
kenjiArai 0:5b88d5760320 48 */
kenjiArai 0:5b88d5760320 49 virtual ~DTLSSocket();
kenjiArai 0:5b88d5760320 50
kenjiArai 0:5b88d5760320 51 /** Create a socket on a network interface.
kenjiArai 0:5b88d5760320 52 *
kenjiArai 0:5b88d5760320 53 * Creates and opens a socket on the network stack of the given
kenjiArai 0:5b88d5760320 54 * network interface.
kenjiArai 0:5b88d5760320 55 * If hostname is also given, user is not required to call set_hostname() later.
kenjiArai 0:5b88d5760320 56 *
kenjiArai 0:5b88d5760320 57 * @param stack Network stack as target for socket.
kenjiArai 0:5b88d5760320 58 * @param hostname Hostname used for certificate verification.
kenjiArai 0:5b88d5760320 59 */
kenjiArai 0:5b88d5760320 60 template <typename S>
kenjiArai 0:5b88d5760320 61 DTLSSocket(S *stack, const char *hostname = NULL) : DTLSSocketWrapper(&_udp_socket, hostname)
kenjiArai 0:5b88d5760320 62 {
kenjiArai 0:5b88d5760320 63 nsapi_error_t ret = _udp_socket.open(stack);
kenjiArai 0:5b88d5760320 64 MBED_ASSERT(ret == NSAPI_ERROR_OK);
kenjiArai 0:5b88d5760320 65 }
kenjiArai 0:5b88d5760320 66
kenjiArai 0:5b88d5760320 67 /** Opens a socket.
kenjiArai 0:5b88d5760320 68 *
kenjiArai 0:5b88d5760320 69 * Creates a network socket on the network stack of the given
kenjiArai 0:5b88d5760320 70 * network interface. Not needed if stack is passed to the
kenjiArai 0:5b88d5760320 71 * socket's constructor.
kenjiArai 0:5b88d5760320 72 *
kenjiArai 0:5b88d5760320 73 * @param stack Network stack as target for socket.
kenjiArai 0:5b88d5760320 74 * @return 0 on success, negative error code on failure.
kenjiArai 0:5b88d5760320 75 */
kenjiArai 0:5b88d5760320 76 virtual nsapi_error_t open(NetworkStack *stack)
kenjiArai 0:5b88d5760320 77 {
kenjiArai 0:5b88d5760320 78 return _udp_socket.open(stack);
kenjiArai 0:5b88d5760320 79 }
kenjiArai 0:5b88d5760320 80
kenjiArai 0:5b88d5760320 81 template <typename S>
kenjiArai 0:5b88d5760320 82 nsapi_error_t open(S *stack)
kenjiArai 0:5b88d5760320 83 {
kenjiArai 0:5b88d5760320 84 return open(nsapi_create_stack(stack));
kenjiArai 0:5b88d5760320 85 }
kenjiArai 0:5b88d5760320 86
kenjiArai 0:5b88d5760320 87 using DTLSSocketWrapper::connect;
kenjiArai 0:5b88d5760320 88
kenjiArai 0:5b88d5760320 89 /** Connects TCP socket to a remote host.
kenjiArai 0:5b88d5760320 90 *
kenjiArai 0:5b88d5760320 91 * Initiates a connection to a remote server specified by either
kenjiArai 0:5b88d5760320 92 * a domain name or an IP address and a port.
kenjiArai 0:5b88d5760320 93 *
kenjiArai 0:5b88d5760320 94 * @param host Hostname of the remote host.
kenjiArai 0:5b88d5760320 95 * @param port Port of the remote host.
kenjiArai 0:5b88d5760320 96 * @return 0 on success, negative error code on failure.
kenjiArai 0:5b88d5760320 97 */
kenjiArai 0:5b88d5760320 98 nsapi_error_t connect(const char *host, uint16_t port);
kenjiArai 0:5b88d5760320 99
kenjiArai 0:5b88d5760320 100 private:
kenjiArai 0:5b88d5760320 101 UDPSocket _udp_socket;
kenjiArai 0:5b88d5760320 102 };
kenjiArai 0:5b88d5760320 103
kenjiArai 0:5b88d5760320 104 #endif
kenjiArai 0:5b88d5760320 105 #endif
kenjiArai 0:5b88d5760320 106 /** @} */