GSwifiInterface library (interface for GainSpan Wi-Fi GS1011 modules) Please see https://mbed.org/users/gsfan/notebook/GSwifiInterface/

Dependents:   GSwifiInterface_HelloWorld GSwifiInterface_HelloServo GSwifiInterface_UDPEchoServer GSwifiInterface_UDPEchoClient ... more

Fork of WiflyInterface by mbed official

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers Endpoint.h Source File

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