Endpoint.h

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