Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

CC3000/Socket/Socket.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sinrab 0:5464d5e415e5 1 /* Copyright (C) 2013 mbed.org, MIT License
sinrab 0:5464d5e415e5 2 *
sinrab 0:5464d5e415e5 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
sinrab 0:5464d5e415e5 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
sinrab 0:5464d5e415e5 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
sinrab 0:5464d5e415e5 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
sinrab 0:5464d5e415e5 7 * furnished to do so, subject to the following conditions:
sinrab 0:5464d5e415e5 8 *
sinrab 0:5464d5e415e5 9 * The above copyright notice and this permission notice shall be included in all copies or
sinrab 0:5464d5e415e5 10 * substantial portions of the Software.
sinrab 0:5464d5e415e5 11 *
sinrab 0:5464d5e415e5 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
sinrab 0:5464d5e415e5 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
sinrab 0:5464d5e415e5 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
sinrab 0:5464d5e415e5 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
sinrab 0:5464d5e415e5 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
sinrab 0:5464d5e415e5 17 */
sinrab 0:5464d5e415e5 18 #ifndef SOCKET_H
sinrab 0:5464d5e415e5 19 #define SOCKET_H
sinrab 0:5464d5e415e5 20
sinrab 0:5464d5e415e5 21 #include "cc3000.h"
sinrab 0:5464d5e415e5 22
sinrab 0:5464d5e415e5 23 using namespace mbed_cc3000;
sinrab 0:5464d5e415e5 24
sinrab 0:5464d5e415e5 25 class TimeInterval;
sinrab 0:5464d5e415e5 26
sinrab 0:5464d5e415e5 27 /** Socket file descriptor and select wrapper
sinrab 0:5464d5e415e5 28 */
sinrab 0:5464d5e415e5 29 class Socket {
sinrab 0:5464d5e415e5 30 public:
sinrab 0:5464d5e415e5 31 /** Socket
sinrab 0:5464d5e415e5 32 */
sinrab 0:5464d5e415e5 33 Socket();
sinrab 0:5464d5e415e5 34
sinrab 0:5464d5e415e5 35 /** Set blocking or non-blocking mode of the socket and a timeout on
sinrab 0:5464d5e415e5 36 blocking socket operations
sinrab 0:5464d5e415e5 37 \param blocking true for blocking mode, false for non-blocking mode.
sinrab 0:5464d5e415e5 38 \param timeout timeout in ms [Default: (1500)ms].
sinrab 0:5464d5e415e5 39 */
sinrab 0:5464d5e415e5 40 void set_blocking(bool blocking, unsigned int timeout=1500);
sinrab 0:5464d5e415e5 41
sinrab 0:5464d5e415e5 42 /** Set socket options
sinrab 0:5464d5e415e5 43 \param level stack level (see: lwip/sockets.h)
sinrab 0:5464d5e415e5 44 \param optname option ID
sinrab 0:5464d5e415e5 45 \param optval option value
sinrab 0:5464d5e415e5 46 \param socklen_t length of the option value
sinrab 0:5464d5e415e5 47 \return 0 on success, -1 on failure
sinrab 0:5464d5e415e5 48 */
sinrab 0:5464d5e415e5 49 int set_option(int level, int optname, const void *optval, socklen_t optlen);
sinrab 0:5464d5e415e5 50
sinrab 0:5464d5e415e5 51 /** Get socket options
sinrab 0:5464d5e415e5 52 \param level stack level (see: lwip/sockets.h)
sinrab 0:5464d5e415e5 53 \param optname option ID
sinrab 0:5464d5e415e5 54 \param optval buffer pointer where to write the option value
sinrab 0:5464d5e415e5 55 \param socklen_t length of the option value
sinrab 0:5464d5e415e5 56 \return 0 on success, -1 on failure
sinrab 0:5464d5e415e5 57 */
sinrab 0:5464d5e415e5 58 int get_option(int level, int optname, void *optval, socklen_t *optlen);
sinrab 0:5464d5e415e5 59
sinrab 0:5464d5e415e5 60
sinrab 0:5464d5e415e5 61 /** Close the socket file descriptor
sinrab 0:5464d5e415e5 62 */
sinrab 0:5464d5e415e5 63 int close();
sinrab 0:5464d5e415e5 64
sinrab 0:5464d5e415e5 65 ~Socket();
sinrab 0:5464d5e415e5 66
sinrab 0:5464d5e415e5 67 protected:
sinrab 0:5464d5e415e5 68 int _sock_fd;
sinrab 0:5464d5e415e5 69
sinrab 0:5464d5e415e5 70 int init_socket(int type, int protocol);
sinrab 0:5464d5e415e5 71
sinrab 0:5464d5e415e5 72 int wait_readable(TimeInterval& timeout);
sinrab 0:5464d5e415e5 73 int wait_writable(TimeInterval& timeout);
sinrab 0:5464d5e415e5 74
sinrab 0:5464d5e415e5 75 bool _blocking;
sinrab 0:5464d5e415e5 76 int _timeout;
sinrab 0:5464d5e415e5 77
sinrab 0:5464d5e415e5 78 cc3000 *_cc3000_module;
sinrab 0:5464d5e415e5 79 private:
sinrab 0:5464d5e415e5 80 int select(struct timeval *timeout, bool read, bool write);
sinrab 0:5464d5e415e5 81 };
sinrab 0:5464d5e415e5 82
sinrab 0:5464d5e415e5 83 /** Time interval class used to specify timeouts
sinrab 0:5464d5e415e5 84 */
sinrab 0:5464d5e415e5 85 class TimeInterval {
sinrab 0:5464d5e415e5 86 friend class Socket;
sinrab 0:5464d5e415e5 87
sinrab 0:5464d5e415e5 88 public:
sinrab 0:5464d5e415e5 89 /** Time Interval
sinrab 0:5464d5e415e5 90 \param ms time interval expressed in milliseconds
sinrab 0:5464d5e415e5 91 */
sinrab 0:5464d5e415e5 92 TimeInterval(unsigned int ms);
sinrab 0:5464d5e415e5 93
sinrab 0:5464d5e415e5 94 private:
sinrab 0:5464d5e415e5 95 struct timeval _time;
sinrab 0:5464d5e415e5 96 };
sinrab 0:5464d5e415e5 97
sinrab 0:5464d5e415e5 98 #endif /* SOCKET_H */
sinrab 0:5464d5e415e5 99