Skip to content

Commit 975be7b

Browse files
Cruz Monrreal IICruz Monrreal II
authored andcommitted
Merge branch 'conbra01/docaton_networksocket' of ssh://github.com/ConradBraam/mbed-os into rollup
2 parents 2393b0b + 0a82253 commit 975be7b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

features/netsocket/SocketAddress.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class SocketAddress {
4242
*
4343
* @param stack Network stack to use for DNS resolution
4444
* @param host Hostname to resolve
45-
* @param port Optional 16-bit port
45+
* @param port Optional 16-bit port, defaults to 0
4646
* @deprecated
4747
* Constructors hide possible errors. Replaced by
4848
* NetworkInterface::gethostbyname.
@@ -57,24 +57,26 @@ class SocketAddress {
5757
}
5858

5959
/** Create a SocketAddress from a raw IP address and port
60+
*
61+
* To construct from a host name, use NetworkInterface::gethostbyname
6062
*
6163
* @param addr Raw IP address
62-
* @param port Optional 16-bit port
64+
* @param port Optional 16-bit port, defaults to 0
6365
*/
6466
SocketAddress(nsapi_addr_t addr = nsapi_addr_t(), uint16_t port = 0);
6567

6668
/** Create a SocketAddress from an IP address and port
6769
*
6870
* @param addr Null-terminated representation of the IP address
69-
* @param port Optional 16-bit port
71+
* @param port Optional 16-bit port, defaults to 0
7072
*/
7173
SocketAddress(const char *addr, uint16_t port = 0);
7274

7375
/** Create a SocketAddress from raw IP bytes, IP version, and port
7476
*
7577
* @param bytes Raw IP address in big-endian order
7678
* @param version IP address version, NSAPI_IPv4 or NSAPI_IPv6
77-
* @param port Optional 16-bit port
79+
* @param port Optional 16-bit port, defaults to 0
7880
*/
7981
SocketAddress(const void *bytes, nsapi_version_t version, uint16_t port = 0);
8082

0 commit comments

Comments
 (0)