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

Articles and capitalization

pull/8541/head
Mel W 2018-10-26 16:18:57 +03:00 committed by GitHub
parent 25b1625fff
commit b165fc0f93
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/DNS.h
View File

@ -39,7 +39,7 @@ public:
/** Hostname translation callback for gethostbyname_async. /** Hostname translation callback for gethostbyname_async.
* *
* Callback will be called after DNS resolution completes or a failure occurs. * The callback is called after DNS resolution completes, or a failure occurs.
* *
* Callback should not take more than 10ms to execute, otherwise it might * Callback should not take more than 10ms to execute, otherwise it might
* prevent underlying thread processing. A portable user of the callback * prevent underlying thread processing. A portable user of the callback
@ -60,14 +60,14 @@ public:
* If no stack-specific DNS resolution is provided, the hostname * If no stack-specific DNS resolution is provided, the hostname
* will be resolved using a UDP socket on the stack. * will be resolved using a UDP socket on the stack.
* *
* Call is non-blocking. Result of the DNS operation is returned by the callback. * The call is non-blocking. The result of the DNS operation is returned by the callback.
* If this function returns failure, callback will not be called. If it is successful, * If this function returns failure, the callback will not be called. If it is successful,
* (IP address was found from DNS cache), callback will be called * (the IP address was found from the DNS cache), the callback will be called
* before function returns. * before the function returns.
* *
* @param host Hostname to resolve. * @param host Hostname to resolve.
* @param callback Callback that is called to return the result. * @param callback Callback that is called to return the result.
* @param version IP version of address to resolve. NSAPI_UNSPEC indicates * @param version IP version of address to resolve. NSAPI_UNSPEC indicates that the
* version is chosen by the stack (defaults to NSAPI_UNSPEC). * version is chosen by the stack (defaults to NSAPI_UNSPEC).
* @return NSAPI_ERROR_OK on immediate success, * @return NSAPI_ERROR_OK on immediate success,
* negative error code on immediate failure or * negative error code on immediate failure or
@ -79,9 +79,9 @@ public:
/** Cancel asynchronous hostname translation. /** Cancel asynchronous hostname translation.
* *
* When translation is cancelled, callback will not be called. * When translation is canceled, callback is not called.
* *
* @param id Unique id of the hostname translation operation returned by gethostbyname_async. * @param id Unique ID of the hostname translation operation returned by gethostbyname_async.
* @return NSAPI_ERROR_OK on success, negative error code on failure. * @return NSAPI_ERROR_OK on success, negative error code on failure.
*/ */
virtual nsapi_error_t gethostbyname_async_cancel(int id) = 0; virtual nsapi_error_t gethostbyname_async_cancel(int id) = 0;