Clément BENOIT / Socket

fort Socket

Fork of Socket by mbed official

Endpoint.h@8:9cf9c2d45264, 2012-07-27 (annotated)

Committer:
emilmont
Date:
Fri Jul 27 15:50:23 2012 +0000
Revision:
8:9cf9c2d45264
Parent:
5:300e7ad2dc1d
Child:
11:3d83c348fb8b
Update documentation

Who changed what in which revision?

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