ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Explain default port number, and construction

pull/8512/head
Conrad Braam 2018-10-23 15:01:28 +01:00
parent ba23fef90b
commit e919511d98
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
features/netsocket/SocketAddress.h
View File

@ -42,7 +42,7 @@ public:
* *
* @param stack Network stack to use for DNS resolution * @param stack Network stack to use for DNS resolution
* @param host Hostname to resolve * @param host Hostname to resolve
* @param port Optional 16-bit port * @param port Optional 16-bit port, defaults to 0
* @deprecated * @deprecated
* Constructors hide possible errors. Replaced by * Constructors hide possible errors. Replaced by
* NetworkInterface::gethostbyname. * NetworkInterface::gethostbyname.
@ -57,16 +57,18 @@ public:
} }
/** Create a SocketAddress from a raw IP address and port /** Create a SocketAddress from a raw IP address and port
*
* To construct from a host name use NetworkInterface::gethostbyname
* *
* @param addr Raw IP address * @param addr Raw IP address
* @param port Optional 16-bit port * @param port Optional 16-bit port, defaults to 0
*/ */
SocketAddress(nsapi_addr_t addr = nsapi_addr_t(), uint16_t port = 0); SocketAddress(nsapi_addr_t addr = nsapi_addr_t(), uint16_t port = 0);
/** Create a SocketAddress from an IP address and port /** Create a SocketAddress from an IP address and port
* *
* @param addr Null-terminated representation of the IP address * @param addr Null-terminated representation of the IP address
* @param port Optional 16-bit port * @param port Optional 16-bit port, defaults to 0
*/ */
SocketAddress(const char *addr, uint16_t port = 0); SocketAddress(const char *addr, uint16_t port = 0);
@ -74,7 +76,7 @@ public:
* *
* @param bytes Raw IP address in big-endian order * @param bytes Raw IP address in big-endian order
* @param version IP address version, NSAPI_IPv4 or NSAPI_IPv6 * @param version IP address version, NSAPI_IPv4 or NSAPI_IPv6
* @param port Optional 16-bit port * @param port Optional 16-bit port, defaults to 0
*/ */
SocketAddress(const void *bytes, nsapi_version_t version, uint16_t port = 0); SocketAddress(const void *bytes, nsapi_version_t version, uint16_t port = 0);