Wayne Jay / EthernetInterface

Onenet

Dependents:   K64F_eCompass_OneNET_JW

Socket/Endpoint.h@0:b2805b6888dc, 2016-06-20 (annotated)

Committer:
robert_jw
Date:
Mon Jun 20 01:40:20 2016 +0000
Revision:
0:b2805b6888dc
ADS

Who changed what in which revision?

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