NetworkSocketAPI
Dependents: HelloWizFi250Interface
Fork of NetworkSocketAPI by
Socket.h@90:0a988e4abb72, 2016-04-19 (annotated)
- Committer:
- Christopher Haster
- Date:
- Tue Apr 19 18:22:15 2016 -0500
- Revision:
- 90:0a988e4abb72
- Parent:
- 89:b1d417383c0d
- Child:
- 91:cad29ce6a01c
Add open call as alternative to passing NetworkInterface at construction
Pros
- Allows memory to be statically allocated
- Avoids issues with Thread creation before entering main
- Matches existing APIs such as FunctionPointer and Ticker
Cons
- Does not enforce passing a NetworkInterface
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Christopher Haster |
89:b1d417383c0d | 1 | /* Socket |
Christopher Haster |
89:b1d417383c0d | 2 | * Copyright (c) 2015 ARM Limited |
Christopher Haster |
89:b1d417383c0d | 3 | * |
Christopher Haster |
89:b1d417383c0d | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
Christopher Haster |
89:b1d417383c0d | 5 | * you may not use this file except in compliance with the License. |
Christopher Haster |
89:b1d417383c0d | 6 | * You may obtain a copy of the License at |
Christopher Haster |
89:b1d417383c0d | 7 | * |
Christopher Haster |
89:b1d417383c0d | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
Christopher Haster |
89:b1d417383c0d | 9 | * |
Christopher Haster |
89:b1d417383c0d | 10 | * Unless required by applicable law or agreed to in writing, software |
Christopher Haster |
89:b1d417383c0d | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
Christopher Haster |
89:b1d417383c0d | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Christopher Haster |
89:b1d417383c0d | 13 | * See the License for the specific language governing permissions and |
Christopher Haster |
89:b1d417383c0d | 14 | * limitations under the License. |
Christopher Haster |
89:b1d417383c0d | 15 | */ |
Christopher Haster |
89:b1d417383c0d | 16 | |
Christopher Haster |
89:b1d417383c0d | 17 | #ifndef SOCKET_H |
Christopher Haster |
89:b1d417383c0d | 18 | #define SOCKET_H |
Christopher Haster |
89:b1d417383c0d | 19 | |
Christopher Haster |
89:b1d417383c0d | 20 | #include "SocketAddress.h" |
Christopher Haster |
89:b1d417383c0d | 21 | #include "NetworkInterface.h" |
Christopher Haster |
89:b1d417383c0d | 22 | |
Christopher Haster |
89:b1d417383c0d | 23 | /** Abstract socket class |
Christopher Haster |
89:b1d417383c0d | 24 | */ |
Christopher Haster |
89:b1d417383c0d | 25 | class Socket { |
Christopher Haster |
89:b1d417383c0d | 26 | public: |
Christopher Haster |
89:b1d417383c0d | 27 | /** Socket lifetime |
Christopher Haster |
89:b1d417383c0d | 28 | */ |
Christopher Haster |
89:b1d417383c0d | 29 | virtual ~Socket(); |
Christopher Haster |
90:0a988e4abb72 | 30 | |
Christopher Haster |
90:0a988e4abb72 | 31 | /** Open the socket |
Christopher Haster |
90:0a988e4abb72 | 32 | * @param iface Interface to open socket on |
Christopher Haster |
90:0a988e4abb72 | 33 | */ |
Christopher Haster |
90:0a988e4abb72 | 34 | virtual int open(NetworkInterface *iface) = 0; |
Christopher Haster |
89:b1d417383c0d | 35 | |
Christopher Haster |
89:b1d417383c0d | 36 | /** Set blocking or non-blocking mode of the socket |
Christopher Haster |
89:b1d417383c0d | 37 | * @param blocking true for blocking mode, false for non-blocking mode. |
Christopher Haster |
89:b1d417383c0d | 38 | */ |
Christopher Haster |
89:b1d417383c0d | 39 | void set_blocking(bool blocking); |
Christopher Haster |
89:b1d417383c0d | 40 | |
Christopher Haster |
89:b1d417383c0d | 41 | /** Set timeout on a socket operation if blocking behaviour is enabled |
Christopher Haster |
89:b1d417383c0d | 42 | * @param timeout timeout in ms |
Christopher Haster |
89:b1d417383c0d | 43 | */ |
Christopher Haster |
89:b1d417383c0d | 44 | void set_timeout(unsigned int timeout); |
Christopher Haster |
89:b1d417383c0d | 45 | |
Christopher Haster |
89:b1d417383c0d | 46 | /* Set socket options |
Christopher Haster |
89:b1d417383c0d | 47 | * @param optname Option ID |
Christopher Haster |
89:b1d417383c0d | 48 | * @param optval Option value |
Christopher Haster |
89:b1d417383c0d | 49 | * @param optlen Length of the option value |
Christopher Haster |
89:b1d417383c0d | 50 | * @return 0 on success, negative on failure |
Christopher Haster |
89:b1d417383c0d | 51 | */ |
Christopher Haster |
89:b1d417383c0d | 52 | int set_option(int optname, const void *optval, unsigned optlen); |
Christopher Haster |
89:b1d417383c0d | 53 | |
Christopher Haster |
89:b1d417383c0d | 54 | /* Get socket options |
Christopher Haster |
89:b1d417383c0d | 55 | * @param optname Option ID |
Christopher Haster |
89:b1d417383c0d | 56 | * @param optval Buffer pointer where to write the option value |
Christopher Haster |
89:b1d417383c0d | 57 | * @param optlen Length of the option value |
Christopher Haster |
89:b1d417383c0d | 58 | * @return 0 on success, negative on failure |
Christopher Haster |
89:b1d417383c0d | 59 | */ |
Christopher Haster |
89:b1d417383c0d | 60 | int get_option(int optname, void *optval, unsigned *optlen); |
Christopher Haster |
89:b1d417383c0d | 61 | |
Christopher Haster |
89:b1d417383c0d | 62 | /** Close the socket |
Christopher Haster |
89:b1d417383c0d | 63 | * @param shutdown free the left-over data in message queues |
Christopher Haster |
89:b1d417383c0d | 64 | */ |
Christopher Haster |
89:b1d417383c0d | 65 | int close(bool shutdown=true); |
Christopher Haster |
89:b1d417383c0d | 66 | |
Christopher Haster |
89:b1d417383c0d | 67 | protected: |
Christopher Haster |
90:0a988e4abb72 | 68 | Socket(); |
Christopher Haster |
90:0a988e4abb72 | 69 | int open(NetworkInterface *iface, nsapi_protocol_t proto); |
Christopher Haster |
89:b1d417383c0d | 70 | |
Christopher Haster |
89:b1d417383c0d | 71 | static void thunk(void *); |
Christopher Haster |
89:b1d417383c0d | 72 | |
Christopher Haster |
89:b1d417383c0d | 73 | NetworkInterface *_iface; |
Christopher Haster |
89:b1d417383c0d | 74 | void *_socket; |
Christopher Haster |
89:b1d417383c0d | 75 | bool _blocking; |
Christopher Haster |
89:b1d417383c0d | 76 | unsigned _timeout; |
Christopher Haster |
89:b1d417383c0d | 77 | }; |
Christopher Haster |
89:b1d417383c0d | 78 | |
Christopher Haster |
89:b1d417383c0d | 79 | #endif |