Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/NetworkStack.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 /* NetworkStack
kenjiArai 0:5b88d5760320 3 * Copyright (c) 2015 ARM Limited
kenjiArai 0:5b88d5760320 4 *
kenjiArai 0:5b88d5760320 5 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 6 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 7 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 8 *
kenjiArai 0:5b88d5760320 9 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 12 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 14 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 15 * limitations under the License.
kenjiArai 0:5b88d5760320 16 */
kenjiArai 0:5b88d5760320 17
kenjiArai 0:5b88d5760320 18 #ifndef NETWORK_STACK_H
kenjiArai 0:5b88d5760320 19 #define NETWORK_STACK_H
kenjiArai 0:5b88d5760320 20
kenjiArai 0:5b88d5760320 21 #include "nsapi_types.h"
kenjiArai 0:5b88d5760320 22 #include "netsocket/SocketAddress.h"
kenjiArai 0:5b88d5760320 23 #include "netsocket/NetworkInterface.h"
kenjiArai 0:5b88d5760320 24 #include "DNS.h"
kenjiArai 0:5b88d5760320 25
kenjiArai 0:5b88d5760320 26 /** @file NetworkStack.h NetworkStack class */
kenjiArai 0:5b88d5760320 27 /** @addtogroup netsocket
kenjiArai 0:5b88d5760320 28 * @{ */
kenjiArai 0:5b88d5760320 29
kenjiArai 0:5b88d5760320 30 // Predeclared classes
kenjiArai 0:5b88d5760320 31 class OnboardNetworkStack;
kenjiArai 0:5b88d5760320 32
kenjiArai 0:5b88d5760320 33 /** NetworkStack class
kenjiArai 0:5b88d5760320 34 *
kenjiArai 0:5b88d5760320 35 * Common interface that is shared between hardware that
kenjiArai 0:5b88d5760320 36 * can connect to a network over IP. By implementing the
kenjiArai 0:5b88d5760320 37 * NetworkStack, a network stack can be used as a target
kenjiArai 0:5b88d5760320 38 * for instantiating network sockets.
kenjiArai 0:5b88d5760320 39 */
kenjiArai 0:5b88d5760320 40 class NetworkStack: public DNS {
kenjiArai 0:5b88d5760320 41 public:
kenjiArai 0:5b88d5760320 42 virtual ~NetworkStack() {};
kenjiArai 0:5b88d5760320 43
kenjiArai 0:5b88d5760320 44 /** Get the local IP address
kenjiArai 0:5b88d5760320 45 *
kenjiArai 1:9db0e321a9f4 46 * @param address SocketAddress representation of the local IP address
kenjiArai 1:9db0e321a9f4 47 * @retval NSAPI_ERROR_OK on success
kenjiArai 1:9db0e321a9f4 48 * @retval NSAPI_ERROR_UNSUPPORTED if this feature is not supported
kenjiArai 1:9db0e321a9f4 49 * @retval NSAPI_ERROR_PARAMETER if the provided pointer is invalid
kenjiArai 1:9db0e321a9f4 50 * @retval NSAPI_ERROR_NO_ADDRESS if the address cannot be obtained from stack
kenjiArai 0:5b88d5760320 51 */
kenjiArai 1:9db0e321a9f4 52 virtual nsapi_error_t get_ip_address(SocketAddress *address);
kenjiArai 1:9db0e321a9f4 53
kenjiArai 1:9db0e321a9f4 54 MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
kenjiArai 0:5b88d5760320 55 virtual const char *get_ip_address();
kenjiArai 0:5b88d5760320 56
kenjiArai 1:9db0e321a9f4 57 /** Get the IPv6 link local address
kenjiArai 1:9db0e321a9f4 58 *
kenjiArai 1:9db0e321a9f4 59 * @param address SocketAddress representation of the link local IPv6 address
kenjiArai 1:9db0e321a9f4 60 * @retval NSAPI_ERROR_OK on success
kenjiArai 1:9db0e321a9f4 61 * @retval NSAPI_ERROR_UNSUPPORTED if this feature is not supported
kenjiArai 1:9db0e321a9f4 62 * @retval NSAPI_ERROR_PARAMETER if the provided pointer is invalid
kenjiArai 1:9db0e321a9f4 63 */
kenjiArai 1:9db0e321a9f4 64 virtual nsapi_error_t get_ipv6_link_local_address(SocketAddress *address);
kenjiArai 1:9db0e321a9f4 65
kenjiArai 0:5b88d5760320 66 /** Get the local IP address on interface name
kenjiArai 0:5b88d5760320 67 *
kenjiArai 1:9db0e321a9f4 68 * @param address SocketAddress representation of the link local IPv6 address
kenjiArai 0:5b88d5760320 69 * @param interface_name Network interface_name
kenjiArai 1:9db0e321a9f4 70 * @retval NSAPI_ERROR_OK on success
kenjiArai 1:9db0e321a9f4 71 * @retval NSAPI_ERROR_UNSUPPORTED if this feature is not supported
kenjiArai 1:9db0e321a9f4 72 * @retval NSAPI_ERROR_PARAMETER if the provided pointer is invalid
kenjiArai 1:9db0e321a9f4 73 * @retval NSAPI_ERROR_NO_ADDRESS if the address cannot be obtained from stack
kenjiArai 0:5b88d5760320 74 */
kenjiArai 1:9db0e321a9f4 75 virtual nsapi_error_t get_ip_address_if(SocketAddress *address, const char *interface_name);
kenjiArai 1:9db0e321a9f4 76
kenjiArai 1:9db0e321a9f4 77 MBED_DEPRECATED_SINCE("mbed-os-5.15", "String-based APIs are deprecated")
kenjiArai 0:5b88d5760320 78 virtual const char *get_ip_address_if(const char *interface_name);
kenjiArai 0:5b88d5760320 79
kenjiArai 0:5b88d5760320 80 /** Translates a hostname to an IP address with specific version
kenjiArai 0:5b88d5760320 81 *
kenjiArai 0:5b88d5760320 82 * The hostname may be either a domain name or an IP address. If the
kenjiArai 0:5b88d5760320 83 * hostname is an IP address, no network transactions will be performed.
kenjiArai 0:5b88d5760320 84 *
kenjiArai 0:5b88d5760320 85 * If no stack-specific DNS resolution is provided, the hostname
kenjiArai 0:5b88d5760320 86 * will be resolve using a UDP socket on the stack.
kenjiArai 0:5b88d5760320 87 *
kenjiArai 0:5b88d5760320 88 * @param host Hostname to resolve
kenjiArai 0:5b88d5760320 89 * @param address Pointer to a SocketAddress to store the result.
kenjiArai 0:5b88d5760320 90 * @param version IP version of address to resolve, NSAPI_UNSPEC indicates
kenjiArai 0:5b88d5760320 91 * version is chosen by the stack (defaults to NSAPI_UNSPEC)
kenjiArai 0:5b88d5760320 92 * @param interface_name Network interface_name
kenjiArai 1:9db0e321a9f4 93 * @retval NSAPI_ERROR_OK on success
kenjiArai 1:9db0e321a9f4 94 * @retval NSAPI_ERROR_PARAMETER if invalid (null) name is provided
kenjiArai 1:9db0e321a9f4 95 * @retval NSAPI_ERROR_DNS_FAILURE if DNS resolution fails
kenjiArai 1:9db0e321a9f4 96 * @retval int other negative errors, see @ref nsapi_dns_query
kenjiArai 0:5b88d5760320 97 */
kenjiArai 0:5b88d5760320 98 virtual nsapi_error_t gethostbyname(const char *host,
kenjiArai 0:5b88d5760320 99 SocketAddress *address, nsapi_version_t version = NSAPI_UNSPEC, const char *interface_name = NULL);
kenjiArai 0:5b88d5760320 100
kenjiArai 0:5b88d5760320 101 /** Hostname translation callback (asynchronous)
kenjiArai 0:5b88d5760320 102 *
kenjiArai 0:5b88d5760320 103 * Callback will be called after DNS resolution completes or a failure occurs.
kenjiArai 0:5b88d5760320 104 *
kenjiArai 0:5b88d5760320 105 * Callback should not take more than 10ms to execute, otherwise it might
kenjiArai 0:5b88d5760320 106 * prevent underlying thread processing. A portable user of the callback
kenjiArai 0:5b88d5760320 107 * should not make calls to network operations due to stack size limitations.
kenjiArai 0:5b88d5760320 108 * The callback should not perform expensive operations such as socket recv/send
kenjiArai 0:5b88d5760320 109 * calls or blocking operations.
kenjiArai 0:5b88d5760320 110 *
kenjiArai 0:5b88d5760320 111 * @param status NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 112 * @param address On success, destination for the host SocketAddress
kenjiArai 0:5b88d5760320 113 */
kenjiArai 0:5b88d5760320 114 typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address)> hostbyname_cb_t;
kenjiArai 0:5b88d5760320 115
kenjiArai 0:5b88d5760320 116 /** Translates a hostname to an IP address (asynchronous)
kenjiArai 0:5b88d5760320 117 *
kenjiArai 0:5b88d5760320 118 * The hostname may be either a domain name or an IP address. If the
kenjiArai 0:5b88d5760320 119 * hostname is an IP address, no network transactions will be performed.
kenjiArai 0:5b88d5760320 120 *
kenjiArai 0:5b88d5760320 121 * If no stack-specific DNS resolution is provided, the hostname
kenjiArai 0:5b88d5760320 122 * will be resolve using a UDP socket on the stack.
kenjiArai 0:5b88d5760320 123 *
kenjiArai 0:5b88d5760320 124 * Call is non-blocking. Result of the DNS operation is returned by the callback.
kenjiArai 0:5b88d5760320 125 * If this function returns failure, callback will not be called. In case result
kenjiArai 0:5b88d5760320 126 * is success (IP address was found from DNS cache), callback will be called
kenjiArai 0:5b88d5760320 127 * before function returns.
kenjiArai 0:5b88d5760320 128 *
kenjiArai 0:5b88d5760320 129 * @param host Hostname to resolve
kenjiArai 0:5b88d5760320 130 * @param callback Callback that is called for result
kenjiArai 0:5b88d5760320 131 * @param version IP version of address to resolve, NSAPI_UNSPEC indicates
kenjiArai 0:5b88d5760320 132 * version is chosen by the stack (defaults to NSAPI_UNSPEC)
kenjiArai 0:5b88d5760320 133 * @param interface_name Network interface_name
kenjiArai 0:5b88d5760320 134 * @return 0 on immediate success,
kenjiArai 0:5b88d5760320 135 * negative error code on immediate failure or
kenjiArai 0:5b88d5760320 136 * a positive unique id that represents the hostname translation operation
kenjiArai 0:5b88d5760320 137 * and can be passed to cancel
kenjiArai 0:5b88d5760320 138 */
kenjiArai 0:5b88d5760320 139 virtual nsapi_value_or_error_t gethostbyname_async(const char *host, hostbyname_cb_t callback, nsapi_version_t version = NSAPI_UNSPEC,
kenjiArai 0:5b88d5760320 140 const char *interface_name = NULL);
kenjiArai 0:5b88d5760320 141
kenjiArai 0:5b88d5760320 142 /** Cancels asynchronous hostname translation
kenjiArai 0:5b88d5760320 143 *
kenjiArai 0:5b88d5760320 144 * When translation is cancelled, callback will not be called.
kenjiArai 0:5b88d5760320 145 *
kenjiArai 0:5b88d5760320 146 * @param id Unique id of the hostname translation operation
kenjiArai 0:5b88d5760320 147 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 148 */
kenjiArai 0:5b88d5760320 149 virtual nsapi_error_t gethostbyname_async_cancel(int id);
kenjiArai 0:5b88d5760320 150
kenjiArai 0:5b88d5760320 151 /** Add a domain name server to list of servers to query
kenjiArai 0:5b88d5760320 152 *
kenjiArai 0:5b88d5760320 153 * @param address Destination for the host address
kenjiArai 0:5b88d5760320 154 * @param interface_name Network interface name
kenjiArai 0:5b88d5760320 155 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 156 */
kenjiArai 0:5b88d5760320 157 virtual nsapi_error_t add_dns_server(const SocketAddress &address, const char *interface_name = NULL);
kenjiArai 0:5b88d5760320 158
kenjiArai 0:5b88d5760320 159 /** Get a domain name server from a list of servers to query
kenjiArai 0:5b88d5760320 160 *
kenjiArai 0:5b88d5760320 161 * Returns a DNS server address for a index. If returns error no more
kenjiArai 0:5b88d5760320 162 * DNS servers to read.
kenjiArai 0:5b88d5760320 163 *
kenjiArai 0:5b88d5760320 164 * @param index Index of the DNS server, starts from zero
kenjiArai 0:5b88d5760320 165 * @param address Destination for the host address
kenjiArai 0:5b88d5760320 166 * @param interface_name Network interface name
kenjiArai 0:5b88d5760320 167 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 168 */
kenjiArai 0:5b88d5760320 169 virtual nsapi_error_t get_dns_server(int index, SocketAddress *address, const char *interface_name = NULL);
kenjiArai 0:5b88d5760320 170
kenjiArai 0:5b88d5760320 171 /* Set stack options
kenjiArai 0:5b88d5760320 172 *
kenjiArai 0:5b88d5760320 173 * setstackopt allows an application to pass stack-specific options
kenjiArai 0:5b88d5760320 174 * to the underlying stack using stack-specific level and option names,
kenjiArai 0:5b88d5760320 175 * or to request generic options using levels from nsapi_stack_level_t.
kenjiArai 0:5b88d5760320 176 *
kenjiArai 0:5b88d5760320 177 * For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned
kenjiArai 0:5b88d5760320 178 * and the stack is unmodified.
kenjiArai 0:5b88d5760320 179 *
kenjiArai 0:5b88d5760320 180 * @param level Stack-specific protocol level or nsapi_stack_level_t
kenjiArai 0:5b88d5760320 181 * @param optname Level-specific option name
kenjiArai 0:5b88d5760320 182 * @param optval Option value
kenjiArai 0:5b88d5760320 183 * @param optlen Length of the option value
kenjiArai 0:5b88d5760320 184 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 185 */
kenjiArai 0:5b88d5760320 186 virtual nsapi_error_t setstackopt(int level, int optname, const void *optval, unsigned optlen);
kenjiArai 0:5b88d5760320 187
kenjiArai 0:5b88d5760320 188 /* Get stack options
kenjiArai 0:5b88d5760320 189 *
kenjiArai 0:5b88d5760320 190 * getstackopt allows an application to retrieve stack-specific options
kenjiArai 0:5b88d5760320 191 * to the underlying stack using stack-specific level and option names,
kenjiArai 0:5b88d5760320 192 * or to request generic options using levels from nsapi_stack_level_t.
kenjiArai 0:5b88d5760320 193 *
kenjiArai 0:5b88d5760320 194 * @param level Stack-specific protocol level or nsapi_stack_level_t
kenjiArai 0:5b88d5760320 195 * @param optname Level-specific option name
kenjiArai 0:5b88d5760320 196 * @param optval Destination for option value
kenjiArai 0:5b88d5760320 197 * @param optlen Length of the option value
kenjiArai 0:5b88d5760320 198 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 199 */
kenjiArai 0:5b88d5760320 200 virtual nsapi_error_t getstackopt(int level, int optname, void *optval, unsigned *optlen);
kenjiArai 0:5b88d5760320 201
kenjiArai 0:5b88d5760320 202 /** Dynamic downcast to a OnboardNetworkStack */
kenjiArai 0:5b88d5760320 203 virtual OnboardNetworkStack *onboardNetworkStack()
kenjiArai 0:5b88d5760320 204 {
kenjiArai 0:5b88d5760320 205 return 0;
kenjiArai 0:5b88d5760320 206 }
kenjiArai 0:5b88d5760320 207
kenjiArai 0:5b88d5760320 208 protected:
kenjiArai 0:5b88d5760320 209 friend class InternetSocket;
kenjiArai 1:9db0e321a9f4 210 friend class InternetDatagramSocket;
kenjiArai 0:5b88d5760320 211 friend class TCPSocket;
kenjiArai 0:5b88d5760320 212 friend class TCPServer;
kenjiArai 0:5b88d5760320 213
kenjiArai 0:5b88d5760320 214 /** Opens a socket
kenjiArai 0:5b88d5760320 215 *
kenjiArai 0:5b88d5760320 216 * Creates a network socket and stores it in the specified handle.
kenjiArai 0:5b88d5760320 217 * The handle must be passed to following calls on the socket.
kenjiArai 0:5b88d5760320 218 *
kenjiArai 0:5b88d5760320 219 * A stack may have a finite number of sockets, in this case
kenjiArai 0:5b88d5760320 220 * NSAPI_ERROR_NO_SOCKET is returned if no socket is available.
kenjiArai 0:5b88d5760320 221 *
kenjiArai 0:5b88d5760320 222 * @param handle Destination for the handle to a newly created socket
kenjiArai 0:5b88d5760320 223 * @param proto Protocol of socket to open, NSAPI_TCP or NSAPI_UDP
kenjiArai 0:5b88d5760320 224 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 225 */
kenjiArai 0:5b88d5760320 226 virtual nsapi_error_t socket_open(nsapi_socket_t *handle, nsapi_protocol_t proto) = 0;
kenjiArai 0:5b88d5760320 227
kenjiArai 0:5b88d5760320 228 /** Close the socket
kenjiArai 0:5b88d5760320 229 *
kenjiArai 0:5b88d5760320 230 * Closes any open connection and deallocates any memory associated
kenjiArai 0:5b88d5760320 231 * with the socket.
kenjiArai 0:5b88d5760320 232 *
kenjiArai 0:5b88d5760320 233 * @param handle Socket handle
kenjiArai 0:5b88d5760320 234 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 235 */
kenjiArai 0:5b88d5760320 236 virtual nsapi_error_t socket_close(nsapi_socket_t handle) = 0;
kenjiArai 0:5b88d5760320 237
kenjiArai 0:5b88d5760320 238 /** Bind a specific address to a socket
kenjiArai 0:5b88d5760320 239 *
kenjiArai 0:5b88d5760320 240 * Binding a socket specifies the address and port on which to receive
kenjiArai 0:5b88d5760320 241 * data. If the IP address is zeroed, only the port is bound.
kenjiArai 0:5b88d5760320 242 *
kenjiArai 0:5b88d5760320 243 * @param handle Socket handle
kenjiArai 0:5b88d5760320 244 * @param address Local address to bind
kenjiArai 0:5b88d5760320 245 * @return NSAPI_ERROR_OK on success, negative error code on failure.
kenjiArai 0:5b88d5760320 246 */
kenjiArai 0:5b88d5760320 247 virtual nsapi_error_t socket_bind(nsapi_socket_t handle, const SocketAddress &address) = 0;
kenjiArai 0:5b88d5760320 248
kenjiArai 0:5b88d5760320 249 /** Listen for connections on a TCP socket
kenjiArai 0:5b88d5760320 250 *
kenjiArai 0:5b88d5760320 251 * Marks the socket as a passive socket that can be used to accept
kenjiArai 0:5b88d5760320 252 * incoming connections.
kenjiArai 0:5b88d5760320 253 *
kenjiArai 0:5b88d5760320 254 * @param handle Socket handle
kenjiArai 0:5b88d5760320 255 * @param backlog Number of pending connections that can be queued
kenjiArai 0:5b88d5760320 256 * simultaneously
kenjiArai 0:5b88d5760320 257 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 258 */
kenjiArai 0:5b88d5760320 259 virtual nsapi_error_t socket_listen(nsapi_socket_t handle, int backlog) = 0;
kenjiArai 0:5b88d5760320 260
kenjiArai 0:5b88d5760320 261 /** Connects TCP socket to a remote host
kenjiArai 0:5b88d5760320 262 *
kenjiArai 0:5b88d5760320 263 * Initiates a connection to a remote server specified by the
kenjiArai 0:5b88d5760320 264 * indicated address.
kenjiArai 0:5b88d5760320 265 *
kenjiArai 0:5b88d5760320 266 * @param handle Socket handle
kenjiArai 0:5b88d5760320 267 * @param address The SocketAddress of the remote host
kenjiArai 0:5b88d5760320 268 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 269 */
kenjiArai 0:5b88d5760320 270 virtual nsapi_error_t socket_connect(nsapi_socket_t handle, const SocketAddress &address) = 0;
kenjiArai 0:5b88d5760320 271
kenjiArai 0:5b88d5760320 272 /** Accepts a connection on a TCP socket
kenjiArai 0:5b88d5760320 273 *
kenjiArai 0:5b88d5760320 274 * The server socket must be bound and set to listen for connections.
kenjiArai 0:5b88d5760320 275 * On a new connection, creates a network socket and stores it in the
kenjiArai 0:5b88d5760320 276 * specified handle. The handle must be passed to following calls on
kenjiArai 0:5b88d5760320 277 * the socket.
kenjiArai 0:5b88d5760320 278 *
kenjiArai 0:5b88d5760320 279 * A stack may have a finite number of sockets, in this case
kenjiArai 0:5b88d5760320 280 * NSAPI_ERROR_NO_SOCKET is returned if no socket is available.
kenjiArai 0:5b88d5760320 281 *
kenjiArai 0:5b88d5760320 282 * This call is non-blocking. If accept would block,
kenjiArai 0:5b88d5760320 283 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kenjiArai 0:5b88d5760320 284 *
kenjiArai 0:5b88d5760320 285 * @param server Socket handle to server to accept from
kenjiArai 0:5b88d5760320 286 * @param handle Destination for a handle to the newly created socket
kenjiArai 0:5b88d5760320 287 * @param address Destination for the remote address or NULL
kenjiArai 0:5b88d5760320 288 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 289 */
kenjiArai 0:5b88d5760320 290 virtual nsapi_error_t socket_accept(nsapi_socket_t server,
kenjiArai 0:5b88d5760320 291 nsapi_socket_t *handle, SocketAddress *address = 0) = 0;
kenjiArai 0:5b88d5760320 292
kenjiArai 0:5b88d5760320 293 /** Send data over a TCP socket
kenjiArai 0:5b88d5760320 294 *
kenjiArai 0:5b88d5760320 295 * The socket must be connected to a remote host. Returns the number of
kenjiArai 0:5b88d5760320 296 * bytes sent from the buffer.
kenjiArai 0:5b88d5760320 297 *
kenjiArai 0:5b88d5760320 298 * This call is non-blocking. If send would block,
kenjiArai 0:5b88d5760320 299 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kenjiArai 0:5b88d5760320 300 *
kenjiArai 0:5b88d5760320 301 * @param handle Socket handle
kenjiArai 0:5b88d5760320 302 * @param data Buffer of data to send to the host
kenjiArai 0:5b88d5760320 303 * @param size Size of the buffer in bytes
kenjiArai 0:5b88d5760320 304 * @return Number of sent bytes on success, negative error
kenjiArai 0:5b88d5760320 305 * code on failure
kenjiArai 0:5b88d5760320 306 */
kenjiArai 0:5b88d5760320 307 virtual nsapi_size_or_error_t socket_send(nsapi_socket_t handle,
kenjiArai 0:5b88d5760320 308 const void *data, nsapi_size_t size) = 0;
kenjiArai 0:5b88d5760320 309
kenjiArai 0:5b88d5760320 310 /** Receive data over a TCP socket
kenjiArai 0:5b88d5760320 311 *
kenjiArai 0:5b88d5760320 312 * The socket must be connected to a remote host. Returns the number of
kenjiArai 0:5b88d5760320 313 * bytes received into the buffer.
kenjiArai 0:5b88d5760320 314 *
kenjiArai 0:5b88d5760320 315 * This call is non-blocking. If recv would block,
kenjiArai 0:5b88d5760320 316 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kenjiArai 0:5b88d5760320 317 *
kenjiArai 0:5b88d5760320 318 * @param handle Socket handle
kenjiArai 0:5b88d5760320 319 * @param data Destination buffer for data received from the host
kenjiArai 0:5b88d5760320 320 * @param size Size of the buffer in bytes
kenjiArai 0:5b88d5760320 321 * @return Number of received bytes on success, negative error
kenjiArai 0:5b88d5760320 322 * code on failure
kenjiArai 0:5b88d5760320 323 */
kenjiArai 0:5b88d5760320 324 virtual nsapi_size_or_error_t socket_recv(nsapi_socket_t handle,
kenjiArai 0:5b88d5760320 325 void *data, nsapi_size_t size) = 0;
kenjiArai 0:5b88d5760320 326
kenjiArai 0:5b88d5760320 327 /** Send a packet over a UDP socket
kenjiArai 0:5b88d5760320 328 *
kenjiArai 0:5b88d5760320 329 * Sends data to the specified address. Returns the number of bytes
kenjiArai 0:5b88d5760320 330 * sent from the buffer.
kenjiArai 0:5b88d5760320 331 *
kenjiArai 0:5b88d5760320 332 * This call is non-blocking. If sendto would block,
kenjiArai 0:5b88d5760320 333 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kenjiArai 0:5b88d5760320 334 *
kenjiArai 0:5b88d5760320 335 * @param handle Socket handle
kenjiArai 0:5b88d5760320 336 * @param address The SocketAddress of the remote host
kenjiArai 0:5b88d5760320 337 * @param data Buffer of data to send to the host
kenjiArai 0:5b88d5760320 338 * @param size Size of the buffer in bytes
kenjiArai 0:5b88d5760320 339 * @return Number of sent bytes on success, negative error
kenjiArai 0:5b88d5760320 340 * code on failure
kenjiArai 0:5b88d5760320 341 */
kenjiArai 0:5b88d5760320 342 virtual nsapi_size_or_error_t socket_sendto(nsapi_socket_t handle, const SocketAddress &address,
kenjiArai 0:5b88d5760320 343 const void *data, nsapi_size_t size) = 0;
kenjiArai 0:5b88d5760320 344
kenjiArai 0:5b88d5760320 345 /** Receive a packet over a UDP socket
kenjiArai 0:5b88d5760320 346 *
kenjiArai 0:5b88d5760320 347 * Receives data and stores the source address in address if address
kenjiArai 0:5b88d5760320 348 * is not NULL. Returns the number of bytes received into the buffer.
kenjiArai 0:5b88d5760320 349 *
kenjiArai 0:5b88d5760320 350 * This call is non-blocking. If recvfrom would block,
kenjiArai 0:5b88d5760320 351 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kenjiArai 0:5b88d5760320 352 *
kenjiArai 0:5b88d5760320 353 * @param handle Socket handle
kenjiArai 0:5b88d5760320 354 * @param address Destination for the source address or NULL
kenjiArai 0:5b88d5760320 355 * @param buffer Destination buffer for data received from the host
kenjiArai 0:5b88d5760320 356 * @param size Size of the buffer in bytes
kenjiArai 0:5b88d5760320 357 * @return Number of received bytes on success, negative error
kenjiArai 0:5b88d5760320 358 * code on failure
kenjiArai 0:5b88d5760320 359 */
kenjiArai 0:5b88d5760320 360 virtual nsapi_size_or_error_t socket_recvfrom(nsapi_socket_t handle, SocketAddress *address,
kenjiArai 0:5b88d5760320 361 void *buffer, nsapi_size_t size) = 0;
kenjiArai 0:5b88d5760320 362
kenjiArai 0:5b88d5760320 363 /** Register a callback on state change of the socket
kenjiArai 0:5b88d5760320 364 *
kenjiArai 0:5b88d5760320 365 * The specified callback will be called on state changes such as when
kenjiArai 0:5b88d5760320 366 * the socket can recv/send/accept successfully and on when an error
kenjiArai 0:5b88d5760320 367 * occurs. The callback may also be called spuriously without reason.
kenjiArai 0:5b88d5760320 368 *
kenjiArai 0:5b88d5760320 369 * The callback may be called in an interrupt context and should not
kenjiArai 0:5b88d5760320 370 * perform expensive operations such as recv/send calls.
kenjiArai 0:5b88d5760320 371 *
kenjiArai 0:5b88d5760320 372 * @param handle Socket handle
kenjiArai 0:5b88d5760320 373 * @param callback Function to call on state change
kenjiArai 0:5b88d5760320 374 * @param data Argument to pass to callback
kenjiArai 0:5b88d5760320 375 */
kenjiArai 0:5b88d5760320 376 virtual void socket_attach(nsapi_socket_t handle, void (*callback)(void *), void *data) = 0;
kenjiArai 0:5b88d5760320 377
kenjiArai 0:5b88d5760320 378 /** Set stack-specific socket options.
kenjiArai 0:5b88d5760320 379 *
kenjiArai 0:5b88d5760320 380 * The setsockopt allow an application to pass stack-specific hints
kenjiArai 0:5b88d5760320 381 * to the underlying stack. For unsupported options,
kenjiArai 0:5b88d5760320 382 * NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.
kenjiArai 0:5b88d5760320 383 *
kenjiArai 0:5b88d5760320 384 * @param handle Socket handle.
kenjiArai 0:5b88d5760320 385 * @param level Stack-specific protocol level.
kenjiArai 0:5b88d5760320 386 * @param optname Stack-specific option identifier.
kenjiArai 0:5b88d5760320 387 * @param optval Option value.
kenjiArai 0:5b88d5760320 388 * @param optlen Length of the option value.
kenjiArai 0:5b88d5760320 389 * @return NSAPI_ERROR_OK on success, negative error code on failure.
kenjiArai 0:5b88d5760320 390 */
kenjiArai 0:5b88d5760320 391 virtual nsapi_error_t setsockopt(nsapi_socket_t handle, int level,
kenjiArai 0:5b88d5760320 392 int optname, const void *optval, unsigned optlen);
kenjiArai 0:5b88d5760320 393
kenjiArai 0:5b88d5760320 394 /** Get stack-specific socket options.
kenjiArai 0:5b88d5760320 395 *
kenjiArai 0:5b88d5760320 396 * The getstackopt allow an application to retrieve stack-specific hints
kenjiArai 0:5b88d5760320 397 * from the underlying stack. For unsupported options,
kenjiArai 0:5b88d5760320 398 * NSAPI_ERROR_UNSUPPORTED is returned and optval is unmodified.
kenjiArai 0:5b88d5760320 399 *
kenjiArai 0:5b88d5760320 400 * @param handle Socket handle.
kenjiArai 0:5b88d5760320 401 * @param level Stack-specific protocol level.
kenjiArai 0:5b88d5760320 402 * @param optname Stack-specific option identifier.
kenjiArai 0:5b88d5760320 403 * @param optval Destination for option value.
kenjiArai 0:5b88d5760320 404 * @param optlen Length of the option value.
kenjiArai 0:5b88d5760320 405 * @return NSAPI_ERROR_OK on success, negative error code on failure.
kenjiArai 0:5b88d5760320 406 */
kenjiArai 0:5b88d5760320 407 virtual nsapi_error_t getsockopt(nsapi_socket_t handle, int level,
kenjiArai 0:5b88d5760320 408 int optname, void *optval, unsigned *optlen);
kenjiArai 0:5b88d5760320 409
kenjiArai 0:5b88d5760320 410 private:
kenjiArai 0:5b88d5760320 411
kenjiArai 0:5b88d5760320 412 /** Call in callback
kenjiArai 0:5b88d5760320 413 *
kenjiArai 0:5b88d5760320 414 * Callback is used to call the call in method of the network stack.
kenjiArai 0:5b88d5760320 415 */
kenjiArai 0:5b88d5760320 416 typedef mbed::Callback<nsapi_error_t (int delay_ms, mbed::Callback<void()> user_cb)> call_in_callback_cb_t;
kenjiArai 0:5b88d5760320 417
kenjiArai 0:5b88d5760320 418 /** Get a call in callback
kenjiArai 0:5b88d5760320 419 *
kenjiArai 0:5b88d5760320 420 * Get a call in callback from the network stack context.
kenjiArai 0:5b88d5760320 421 *
kenjiArai 0:5b88d5760320 422 * Callback should not take more than 10ms to execute, otherwise it might
kenjiArai 0:5b88d5760320 423 * prevent underlying thread processing. A portable user of the callback
kenjiArai 0:5b88d5760320 424 * should not make calls to network operations due to stack size limitations.
kenjiArai 0:5b88d5760320 425 * The callback should not perform expensive operations such as socket recv/send
kenjiArai 0:5b88d5760320 426 * calls or blocking operations.
kenjiArai 0:5b88d5760320 427 *
kenjiArai 0:5b88d5760320 428 * @return Call in callback
kenjiArai 0:5b88d5760320 429 */
kenjiArai 0:5b88d5760320 430 virtual call_in_callback_cb_t get_call_in_callback();
kenjiArai 0:5b88d5760320 431
kenjiArai 0:5b88d5760320 432 /** Call a callback after a delay
kenjiArai 0:5b88d5760320 433 *
kenjiArai 0:5b88d5760320 434 * Call a callback from the network stack context after a delay. If function
kenjiArai 0:5b88d5760320 435 * returns error callback will not be called.
kenjiArai 0:5b88d5760320 436 *
kenjiArai 0:5b88d5760320 437 * @param delay Delay in milliseconds
kenjiArai 0:5b88d5760320 438 * @param func Callback to be called
kenjiArai 0:5b88d5760320 439 * @return NSAPI_ERROR_OK on success, negative error code on failure
kenjiArai 0:5b88d5760320 440 */
kenjiArai 0:5b88d5760320 441 virtual nsapi_error_t call_in(int delay, mbed::Callback<void()> func);
kenjiArai 0:5b88d5760320 442 };
kenjiArai 0:5b88d5760320 443
kenjiArai 0:5b88d5760320 444 /** Convert a raw nsapi_stack_t object into a C++ NetworkStack object
kenjiArai 0:5b88d5760320 445 *
kenjiArai 0:5b88d5760320 446 * @param stack Reference to an object that can be converted to a stack
kenjiArai 0:5b88d5760320 447 * - A raw nsapi_stack_t object
kenjiArai 0:5b88d5760320 448 * - A reference to a network stack
kenjiArai 0:5b88d5760320 449 * - A reference to a network interface
kenjiArai 0:5b88d5760320 450 * @return Reference to the underlying network stack
kenjiArai 0:5b88d5760320 451 */
kenjiArai 0:5b88d5760320 452 NetworkStack *nsapi_create_stack(nsapi_stack_t *stack);
kenjiArai 0:5b88d5760320 453 NetworkStack *nsapi_create_stack(NetworkStack *stack);
kenjiArai 0:5b88d5760320 454
kenjiArai 0:5b88d5760320 455 template <typename IF>
kenjiArai 0:5b88d5760320 456 NetworkStack *nsapi_create_stack(IF *iface)
kenjiArai 0:5b88d5760320 457 {
kenjiArai 0:5b88d5760320 458 return nsapi_create_stack(static_cast<NetworkInterface *>(iface)->get_stack());
kenjiArai 0:5b88d5760320 459 }
kenjiArai 0:5b88d5760320 460
kenjiArai 0:5b88d5760320 461
kenjiArai 0:5b88d5760320 462 #endif
kenjiArai 0:5b88d5760320 463
kenjiArai 0:5b88d5760320 464 /** @} */