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