Endpoint.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 ENDPOINT_H
00019 #define ENDPOINT_H
00020 
00021 #include "ESP8266.h"
00022 
00023 class UDPSocket;
00024 
00025 /**
00026 IP Endpoint (address, port)
00027 */
00028 class Endpoint {
00029     friend class UDPSocket;
00030 
00031 public:
00032     /** IP Endpoint (address, port)
00033      */
00034     Endpoint(void);
00035     
00036     ~Endpoint(void);
00037     
00038     /** Reset the address of this endpoint
00039      */
00040     void reset_address(void);
00041     
00042     /** Set the address of this endpoint
00043     \param host The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
00044     \param port The endpoint port
00045     \return 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).
00046      */
00047     int  set_address(const char* host, const int port);
00048     
00049     /** Get the IP address of this endpoint
00050     \return The IP address of this endpoint.
00051      */
00052     char* get_address(void);
00053     
00054     /** Get the port of this endpoint
00055     \return The port of this endpoint
00056      */
00057     int get_port(void);
00058     
00059     /** Get the id of this endpoint
00060     \return The id of this endpoint
00061      */
00062     int get_id(void);
00063 
00064 protected:
00065     char _ipAddress[64];
00066     int _port;
00067     int _id;
00068     
00069     ESP8266 * ESP8266;
00070 };
00071 
00072 #endif