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 Murata Manufacturing Co.,Ltd., MIT License
00019  *  port to the muRata, SWITCH SCIENCE Wi-FI module TypeYD SNIC-UART.
00020  */
00021 #ifndef ENDPOINT_H
00022 #define ENDPOINT_H
00023 
00024 class UDPSocket;
00025 
00026 /**
00027 IP Endpoint (address, port)
00028 */
00029 class Endpoint {
00030     friend class UDPSocket;
00031 
00032 public:
00033     /** IP Endpoint (address, port)
00034      */
00035     Endpoint(void);
00036     
00037     ~Endpoint(void);
00038     
00039     /** Reset the address of this endpoint
00040      */
00041     void reset_address(void);
00042     
00043     /** Set the address of this endpoint
00044     \param host_p The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
00045     \param port The endpoint port
00046     \return 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).
00047      */
00048     int  set_address(const char* host_p, const int port);
00049     
00050     /** Get the IP address of this endpoint
00051     \return The IP address of this endpoint.
00052      */
00053     char* get_address(void);
00054     
00055     /** Get the port of this endpoint
00056     \return The port of this endpoint
00057      */
00058     int get_port(void);
00059 
00060 protected:
00061     char mIpAddress[17];
00062     int  mPort;
00063 //    struct sockaddr_in _remoteHost;
00064 
00065 };
00066 #endif