Skip to content

Commit c80e7b9

Browse files
anhmoltjfischer-no
authored andcommitted
nrf_modem: doc: cleanup function references
Clean up function references. Add nrf_accept and nrf_setdnsaddr to list of supported functions. Signed-off-by: Andreas Moltumyr <[email protected]>
1 parent c443fd5 commit c80e7b9

File tree

4 files changed

+8
-6
lines changed

4 files changed

+8
-6
lines changed

nrf_modem/doc/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Socket polling API
186186
******************
187187

188188
Necessary data types and defines to poll for
189-
events on one or more sockets using nrf_poll().
189+
events on one or more sockets using :c:func:`nrf_poll`.
190190

191191
.. doxygengroup:: nrf_socket_api_poll
192192
:project: nrfxlib

nrf_modem/doc/fault_handling.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ Socket APIs that require communication with the modem, return ``-1`` and set ``e
4646

4747
Although the modem has crashed, any data which was stored by the Modem library, including data that was delivered to the Modem library by the modem, remains available until the Modem library is shut down.
4848
This includes incoming network data, which was received before the crash but has not been read by the application.
49-
The application can read that data as normal, using the :c:func:`recv` function.
50-
When no more data is available, the :c:func:`recv` function returns ``-1`` and sets ``errno`` to ``NRF_ESHUTDOWN``.
49+
The application can read that data as normal, using the :c:func:`nrf_recv` and the :c:func:`nrf_recvfrom` functions.
50+
When no more data is available, the :c:func:`nrf_recv` and the :c:func:`nrf_recvfrom` functions return ``-1`` and set ``errno`` to ``NRF_ESHUTDOWN``.
5151

5252
Ongoing API calls
5353
*****************

nrf_modem/doc/sockets/rai.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ After enabling RAI, you control it using the :c:func:`nrf_setsockopt` function w
4949
Code examples
5050
*************
5151

52-
The following code snippets illustrate some cases on how to apply RAI using the :c:func:`nrf_setsockopt()` function.
52+
The following code snippets illustrate some cases on how to apply RAI using the :c:func:`nrf_setsockopt` function.
5353

5454
An example that shows how to use ``NRF_RAI_LAST`` when sending a UDP packet:
5555

nrf_modem/doc/sockets/socket_options_func.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Following is a list of supported functions:
2020
* :c:func:`nrf_connect`
2121
* :c:func:`nrf_bind`
2222
* :c:func:`nrf_listen`
23+
* :c:func:`nrf_accept`
2324
* :c:func:`nrf_send`
2425
* :c:func:`nrf_sendto`
2526
* :c:func:`nrf_recv`
@@ -34,6 +35,7 @@ Following is a list of supported functions:
3435
* :c:func:`nrf_freeifaddrs`
3536
* :c:func:`nrf_inet_pton`
3637
* :c:func:`nrf_inet_ntop`
38+
* :c:func:`nrf_setdnsaddr`
3739

3840
The library supports up to eight networking sockets.
3941

@@ -55,7 +57,7 @@ The following table shows all socket options supported by the Modem library.
5557
+-----------------+---------------------------------+------------------------+------------+--------------------------------------------------------------------------------------------+
5658
| NRF_SOL_SOCKET | NRF_SO_BINDTOPDN | ``int`` | set | Bind this socket to a specific PDN ID. |
5759
+-----------------+---------------------------------+------------------------+------------+--------------------------------------------------------------------------------------------+
58-
| NRF_SOL_SOCKET | NRF_SO_POLLCB | ``struct nrf_pollcb`` | set | Set callbacks for poll() events on sockets. |
60+
| NRF_SOL_SOCKET | NRF_SO_POLLCB | ``struct nrf_pollcb`` | set | Set callbacks for :c:func:`nrf_poll` events on sockets. |
5961
+-----------------+---------------------------------+------------------------+------------+--------------------------------------------------------------------------------------------+
6062
| NRF_SOL_SOCKET | NRF_SO_EXCEPTIONAL_DATA | ``int`` | get/set | Send data on socket as part of exceptional event. |
6163
+-----------------+---------------------------------+------------------------+------------+--------------------------------------------------------------------------------------------+
@@ -294,7 +296,7 @@ NRF_SO_SEC_ROLE
294296
* :c:macro:`NRF_SO_SEC_ROLE_SERVER` - Server role
295297

296298
The default role is client.
297-
For TLS, the choice is implicit from the usage of ``listen()``, ``accept()`` and ``connect()``.
299+
For TLS, the choice is implicit from the usage of :c:func:`nrf_listen`, :c:func:`nrf_accept` and :c:func:`nrf_connect`.
298300

299301
NRF_SO_SEC_SESSION_CACHE
300302
This option controls TLS session caching.

0 commit comments

Comments
 (0)