Socket.h

00001 /* Copyright (C) 2012 mbed.org, MIT License
00002  *
00003  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00005  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00006  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00007  * furnished to do so, subject to the following conditions:
00008  *
00009  * The above copyright notice and this permission notice shall be included in all copies or
00010  * substantial portions of the Software.
00011  *
00012  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017  */
00018 #ifndef SOCKET_H_
00019 #define SOCKET_H_
00020 
00021 #include "lwip/sockets.h"
00022 #include "lwip/netdb.h"
00023 
00024 #if LWIP_DNS
00025 //DNS
00026 inline struct hostent *gethostbyname(const char *name) {
00027   return lwip_gethostbyname(name);
00028 }
00029 
00030 inline int gethostbyname_r(const char *name, struct hostent *ret, char *buf, size_t buflen, struct hostent **result, int *h_errnop) {
00031   return lwip_gethostbyname_r(name, ret, buf, buflen, result, h_errnop);
00032 }
00033 #endif
00034 
00035 class TimeInterval;
00036 
00037 /** Socket file descriptor and select wrapper
00038   */
00039 class Socket {
00040 public:
00041     /** Socket
00042      */
00043     Socket();
00044     
00045     /** Set blocking or non-blocking mode of the socket and a timeout on
00046         blocking socket operations
00047     \param blocking  true for blocking mode, false for non-blocking mode.
00048     \param timeout   timeout in ms [Default: (1500)ms].
00049     */
00050     void set_blocking(bool blocking, unsigned int timeout=1500);
00051     
00052     /** Set socket options
00053     \param level     stack level (see: lwip/sockets.h)
00054     \param optname   option ID
00055     \param optval    option value
00056     \param socklen_t length of the option value
00057     \return 0 on success, -1 on failure
00058     */
00059     int set_option(int level, int optname, const void *optval, socklen_t optlen);
00060     
00061     /** Get socket options
00062         \param level     stack level (see: lwip/sockets.h)
00063         \param optname   option ID
00064         \param optval    buffer pointer where to write the option value
00065         \param socklen_t length of the option value
00066         \return 0 on success, -1 on failure
00067         */
00068     int get_option(int level, int optname, void *optval, socklen_t *optlen);
00069     
00070     /** Close the socket
00071         \param shutdown   free the left-over data in message queues
00072      */
00073     int close(bool shutdown=true);
00074     
00075     ~Socket();
00076     
00077 protected:
00078     int _sock_fd;
00079     int init_socket(int type);
00080     
00081     int wait_readable(TimeInterval& timeout);
00082     int wait_writable(TimeInterval& timeout);
00083     
00084     bool _blocking;
00085     unsigned int _timeout;
00086     
00087 private:
00088     int select(struct timeval *timeout, bool read, bool write);
00089 };
00090 
00091 /** Time interval class used to specify timeouts
00092  */
00093 class TimeInterval {
00094     friend class Socket;
00095 
00096 public:
00097     /** Time Interval
00098      \param ms time interval expressed in milliseconds
00099       */
00100     TimeInterval(unsigned int ms);
00101     
00102 private:
00103     struct timeval _time;
00104 };
00105 
00106 #endif /* SOCKET_H_ */