Skip to content

Commit d6fee90

Browse files
anhmoltjfischer-no
authored andcommitted
nrf_modem: doc: change nrf_errno to errno
Change nrf_errno mentions to simply errno when referencing specific errnos for the NRF_SO_SEC_DTLS_CONN_SAVE and NRF_SO_SEC_DTLS_CONN_LOAD socket options. Signed-off-by: Andreas Moltumyr <[email protected]>
1 parent c80e7b9 commit d6fee90

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

nrf_modem/doc/sockets/socket_options_func.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -379,21 +379,21 @@ NRF_SO_SEC_DTLS_CONN_SAVE
379379

380380
Once the DTLS context is saved, the socket can't be used before the DTLS context is loaded with :c:macro:`NRF_SO_SEC_DTLS_CONN_LOAD`.
381381

382-
This option fails with nrf_errno ``NRF_EAGAIN``if an error happened during serialization of the SSL context.
382+
This option fails with ``errno`` set to ``NRF_EAGAIN`` if an error happened during serialization of the SSL context.
383383
This can occur, for instance, when the modem cannot allocate enough memory or if the socket is busy sending or receiving data.
384384
In this case, the SSL context is still present in the socket, so data sending is still possible.
385-
The option fails with nrf_errno ``NRF_EINVAL`` if the socket option is not supported with the current configuration, for instance because the DTLS handshake is not completed,
385+
The option fails with ``errno`` set to ``NRF_EINVAL`` if the socket option is not supported with the current configuration, for instance because the DTLS handshake is not completed,
386386
the connection is not an DTLS v1.2 connection with renegotiation disabled, or the connection does not use an AEAD cipher suite (AES-CCM or AES-GCM).
387-
The option fails with nrf_errno ``NRF_ENOMEM`` if the number of saved connections exceeds four.
387+
The option fails with ``errno`` set to ``NRF_ENOMEM`` if the number of saved connections exceeds four.
388388

389389
NRF_SO_SEC_DTLS_CONN_LOAD
390390
Load DTLS connection.
391391
This option is write-only.
392392
The socket option is supported from modem firmware v1.3.x, where x is greater than or equal to 5, and v2.x.x.
393393

394-
This option fails with nrf_errno ``NRF_EAGAIN`` if an error happened during deserialization of the SSL context.
394+
This option fails with ``errno`` set to ``NRF_EAGAIN`` if an error happened during deserialization of the SSL context.
395395
This can occur, for instance, when the modem cannot allocate enough memory or the connection is not saved.
396-
The option fails with nrf_errno ``NRF_EINVAL`` if the socket option is not supported with the current configuration.
396+
The option fails with ``errno`` set to ``NRF_EINVAL`` if the socket option is not supported with the current configuration.
397397

398398
NRF_SO_SEC_CIPHERSUITE_USED
399399
Get chosen TLS cipher suite.

0 commit comments

Comments
 (0)