Skip to content

Commit

Permalink
Documentation change only: clarify return value of uSockCreate().
Browse files Browse the repository at this point in the history
  • Loading branch information
RobMeades committed Feb 21, 2024
1 parent 4d31e3b commit e46ddee
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions common/sock/api/u_sock.h
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,21 @@ typedef struct {
* assigned by the IP stack unless uSockSetNextLocalPort()
* has been called.
*
* Note: the descriptor (an integer) returned by this function
* is not the one the module returns, it is a local descriptor
* which this API will _map_ to the one the module returns.
* In other words if, in an AT log, you see:
*
* ```
* AT+USOCR=17
* +USOCR: 0
* OK
* ```
*
* ...the descriptor returned here may not be 0, it will be
* the next value of an incrementing integer maintained by
* this code.
*
* @param devHandle the handle of the underlying network
* layer to use, usually established by
* a call to uDeviceOpen().
Expand Down

0 comments on commit e46ddee

Please sign in to comment.