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

Edit UDPSocket.h 

Edit file, mostly for minor spelling to existing text.
pull/8539/head
Amanda Butler 2018-10-25 11:02:48 -05:00 committed by GitHub
parent 8a7d96c75f
commit c02f2164d5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
features/netsocket/UDPSocket.h
View File

@ -57,7 +57,7 @@ public:
/** Send data to the specified host and port.
*
* By default, sendto blocks until data is sent. If socket is set to
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
* nonblocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
* immediately.
*
* @param host Domain name of the remote host or a dotted notation IP address.
@ -73,7 +73,7 @@ public:
/** Send data to the specified address.
*
* By default, sendto blocks until data is sent. If socket is set to
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
* nonblocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned
* immediately.
*
* @param address The SocketAddress of the remote host.
@ -88,7 +88,7 @@ public:
/** Receive a datagram and store the source address in address if it's not NULL.
*
* By default, recvfrom blocks until a datagram is received. If socket is set to
* non-blocking or times out with no datagram, NSAPI_ERROR_WOULD_BLOCK
* nonblocking or times out with no datagram, NSAPI_ERROR_WOULD_BLOCK
* is returned.
*
* @note If the datagram is larger than the buffer, the excess data is silently discarded.
@ -108,7 +108,7 @@ public:
void *data, nsapi_size_t size);
/** Set the remote address for next send() call and filtering
* of incoming packets. To reset the address, zero initialised
* of incoming packets. To reset the address, zero initialized
* SocketAddress must be in the address parameter.
*
* @param address The SocketAddress of the remote host.
@ -119,7 +119,7 @@ public:
/** Send a datagram to connected remote address.
*
* By default, send blocks until all data is sent. If socket is set to
* non-blocking or times out, a partial amount can be written.
* nonblocking or times out, a partial amount can be written.
* NSAPI_ERROR_WOULD_BLOCK is returned if no data was written.
*
* @note The socket must be connected to a remote host before send() call.
@ -133,13 +133,13 @@ public:
/** Receive data from a socket.
*
* This is equivalent of calling recvfrom(NULL, data, size).
* This is equivalent to calling recvfrom(NULL, data, size).
*
* If socket is connected, only packets coming from connected peer address
* If the socket is connected, only packets coming from a connected peer address
* are accepted.
*
* By default, recv blocks until some data is received. If socket is set to
* non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK can be returned to
* nonblocking or times out, NSAPI_ERROR_WOULD_BLOCK can be returned to
* indicate no data.
*
* @note recv() is allowed write to data buffer even if error occurs.