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