Samuel Mokrani / WiflyInterface

wifly/socket interface for wifly modules

Dependents:   WiFi neurGAI_WIFI thingspeak thingspeak2

Socket/Endpoint.h@0:6ffb0aeb3972, 2012-08-17 (annotated)

Committer:
samux
Date:
Fri Aug 17 08:28:04 2012 +0000
Revision:
0:6ffb0aeb3972
Child:
3:10b3866f0ea2
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 0:6ffb0aeb3972 1 /* Copyright (C) 2012 mbed.org, MIT License
samux 0:6ffb0aeb3972 2 *
samux 0:6ffb0aeb3972 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 0:6ffb0aeb3972 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
samux 0:6ffb0aeb3972 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
samux 0:6ffb0aeb3972 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
samux 0:6ffb0aeb3972 7 * furnished to do so, subject to the following conditions:
samux 0:6ffb0aeb3972 8 *
samux 0:6ffb0aeb3972 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 0:6ffb0aeb3972 10 * substantial portions of the Software.
samux 0:6ffb0aeb3972 11 *
samux 0:6ffb0aeb3972 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 0:6ffb0aeb3972 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 0:6ffb0aeb3972 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 0:6ffb0aeb3972 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 0:6ffb0aeb3972 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 0:6ffb0aeb3972 17 */
samux 0:6ffb0aeb3972 18 #ifndef ENDPOINT_H
samux 0:6ffb0aeb3972 19 #define ENDPOINT_H
samux 0:6ffb0aeb3972 20
samux 0:6ffb0aeb3972 21
samux 0:6ffb0aeb3972 22 class UDPSocket;
samux 0:6ffb0aeb3972 23
samux 0:6ffb0aeb3972 24 /**
samux 0:6ffb0aeb3972 25 IP Endpoint (address, port)
samux 0:6ffb0aeb3972 26 */
samux 0:6ffb0aeb3972 27 class Endpoint {
samux 0:6ffb0aeb3972 28 friend class UDPSocket;
samux 0:6ffb0aeb3972 29
samux 0:6ffb0aeb3972 30 public:
samux 0:6ffb0aeb3972 31 /** IP Endpoint (address, port)
samux 0:6ffb0aeb3972 32 */
samux 0:6ffb0aeb3972 33 Endpoint(void);
samux 0:6ffb0aeb3972 34
samux 0:6ffb0aeb3972 35 ~Endpoint(void);
samux 0:6ffb0aeb3972 36
samux 0:6ffb0aeb3972 37 /** Reset the address of this endpoint
samux 0:6ffb0aeb3972 38 */
samux 0:6ffb0aeb3972 39 void reset_address(void);
samux 0:6ffb0aeb3972 40
samux 0:6ffb0aeb3972 41 /** Set the address of this endpoint
samux 0:6ffb0aeb3972 42 \param host The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
samux 0:6ffb0aeb3972 43 \param port The endpoint port
samux 0:6ffb0aeb3972 44 \return 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).
samux 0:6ffb0aeb3972 45 */
samux 0:6ffb0aeb3972 46 int set_address(const char* host, const int port);
samux 0:6ffb0aeb3972 47
samux 0:6ffb0aeb3972 48 /** Get the IP address of this endpoint
samux 0:6ffb0aeb3972 49 \return The IP address of this endpoint.
samux 0:6ffb0aeb3972 50 */
samux 0:6ffb0aeb3972 51 char* get_address(void);
samux 0:6ffb0aeb3972 52
samux 0:6ffb0aeb3972 53 /** Get the port of this endpoint
samux 0:6ffb0aeb3972 54 \return The port of this endpoint
samux 0:6ffb0aeb3972 55 */
samux 0:6ffb0aeb3972 56 int get_port(void);
samux 0:6ffb0aeb3972 57
samux 0:6ffb0aeb3972 58 protected:
samux 0:6ffb0aeb3972 59 char _ipAddress[16];
samux 0:6ffb0aeb3972 60 int _port;
samux 0:6ffb0aeb3972 61
samux 0:6ffb0aeb3972 62 };
samux 0:6ffb0aeb3972 63
samux 0:6ffb0aeb3972 64 #endif