Fawwaz Nadzmy / ESP8266Interface

Init

Fork of ESP8266Interface by ESP8266

Socket/Endpoint.h@49:dea1054c2af3, 2016-12-21 (annotated)

Committer:
fwndz
Date:
Wed Dec 21 09:04:20 2016 +0000
Revision:
49:dea1054c2af3
Parent:
31:fd0eaf273b11 
Init

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:fb4494783863 1 /* Copyright (C) 2012 mbed.org, MIT License
samux 1:fb4494783863 2 *
samux 1:fb4494783863 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:fb4494783863 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
samux 1:fb4494783863 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
samux 1:fb4494783863 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
samux 1:fb4494783863 7 * furnished to do so, subject to the following conditions:
samux 1:fb4494783863 8 *
samux 1:fb4494783863 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:fb4494783863 10 * substantial portions of the Software.
samux 1:fb4494783863 11 *
samux 1:fb4494783863 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:fb4494783863 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:fb4494783863 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:fb4494783863 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:fb4494783863 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:fb4494783863 17 */
samux 1:fb4494783863 18 #ifndef ENDPOINT_H
samux 1:fb4494783863 19 #define ENDPOINT_H
samux 1:fb4494783863 20
michaeljkoster 13:41098c907200 21 #include "ESP8266.h"
samux 1:fb4494783863 22
samux 1:fb4494783863 23 class UDPSocket;
samux 1:fb4494783863 24
samux 1:fb4494783863 25 /**
samux 1:fb4494783863 26 IP Endpoint (address, port)
samux 1:fb4494783863 27 */
samux 1:fb4494783863 28 class Endpoint {
samux 1:fb4494783863 29 friend class UDPSocket;
samux 1:fb4494783863 30
samux 1:fb4494783863 31 public:
samux 1:fb4494783863 32 /** IP Endpoint (address, port)
samux 1:fb4494783863 33 */
samux 1:fb4494783863 34 Endpoint(void);
samux 1:fb4494783863 35
samux 1:fb4494783863 36 ~Endpoint(void);
samux 1:fb4494783863 37
samux 1:fb4494783863 38 /** Reset the address of this endpoint
samux 1:fb4494783863 39 */
samux 1:fb4494783863 40 void reset_address(void);
samux 1:fb4494783863 41
samux 1:fb4494783863 42 /** Set the address of this endpoint
samux 1:fb4494783863 43 \param host The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
samux 1:fb4494783863 44 \param port The endpoint port
samux 1:fb4494783863 45 \return 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).
samux 1:fb4494783863 46 */
samux 1:fb4494783863 47 int set_address(const char* host, const int port);
samux 1:fb4494783863 48
samux 1:fb4494783863 49 /** Get the IP address of this endpoint
samux 1:fb4494783863 50 \return The IP address of this endpoint.
samux 1:fb4494783863 51 */
samux 1:fb4494783863 52 char* get_address(void);
samux 1:fb4494783863 53
samux 1:fb4494783863 54 /** Get the port of this endpoint
samux 1:fb4494783863 55 \return The port of this endpoint
samux 1:fb4494783863 56 */
samux 1:fb4494783863 57 int get_port(void);
mbedAustin 30:c035696b9397 58
mbedAustin 30:c035696b9397 59 /** Get the id of this endpoint
mbedAustin 30:c035696b9397 60 \return The id of this endpoint
mbedAustin 30:c035696b9397 61 */
mbedAustin 30:c035696b9397 62 int get_id(void);
samux 1:fb4494783863 63
samux 1:fb4494783863 64 protected:
samux 1:fb4494783863 65 char _ipAddress[16];
samux 1:fb4494783863 66 int _port;
mbedAustin 31:fd0eaf273b11 67 int _id;
michaeljkoster 16:3f0efaa57a12 68
michaeljkoster 13:41098c907200 69 ESP8266 * ESP8266;
samux 1:fb4494783863 70 };
samux 1:fb4494783863 71
samux 1:fb4494783863 72 #endif