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