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