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  * Changes relative to mbed official version and others as identified
00019  * in the thread http://mbed.org/forum/team-165-components-community/topic/4844/?page=1#comment-24108
00020  * Endpoint:
00021  * @li Improve documentation
00022  * @li derived from 4:0bcec6272784
00023  */
00024 #ifndef ENDPOINT_H
00025 #define ENDPOINT_H
00026 
00027 #include "Wifly.h"
00028 
00029 class UDPSocket;
00030 
00031 /**
00032 IP Endpoint (address, port)
00033 */
00034 class Endpoint {
00035     friend class UDPSocket;
00036 
00037 public:
00038     /** IP Endpoint (address, port)
00039      */
00040     Endpoint(void);
00041     
00042     ~Endpoint(void);
00043     
00044     /** Reset the address of this endpoint
00045      */
00046     void reset_address(void);
00047     
00048     /** Set the address of this endpoint
00049     @param host The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
00050     @param port The endpoint port
00051     @return 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).
00052      */
00053     int  set_address(const char* host, const int port);
00054     
00055     /** Get the IP address of this endpoint
00056     @return The IP address of this endpoint.
00057      */
00058     char* get_address(void);
00059     
00060     /** Get the port of this endpoint
00061     @return The port of this endpoint
00062      */
00063     int get_port(void);
00064 
00065 protected:
00066     char _ipAddress[16];
00067     int _port;
00068     Wifly * wifly;
00069 };
00070 
00071 #endif