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