ap
Dependencies: DnsQuery
Dependents: WizFi310_TCP_Echo_Server_Example
Fork of NetworkSocketAPI by
Socket.h
- Committer:
- Christopher Haster
- Date:
- 2016-04-05
- Revision:
- 76:bbe51641f405
- Parent:
- 75:dea0cdb42241
- Child:
- 77:b66a6984ed2d
File content as of revision 76:bbe51641f405:
/* Copyright (C) 2012 mbed.org, MIT License * * Permission is hereby granted, free of charge, to any person obtaining a copy of this software * and associated documentation files (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, publish, distribute, * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all copies or * substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef SOCKET_H #define SOCKET_H /** * @enum ns_error_t * @brief enum of standardized error codes */ enum ns_error_t { NSAPI_ERROR_WOULD_BLOCK = -3001, /*!< no data is not available but call is non-blocking */ NSAPI_ERROR_UNSUPPORTED = -3002, /*!< unsupported configuration */ NSAPI_ERROR_NO_CONNECTION = -3003, /*!< not connected to a network */ NSAPI_ERROR_NO_SOCKET = -3004, /*!< socket not available for use */ NSAPI_ERROR_NO_ADDRESS = -3005, /*!< IP address is not known */ NSAPI_ERROR_NO_MEMORY = -3006, /*!< memory resource not available */ NSAPI_ERROR_DNS_FAILURE = -3007, /*!< DNS failed to complete successfully */ NSAPI_ERROR_DHCP_FAILURE = -3008, /*!< DHCP failed to complete successfully */ NSAPI_ERROR_AUTH_FAILURE = -3009, /*!< connection to access point faield */ NSAPI_ERROR_DEVICE_ERROR = -3010, /*!< failure interfacing with the network procesor */ }; /** * @enum ns_opt_t * @brief enum of available options */ enum ns_opt_t { }; /** Abstract socket class */ class Socket { public: /** Socket lifetime */ Socket(); ~Socket(); /** Set blocking or non-blocking mode of the socket \param blocking true for blocking mode, false for non-blocking mode. */ void set_blocking(bool blocking); /** Set timeout on a socket operation if blocking behaviour is enabled \param timeout timeout in ms */ void set_timeout(unsigned int timeout); /** Set socket options \param optname Option ID \param optval Option value \param optlen Length of the option value \return 0 on success, negative on failure */ int set_option(int optname, const void *optval, unsigned int optlen); /** Get socket options \param optname Option ID \param optval Buffer pointer where to write the option value \param optlen Length of the option value \return 0 on success, negative on failure */ int get_option(int optname, void *optval, unsigned int *optlen); /** Close the socket \param shutdown free the left-over data in message queues */ int close(bool shutdown=true); }; #endif