Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/InternetSocket.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1
kenjiArai 0:5b88d5760320 2 /** \addtogroup netsocket */
kenjiArai 0:5b88d5760320 3 /** @{*/
kenjiArai 0:5b88d5760320 4 /* Socket
kenjiArai 0:5b88d5760320 5 * Copyright (c) 2015 ARM Limited
kenjiArai 0:5b88d5760320 6 *
kenjiArai 0:5b88d5760320 7 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 8 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 9 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 12 *
kenjiArai 0:5b88d5760320 13 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 14 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 16 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 17 * limitations under the License.
kenjiArai 0:5b88d5760320 18 */
kenjiArai 0:5b88d5760320 19
kenjiArai 0:5b88d5760320 20 #ifndef INTERNETSOCKET_H
kenjiArai 0:5b88d5760320 21 #define INTERNETSOCKET_H
kenjiArai 0:5b88d5760320 22
kenjiArai 0:5b88d5760320 23 #include "netsocket/Socket.h"
kenjiArai 0:5b88d5760320 24 #include "netsocket/NetworkStack.h"
kenjiArai 0:5b88d5760320 25 #include "rtos/Mutex.h"
kenjiArai 0:5b88d5760320 26 #include "rtos/EventFlags.h"
kenjiArai 0:5b88d5760320 27 #include "Callback.h"
kenjiArai 0:5b88d5760320 28 #include "mbed_atomic.h"
kenjiArai 0:5b88d5760320 29 #include "mbed_toolchain.h"
kenjiArai 0:5b88d5760320 30 #include "SocketStats.h"
kenjiArai 0:5b88d5760320 31
kenjiArai 0:5b88d5760320 32 /** Socket implementation that uses IP network stack.
kenjiArai 0:5b88d5760320 33 * Not to be directly used by applications. Cannot be directly instantiated.
kenjiArai 0:5b88d5760320 34 */
kenjiArai 0:5b88d5760320 35 class InternetSocket : public Socket {
kenjiArai 0:5b88d5760320 36 public:
kenjiArai 0:5b88d5760320 37 /** Destroy the socket.
kenjiArai 0:5b88d5760320 38 *
kenjiArai 0:5b88d5760320 39 * @note Closes socket if it's still open.
kenjiArai 0:5b88d5760320 40 */
kenjiArai 0:5b88d5760320 41 virtual ~InternetSocket();
kenjiArai 0:5b88d5760320 42
kenjiArai 0:5b88d5760320 43 /** Open a network socket on the network stack of the given
kenjiArai 0:5b88d5760320 44 * network interface.
kenjiArai 0:5b88d5760320 45 *
kenjiArai 0:5b88d5760320 46 * @note Not needed if stack is passed to the socket's constructor.
kenjiArai 0:5b88d5760320 47 *
kenjiArai 0:5b88d5760320 48 * @param stack Network stack as target for socket.
kenjiArai 1:9db0e321a9f4 49 * @retval NSAPI_ERROR_OK on success.
kenjiArai 1:9db0e321a9f4 50 * @retval NSAPI_ERROR_PARAMETER in case the provided stack was invalid
kenjiArai 1:9db0e321a9f4 51 * or a stack was already created and socket opened successfully.
kenjiArai 1:9db0e321a9f4 52 * @retval int negative error codes for stack-related failures.
kenjiArai 1:9db0e321a9f4 53 * See @ref NetworkStack::socket_open.
kenjiArai 0:5b88d5760320 54 */
kenjiArai 0:5b88d5760320 55 nsapi_error_t open(NetworkStack *stack);
kenjiArai 0:5b88d5760320 56
kenjiArai 0:5b88d5760320 57 #if !defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 58 template <typename S>
kenjiArai 0:5b88d5760320 59 nsapi_error_t open(S *stack)
kenjiArai 0:5b88d5760320 60 {
kenjiArai 0:5b88d5760320 61 return open(nsapi_create_stack(stack));
kenjiArai 0:5b88d5760320 62 }
kenjiArai 0:5b88d5760320 63 #endif //!defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 64
kenjiArai 0:5b88d5760320 65 /** Close any open connection, and deallocate any memory associated
kenjiArai 0:5b88d5760320 66 * with the socket. Called from destructor if socket is not closed.
kenjiArai 0:5b88d5760320 67 *
kenjiArai 1:9db0e321a9f4 68 * @retval NSAPI_ERROR_OK on success.
kenjiArai 1:9db0e321a9f4 69 * @retval NSAPI_ERROR_NO_SOCKET if socket is not open.
kenjiArai 1:9db0e321a9f4 70 * @retval int negative error codes for stack-related failures.
kenjiArai 1:9db0e321a9f4 71 * See @ref NetworkStack::socket_close.
kenjiArai 0:5b88d5760320 72 */
kenjiArai 0:5b88d5760320 73 virtual nsapi_error_t close();
kenjiArai 0:5b88d5760320 74
kenjiArai 0:5b88d5760320 75 /** Subscribe to an IP multicast group.
kenjiArai 0:5b88d5760320 76 *
kenjiArai 0:5b88d5760320 77 * @param address Multicast group IP address.
kenjiArai 1:9db0e321a9f4 78 * @return NSAPI_ERROR_OK on success, negative error code on failure (@see InternetSocket::setsockopt).
kenjiArai 0:5b88d5760320 79 */
kenjiArai 0:5b88d5760320 80 int join_multicast_group(const SocketAddress &address);
kenjiArai 0:5b88d5760320 81
kenjiArai 0:5b88d5760320 82 /** Leave an IP multicast group.
kenjiArai 0:5b88d5760320 83 *
kenjiArai 0:5b88d5760320 84 * @param address Multicast group IP address.
kenjiArai 1:9db0e321a9f4 85 * @return NSAPI_ERROR_OK on success, negative error code on failure (@see InternetSocket::setsockopt).
kenjiArai 0:5b88d5760320 86 */
kenjiArai 0:5b88d5760320 87 int leave_multicast_group(const SocketAddress &address);
kenjiArai 0:5b88d5760320 88
kenjiArai 0:5b88d5760320 89 /** Bind the socket to a port on which to receive data.
kenjiArai 0:5b88d5760320 90 *
kenjiArai 0:5b88d5760320 91 * @param port Local port to bind.
kenjiArai 1:9db0e321a9f4 92 * @retval NSAPI_ERROR_OK on success.
kenjiArai 1:9db0e321a9f4 93 * @retval NSAPI_ERROR_NO_SOCKET if socket is not open.
kenjiArai 1:9db0e321a9f4 94 * @retval int negative error codes for stack-related failures.
kenjiArai 1:9db0e321a9f4 95 * See @ref NetworkStack::socket_bind.
kenjiArai 0:5b88d5760320 96 */
kenjiArai 0:5b88d5760320 97 nsapi_error_t bind(uint16_t port);
kenjiArai 0:5b88d5760320 98
kenjiArai 0:5b88d5760320 99 /** Bind the socket to a specific address and port on which to receive
kenjiArai 0:5b88d5760320 100 * data. If the IP address is zeroed, only the port is bound.
kenjiArai 0:5b88d5760320 101 *
kenjiArai 0:5b88d5760320 102 * @param address Null-terminated local address to bind.
kenjiArai 0:5b88d5760320 103 * @param port Local port to bind.
kenjiArai 1:9db0e321a9f4 104 * @retval NSAPI_ERROR_OK on success.
kenjiArai 1:9db0e321a9f4 105 * @retval NSAPI_ERROR_NO_SOCKET if socket is not open.
kenjiArai 1:9db0e321a9f4 106 * @retval int negative error codes for stack-related failures.
kenjiArai 1:9db0e321a9f4 107 * See @ref NetworkStack::socket_bind.
kenjiArai 0:5b88d5760320 108 */
kenjiArai 1:9db0e321a9f4 109 MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
kenjiArai 0:5b88d5760320 110 nsapi_error_t bind(const char *address, uint16_t port);
kenjiArai 0:5b88d5760320 111
kenjiArai 0:5b88d5760320 112 /** @copydoc Socket::bind
kenjiArai 0:5b88d5760320 113 */
kenjiArai 0:5b88d5760320 114 virtual nsapi_error_t bind(const SocketAddress &address);
kenjiArai 0:5b88d5760320 115
kenjiArai 0:5b88d5760320 116 /** @copydoc Socket::set_blocking
kenjiArai 0:5b88d5760320 117 */
kenjiArai 0:5b88d5760320 118 virtual void set_blocking(bool blocking);
kenjiArai 0:5b88d5760320 119
kenjiArai 0:5b88d5760320 120 /** @copydoc Socket::set_timeout
kenjiArai 0:5b88d5760320 121 */
kenjiArai 0:5b88d5760320 122 virtual void set_timeout(int timeout);
kenjiArai 0:5b88d5760320 123
kenjiArai 0:5b88d5760320 124 /** @copydoc Socket::setsockopt
kenjiArai 0:5b88d5760320 125 */
kenjiArai 0:5b88d5760320 126 virtual nsapi_error_t setsockopt(int level, int optname, const void *optval, unsigned optlen);
kenjiArai 0:5b88d5760320 127
kenjiArai 0:5b88d5760320 128 /** @copydoc Socket::getsockopt
kenjiArai 0:5b88d5760320 129 */
kenjiArai 0:5b88d5760320 130 virtual nsapi_error_t getsockopt(int level, int optname, void *optval, unsigned *optlen);
kenjiArai 0:5b88d5760320 131
kenjiArai 0:5b88d5760320 132 /** @copydoc Socket::sigio
kenjiArai 0:5b88d5760320 133 */
kenjiArai 0:5b88d5760320 134 virtual void sigio(mbed::Callback<void()> func);
kenjiArai 0:5b88d5760320 135
kenjiArai 0:5b88d5760320 136 /** @copydoc Socket::getpeername
kenjiArai 0:5b88d5760320 137 */
kenjiArai 0:5b88d5760320 138 virtual nsapi_error_t getpeername(SocketAddress *address);
kenjiArai 0:5b88d5760320 139
kenjiArai 0:5b88d5760320 140 /** Register a callback on state change of the socket.
kenjiArai 0:5b88d5760320 141 *
kenjiArai 0:5b88d5760320 142 * @see Socket::sigio
kenjiArai 0:5b88d5760320 143 * @deprecated
kenjiArai 0:5b88d5760320 144 * The behavior of Socket::attach differs from other attach functions in
kenjiArai 0:5b88d5760320 145 * Mbed OS and has been known to cause confusion. Replaced by Socket::sigio.
kenjiArai 0:5b88d5760320 146 */
kenjiArai 0:5b88d5760320 147 MBED_DEPRECATED_SINCE("mbed-os-5.4",
kenjiArai 0:5b88d5760320 148 "The behavior of Socket::attach differs from other attach functions in "
kenjiArai 0:5b88d5760320 149 "Mbed OS and has been known to cause confusion. Replaced by Socket::sigio.")
kenjiArai 0:5b88d5760320 150 void attach(mbed::Callback<void()> func);
kenjiArai 0:5b88d5760320 151
kenjiArai 0:5b88d5760320 152 /** Register a callback on state change of the socket.
kenjiArai 0:5b88d5760320 153 *
kenjiArai 0:5b88d5760320 154 * @see Socket::sigio
kenjiArai 0:5b88d5760320 155 * @deprecated
kenjiArai 0:5b88d5760320 156 * The attach function does not support cv-qualifiers. Replaced by
kenjiArai 0:5b88d5760320 157 * attach(callback(obj, method)).
kenjiArai 0:5b88d5760320 158 */
kenjiArai 0:5b88d5760320 159 template <typename T, typename M>
kenjiArai 0:5b88d5760320 160 MBED_DEPRECATED_SINCE("mbed-os-5.1",
kenjiArai 0:5b88d5760320 161 "The attach function does not support cv-qualifiers. Replaced by "
kenjiArai 0:5b88d5760320 162 "attach(callback(obj, method)).")
kenjiArai 0:5b88d5760320 163 void attach(T *obj, M method)
kenjiArai 0:5b88d5760320 164 {
kenjiArai 0:5b88d5760320 165 attach(mbed::callback(obj, method));
kenjiArai 0:5b88d5760320 166 }
kenjiArai 0:5b88d5760320 167
kenjiArai 0:5b88d5760320 168 #if !defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 169
kenjiArai 0:5b88d5760320 170 protected:
kenjiArai 0:5b88d5760320 171 InternetSocket();
kenjiArai 0:5b88d5760320 172 virtual nsapi_protocol_t get_proto() = 0;
kenjiArai 0:5b88d5760320 173 virtual void event();
kenjiArai 0:5b88d5760320 174 int modify_multicast_group(const SocketAddress &address, nsapi_socket_option_t socketopt);
kenjiArai 0:5b88d5760320 175 char _interface_name[NSAPI_INTERFACE_NAME_MAX_SIZE];
kenjiArai 0:5b88d5760320 176 NetworkStack *_stack;
kenjiArai 0:5b88d5760320 177 nsapi_socket_t _socket;
kenjiArai 0:5b88d5760320 178 uint32_t _timeout;
kenjiArai 0:5b88d5760320 179 mbed::Callback<void()> _event;
kenjiArai 0:5b88d5760320 180 mbed::Callback<void()> _callback;
kenjiArai 0:5b88d5760320 181 rtos::EventFlags _event_flag;
kenjiArai 0:5b88d5760320 182 rtos::Mutex _lock;
kenjiArai 0:5b88d5760320 183 SocketAddress _remote_peer;
kenjiArai 0:5b88d5760320 184 uint8_t _readers;
kenjiArai 0:5b88d5760320 185 uint8_t _writers;
kenjiArai 0:5b88d5760320 186 core_util_atomic_flag _pending;
kenjiArai 0:5b88d5760320 187 bool _factory_allocated;
kenjiArai 0:5b88d5760320 188
kenjiArai 0:5b88d5760320 189 // Event flags
kenjiArai 0:5b88d5760320 190 static const int READ_FLAG = 0x1u;
kenjiArai 0:5b88d5760320 191 static const int WRITE_FLAG = 0x2u;
kenjiArai 0:5b88d5760320 192 static const int FINISHED_FLAG = 0x3u;
kenjiArai 0:5b88d5760320 193
kenjiArai 0:5b88d5760320 194 friend class DTLSSocket; // Allow DTLSSocket::connect() to do name resolution on the _stack
kenjiArai 0:5b88d5760320 195 SocketStats _socket_stats;
kenjiArai 0:5b88d5760320 196
kenjiArai 0:5b88d5760320 197 #endif //!defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 198 };
kenjiArai 0:5b88d5760320 199
kenjiArai 0:5b88d5760320 200 #endif // INTERNETSOCKET_H
kenjiArai 0:5b88d5760320 201
kenjiArai 0:5b88d5760320 202 /** @}*/