Marco Mayer / Mbed OS Queue

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/features/netsocket/NetworkStack.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1
demayer 0:6bf0743ece18 2 /* NetworkStack
demayer 0:6bf0743ece18 3 * Copyright (c) 2015 ARM Limited
demayer 0:6bf0743ece18 4 *
demayer 0:6bf0743ece18 5 * Licensed under the Apache License, Version 2.0 (the "License");
demayer 0:6bf0743ece18 6 * you may not use this file except in compliance with the License.
demayer 0:6bf0743ece18 7 * You may obtain a copy of the License at
demayer 0:6bf0743ece18 8 *
demayer 0:6bf0743ece18 9 * http://www.apache.org/licenses/LICENSE-2.0
demayer 0:6bf0743ece18 10 *
demayer 0:6bf0743ece18 11 * Unless required by applicable law or agreed to in writing, software
demayer 0:6bf0743ece18 12 * distributed under the License is distributed on an "AS IS" BASIS,
demayer 0:6bf0743ece18 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
demayer 0:6bf0743ece18 14 * See the License for the specific language governing permissions and
demayer 0:6bf0743ece18 15 * limitations under the License.
demayer 0:6bf0743ece18 16 */
demayer 0:6bf0743ece18 17
demayer 0:6bf0743ece18 18 #ifndef NETWORK_STACK_H
demayer 0:6bf0743ece18 19 #define NETWORK_STACK_H
demayer 0:6bf0743ece18 20
demayer 0:6bf0743ece18 21 #include "nsapi_types.h"
demayer 0:6bf0743ece18 22 #include "netsocket/SocketAddress.h"
demayer 0:6bf0743ece18 23 #include "netsocket/NetworkInterface.h"
demayer 0:6bf0743ece18 24
demayer 0:6bf0743ece18 25
demayer 0:6bf0743ece18 26 /** NetworkStack class
demayer 0:6bf0743ece18 27 *
demayer 0:6bf0743ece18 28 * Common interface that is shared between hardware that
demayer 0:6bf0743ece18 29 * can connect to a network over IP. By implementing the
demayer 0:6bf0743ece18 30 * NetworkStack, a network stack can be used as a target
demayer 0:6bf0743ece18 31 * for instantiating network sockets.
demayer 0:6bf0743ece18 32 * @addtogroup netsocket
demayer 0:6bf0743ece18 33 */
demayer 0:6bf0743ece18 34 class NetworkStack
demayer 0:6bf0743ece18 35 {
demayer 0:6bf0743ece18 36 public:
demayer 0:6bf0743ece18 37 virtual ~NetworkStack() {};
demayer 0:6bf0743ece18 38
demayer 0:6bf0743ece18 39 /** Get the local IP address
demayer 0:6bf0743ece18 40 *
demayer 0:6bf0743ece18 41 * @return Null-terminated representation of the local IP address
demayer 0:6bf0743ece18 42 * or null if not yet connected
demayer 0:6bf0743ece18 43 */
demayer 0:6bf0743ece18 44 virtual const char *get_ip_address() = 0;
demayer 0:6bf0743ece18 45
demayer 0:6bf0743ece18 46 /** Translates a hostname to an IP address with specific version
demayer 0:6bf0743ece18 47 *
demayer 0:6bf0743ece18 48 * The hostname may be either a domain name or an IP address. If the
demayer 0:6bf0743ece18 49 * hostname is an IP address, no network transactions will be performed.
demayer 0:6bf0743ece18 50 *
demayer 0:6bf0743ece18 51 * If no stack-specific DNS resolution is provided, the hostname
demayer 0:6bf0743ece18 52 * will be resolve using a UDP socket on the stack.
demayer 0:6bf0743ece18 53 *
demayer 0:6bf0743ece18 54 * @param host Hostname to resolve
demayer 0:6bf0743ece18 55 * @param address Destination for the host SocketAddress
demayer 0:6bf0743ece18 56 * @param version IP version of address to resolve, NSAPI_UNSPEC indicates
demayer 0:6bf0743ece18 57 * version is chosen by the stack (defaults to NSAPI_UNSPEC)
demayer 0:6bf0743ece18 58 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 59 */
demayer 0:6bf0743ece18 60 virtual nsapi_error_t gethostbyname(const char *host,
demayer 0:6bf0743ece18 61 SocketAddress *address, nsapi_version_t version = NSAPI_UNSPEC);
demayer 0:6bf0743ece18 62
demayer 0:6bf0743ece18 63 /** Add a domain name server to list of servers to query
demayer 0:6bf0743ece18 64 *
demayer 0:6bf0743ece18 65 * @param address Destination for the host address
demayer 0:6bf0743ece18 66 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 67 */
demayer 0:6bf0743ece18 68 virtual nsapi_error_t add_dns_server(const SocketAddress &address);
demayer 0:6bf0743ece18 69
demayer 0:6bf0743ece18 70 /* Set stack options
demayer 0:6bf0743ece18 71 *
demayer 0:6bf0743ece18 72 * setstackopt allows an application to pass stack-specific options
demayer 0:6bf0743ece18 73 * to the underlying stack using stack-specific level and option names,
demayer 0:6bf0743ece18 74 * or to request generic options using levels from nsapi_stack_level_t.
demayer 0:6bf0743ece18 75 *
demayer 0:6bf0743ece18 76 * For unsupported options, NSAPI_ERROR_UNSUPPORTED is returned
demayer 0:6bf0743ece18 77 * and the stack is unmodified.
demayer 0:6bf0743ece18 78 *
demayer 0:6bf0743ece18 79 * @param level Stack-specific protocol level or nsapi_stack_level_t
demayer 0:6bf0743ece18 80 * @param optname Level-specific option name
demayer 0:6bf0743ece18 81 * @param optval Option value
demayer 0:6bf0743ece18 82 * @param optlen Length of the option value
demayer 0:6bf0743ece18 83 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 84 */
demayer 0:6bf0743ece18 85 virtual nsapi_error_t setstackopt(int level, int optname, const void *optval, unsigned optlen);
demayer 0:6bf0743ece18 86
demayer 0:6bf0743ece18 87 /* Get stack options
demayer 0:6bf0743ece18 88 *
demayer 0:6bf0743ece18 89 * getstackopt allows an application to retrieve stack-specific options
demayer 0:6bf0743ece18 90 * to the underlying stack using stack-specific level and option names,
demayer 0:6bf0743ece18 91 * or to request generic options using levels from nsapi_stack_level_t.
demayer 0:6bf0743ece18 92 *
demayer 0:6bf0743ece18 93 * @param level Stack-specific protocol level or nsapi_stack_level_t
demayer 0:6bf0743ece18 94 * @param optname Level-specific option name
demayer 0:6bf0743ece18 95 * @param optval Destination for option value
demayer 0:6bf0743ece18 96 * @param optlen Length of the option value
demayer 0:6bf0743ece18 97 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 98 */
demayer 0:6bf0743ece18 99 virtual nsapi_error_t getstackopt(int level, int optname, void *optval, unsigned *optlen);
demayer 0:6bf0743ece18 100
demayer 0:6bf0743ece18 101 protected:
demayer 0:6bf0743ece18 102 friend class Socket;
demayer 0:6bf0743ece18 103 friend class UDPSocket;
demayer 0:6bf0743ece18 104 friend class TCPSocket;
demayer 0:6bf0743ece18 105 friend class TCPServer;
demayer 0:6bf0743ece18 106
demayer 0:6bf0743ece18 107 /** Opens a socket
demayer 0:6bf0743ece18 108 *
demayer 0:6bf0743ece18 109 * Creates a network socket and stores it in the specified handle.
demayer 0:6bf0743ece18 110 * The handle must be passed to following calls on the socket.
demayer 0:6bf0743ece18 111 *
demayer 0:6bf0743ece18 112 * A stack may have a finite number of sockets, in this case
demayer 0:6bf0743ece18 113 * NSAPI_ERROR_NO_SOCKET is returned if no socket is available.
demayer 0:6bf0743ece18 114 *
demayer 0:6bf0743ece18 115 * @param handle Destination for the handle to a newly created socket
demayer 0:6bf0743ece18 116 * @param proto Protocol of socket to open, NSAPI_TCP or NSAPI_UDP
demayer 0:6bf0743ece18 117 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 118 */
demayer 0:6bf0743ece18 119 virtual nsapi_error_t socket_open(nsapi_socket_t *handle, nsapi_protocol_t proto) = 0;
demayer 0:6bf0743ece18 120
demayer 0:6bf0743ece18 121 /** Close the socket
demayer 0:6bf0743ece18 122 *
demayer 0:6bf0743ece18 123 * Closes any open connection and deallocates any memory associated
demayer 0:6bf0743ece18 124 * with the socket.
demayer 0:6bf0743ece18 125 *
demayer 0:6bf0743ece18 126 * @param handle Socket handle
demayer 0:6bf0743ece18 127 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 128 */
demayer 0:6bf0743ece18 129 virtual nsapi_error_t socket_close(nsapi_socket_t handle) = 0;
demayer 0:6bf0743ece18 130
demayer 0:6bf0743ece18 131 /** Bind a specific address to a socket
demayer 0:6bf0743ece18 132 *
demayer 0:6bf0743ece18 133 * Binding a socket specifies the address and port on which to recieve
demayer 0:6bf0743ece18 134 * data. If the IP address is zeroed, only the port is bound.
demayer 0:6bf0743ece18 135 *
demayer 0:6bf0743ece18 136 * @param handle Socket handle
demayer 0:6bf0743ece18 137 * @param address Local address to bind
demayer 0:6bf0743ece18 138 * @return 0 on success, negative error code on failure.
demayer 0:6bf0743ece18 139 */
demayer 0:6bf0743ece18 140 virtual nsapi_error_t socket_bind(nsapi_socket_t handle, const SocketAddress &address) = 0;
demayer 0:6bf0743ece18 141
demayer 0:6bf0743ece18 142 /** Listen for connections on a TCP socket
demayer 0:6bf0743ece18 143 *
demayer 0:6bf0743ece18 144 * Marks the socket as a passive socket that can be used to accept
demayer 0:6bf0743ece18 145 * incoming connections.
demayer 0:6bf0743ece18 146 *
demayer 0:6bf0743ece18 147 * @param handle Socket handle
demayer 0:6bf0743ece18 148 * @param backlog Number of pending connections that can be queued
demayer 0:6bf0743ece18 149 * simultaneously
demayer 0:6bf0743ece18 150 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 151 */
demayer 0:6bf0743ece18 152 virtual nsapi_error_t socket_listen(nsapi_socket_t handle, int backlog) = 0;
demayer 0:6bf0743ece18 153
demayer 0:6bf0743ece18 154 /** Connects TCP socket to a remote host
demayer 0:6bf0743ece18 155 *
demayer 0:6bf0743ece18 156 * Initiates a connection to a remote server specified by the
demayer 0:6bf0743ece18 157 * indicated address.
demayer 0:6bf0743ece18 158 *
demayer 0:6bf0743ece18 159 * @param handle Socket handle
demayer 0:6bf0743ece18 160 * @param address The SocketAddress of the remote host
demayer 0:6bf0743ece18 161 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 162 */
demayer 0:6bf0743ece18 163 virtual nsapi_error_t socket_connect(nsapi_socket_t handle, const SocketAddress &address) = 0;
demayer 0:6bf0743ece18 164
demayer 0:6bf0743ece18 165 /** Accepts a connection on a TCP socket
demayer 0:6bf0743ece18 166 *
demayer 0:6bf0743ece18 167 * The server socket must be bound and set to listen for connections.
demayer 0:6bf0743ece18 168 * On a new connection, creates a network socket and stores it in the
demayer 0:6bf0743ece18 169 * specified handle. The handle must be passed to following calls on
demayer 0:6bf0743ece18 170 * the socket.
demayer 0:6bf0743ece18 171 *
demayer 0:6bf0743ece18 172 * A stack may have a finite number of sockets, in this case
demayer 0:6bf0743ece18 173 * NSAPI_ERROR_NO_SOCKET is returned if no socket is available.
demayer 0:6bf0743ece18 174 *
demayer 0:6bf0743ece18 175 * This call is non-blocking. If accept would block,
demayer 0:6bf0743ece18 176 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
demayer 0:6bf0743ece18 177 *
demayer 0:6bf0743ece18 178 * @param server Socket handle to server to accept from
demayer 0:6bf0743ece18 179 * @param handle Destination for a handle to the newly created socket
demayer 0:6bf0743ece18 180 * @param address Destination for the remote address or NULL
demayer 0:6bf0743ece18 181 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 182 */
demayer 0:6bf0743ece18 183 virtual nsapi_error_t socket_accept(nsapi_socket_t server,
demayer 0:6bf0743ece18 184 nsapi_socket_t *handle, SocketAddress *address=0) = 0;
demayer 0:6bf0743ece18 185
demayer 0:6bf0743ece18 186 /** Send data over a TCP socket
demayer 0:6bf0743ece18 187 *
demayer 0:6bf0743ece18 188 * The socket must be connected to a remote host. Returns the number of
demayer 0:6bf0743ece18 189 * bytes sent from the buffer.
demayer 0:6bf0743ece18 190 *
demayer 0:6bf0743ece18 191 * This call is non-blocking. If send would block,
demayer 0:6bf0743ece18 192 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
demayer 0:6bf0743ece18 193 *
demayer 0:6bf0743ece18 194 * @param handle Socket handle
demayer 0:6bf0743ece18 195 * @param data Buffer of data to send to the host
demayer 0:6bf0743ece18 196 * @param size Size of the buffer in bytes
demayer 0:6bf0743ece18 197 * @return Number of sent bytes on success, negative error
demayer 0:6bf0743ece18 198 * code on failure
demayer 0:6bf0743ece18 199 */
demayer 0:6bf0743ece18 200 virtual nsapi_size_or_error_t socket_send(nsapi_socket_t handle,
demayer 0:6bf0743ece18 201 const void *data, nsapi_size_t size) = 0;
demayer 0:6bf0743ece18 202
demayer 0:6bf0743ece18 203 /** Receive data over a TCP socket
demayer 0:6bf0743ece18 204 *
demayer 0:6bf0743ece18 205 * The socket must be connected to a remote host. Returns the number of
demayer 0:6bf0743ece18 206 * bytes received into the buffer.
demayer 0:6bf0743ece18 207 *
demayer 0:6bf0743ece18 208 * This call is non-blocking. If recv would block,
demayer 0:6bf0743ece18 209 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
demayer 0:6bf0743ece18 210 *
demayer 0:6bf0743ece18 211 * @param handle Socket handle
demayer 0:6bf0743ece18 212 * @param data Destination buffer for data received from the host
demayer 0:6bf0743ece18 213 * @param size Size of the buffer in bytes
demayer 0:6bf0743ece18 214 * @return Number of received bytes on success, negative error
demayer 0:6bf0743ece18 215 * code on failure
demayer 0:6bf0743ece18 216 */
demayer 0:6bf0743ece18 217 virtual nsapi_size_or_error_t socket_recv(nsapi_socket_t handle,
demayer 0:6bf0743ece18 218 void *data, nsapi_size_t size) = 0;
demayer 0:6bf0743ece18 219
demayer 0:6bf0743ece18 220 /** Send a packet over a UDP socket
demayer 0:6bf0743ece18 221 *
demayer 0:6bf0743ece18 222 * Sends data to the specified address. Returns the number of bytes
demayer 0:6bf0743ece18 223 * sent from the buffer.
demayer 0:6bf0743ece18 224 *
demayer 0:6bf0743ece18 225 * This call is non-blocking. If sendto would block,
demayer 0:6bf0743ece18 226 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
demayer 0:6bf0743ece18 227 *
demayer 0:6bf0743ece18 228 * @param handle Socket handle
demayer 0:6bf0743ece18 229 * @param address The SocketAddress of the remote host
demayer 0:6bf0743ece18 230 * @param data Buffer of data to send to the host
demayer 0:6bf0743ece18 231 * @param size Size of the buffer in bytes
demayer 0:6bf0743ece18 232 * @return Number of sent bytes on success, negative error
demayer 0:6bf0743ece18 233 * code on failure
demayer 0:6bf0743ece18 234 */
demayer 0:6bf0743ece18 235 virtual nsapi_size_or_error_t socket_sendto(nsapi_socket_t handle, const SocketAddress &address,
demayer 0:6bf0743ece18 236 const void *data, nsapi_size_t size) = 0;
demayer 0:6bf0743ece18 237
demayer 0:6bf0743ece18 238 /** Receive a packet over a UDP socket
demayer 0:6bf0743ece18 239 *
demayer 0:6bf0743ece18 240 * Receives data and stores the source address in address if address
demayer 0:6bf0743ece18 241 * is not NULL. Returns the number of bytes received into the buffer.
demayer 0:6bf0743ece18 242 *
demayer 0:6bf0743ece18 243 * This call is non-blocking. If recvfrom would block,
demayer 0:6bf0743ece18 244 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
demayer 0:6bf0743ece18 245 *
demayer 0:6bf0743ece18 246 * @param handle Socket handle
demayer 0:6bf0743ece18 247 * @param address Destination for the source address or NULL
demayer 0:6bf0743ece18 248 * @param buffer Destination buffer for data received from the host
demayer 0:6bf0743ece18 249 * @param size Size of the buffer in bytes
demayer 0:6bf0743ece18 250 * @return Number of received bytes on success, negative error
demayer 0:6bf0743ece18 251 * code on failure
demayer 0:6bf0743ece18 252 */
demayer 0:6bf0743ece18 253 virtual nsapi_size_or_error_t socket_recvfrom(nsapi_socket_t handle, SocketAddress *address,
demayer 0:6bf0743ece18 254 void *buffer, nsapi_size_t size) = 0;
demayer 0:6bf0743ece18 255
demayer 0:6bf0743ece18 256 /** Register a callback on state change of the socket
demayer 0:6bf0743ece18 257 *
demayer 0:6bf0743ece18 258 * The specified callback will be called on state changes such as when
demayer 0:6bf0743ece18 259 * the socket can recv/send/accept successfully and on when an error
demayer 0:6bf0743ece18 260 * occurs. The callback may also be called spuriously without reason.
demayer 0:6bf0743ece18 261 *
demayer 0:6bf0743ece18 262 * The callback may be called in an interrupt context and should not
demayer 0:6bf0743ece18 263 * perform expensive operations such as recv/send calls.
demayer 0:6bf0743ece18 264 *
demayer 0:6bf0743ece18 265 * @param handle Socket handle
demayer 0:6bf0743ece18 266 * @param callback Function to call on state change
demayer 0:6bf0743ece18 267 * @param data Argument to pass to callback
demayer 0:6bf0743ece18 268 */
demayer 0:6bf0743ece18 269 virtual void socket_attach(nsapi_socket_t handle, void (*callback)(void *), void *data) = 0;
demayer 0:6bf0743ece18 270
demayer 0:6bf0743ece18 271 /* Set stack-specific socket options
demayer 0:6bf0743ece18 272 *
demayer 0:6bf0743ece18 273 * The setsockopt allow an application to pass stack-specific hints
demayer 0:6bf0743ece18 274 * to the underlying stack. For unsupported options,
demayer 0:6bf0743ece18 275 * NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.
demayer 0:6bf0743ece18 276 *
demayer 0:6bf0743ece18 277 * @param handle Socket handle
demayer 0:6bf0743ece18 278 * @param level Stack-specific protocol level
demayer 0:6bf0743ece18 279 * @param optname Stack-specific option identifier
demayer 0:6bf0743ece18 280 * @param optval Option value
demayer 0:6bf0743ece18 281 * @param optlen Length of the option value
demayer 0:6bf0743ece18 282 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 283 */
demayer 0:6bf0743ece18 284 virtual nsapi_error_t setsockopt(nsapi_socket_t handle, int level,
demayer 0:6bf0743ece18 285 int optname, const void *optval, unsigned optlen);
demayer 0:6bf0743ece18 286
demayer 0:6bf0743ece18 287 /* Get stack-specific socket options
demayer 0:6bf0743ece18 288 *
demayer 0:6bf0743ece18 289 * The getstackopt allow an application to retrieve stack-specific hints
demayer 0:6bf0743ece18 290 * from the underlying stack. For unsupported options,
demayer 0:6bf0743ece18 291 * NSAPI_ERROR_UNSUPPORTED is returned and optval is unmodified.
demayer 0:6bf0743ece18 292 *
demayer 0:6bf0743ece18 293 * @param handle Socket handle
demayer 0:6bf0743ece18 294 * @param level Stack-specific protocol level
demayer 0:6bf0743ece18 295 * @param optname Stack-specific option identifier
demayer 0:6bf0743ece18 296 * @param optval Destination for option value
demayer 0:6bf0743ece18 297 * @param optlen Length of the option value
demayer 0:6bf0743ece18 298 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 299 */
demayer 0:6bf0743ece18 300 virtual nsapi_error_t getsockopt(nsapi_socket_t handle, int level,
demayer 0:6bf0743ece18 301 int optname, void *optval, unsigned *optlen);
demayer 0:6bf0743ece18 302 };
demayer 0:6bf0743ece18 303
demayer 0:6bf0743ece18 304
demayer 0:6bf0743ece18 305 /** Convert a raw nsapi_stack_t object into a C++ NetworkStack object
demayer 0:6bf0743ece18 306 *
demayer 0:6bf0743ece18 307 * @param stack Reference to an object that can be converted to a stack
demayer 0:6bf0743ece18 308 * - A raw nsapi_stack_t object
demayer 0:6bf0743ece18 309 * - A reference to a network stack
demayer 0:6bf0743ece18 310 * - A reference to a network interface
demayer 0:6bf0743ece18 311 * @return Reference to the underlying network stack
demayer 0:6bf0743ece18 312 */
demayer 0:6bf0743ece18 313 NetworkStack *nsapi_create_stack(nsapi_stack_t *stack);
demayer 0:6bf0743ece18 314 NetworkStack *nsapi_create_stack(NetworkStack *stack);
demayer 0:6bf0743ece18 315
demayer 0:6bf0743ece18 316 template <typename IF>
demayer 0:6bf0743ece18 317 NetworkStack *nsapi_create_stack(IF *iface)
demayer 0:6bf0743ece18 318 {
demayer 0:6bf0743ece18 319 return nsapi_create_stack(static_cast<NetworkInterface *>(iface)->get_stack());
demayer 0:6bf0743ece18 320 }
demayer 0:6bf0743ece18 321
demayer 0:6bf0743ece18 322
demayer 0:6bf0743ece18 323 #endif