Skip to content

Commit 764f9c3

Browse files
MarkusLassilacarlescufi
authored andcommitted
applications: serial_lte_modem: doc: Change SO macro names
Socket option macro names changed in documentation. Signed-off-by: Markus Lassila <[email protected]> (cherry picked from commit 5abf4ca)
1 parent 4c6f2c5 commit 764f9c3

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

applications/serial_lte_modem/doc/SOCKET_AT_commands.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -508,44 +508,44 @@ Syntax
508508

509509
* The ``<name>`` parameter can accept one of the following values:
510510

511-
* ``2`` - :c:macro:`SO_REUSEADDR` (set-only).
511+
* ``2`` - :c:macro:`AT_SO_REUSEADDR` (set-only).
512512

513513
* ``<value>`` is an integer that indicates whether the reuse of local addresses is enabled.
514514
It is ``0`` for disabled or ``1`` for enabled.
515515

516-
* ``20`` - :c:macro:`SO_RCVTIMEO`.
516+
* ``20`` - :c:macro:`AT_SO_RCVTIMEO`.
517517

518518
* ``<value>`` is an integer that indicates the receive timeout in seconds.
519519

520-
* ``21`` - :c:macro:`SO_SNDTIMEO`.
520+
* ``21`` - :c:macro:`AT_SO_SNDTIMEO`.
521521

522522
* ``<value>`` is an integer that indicates the send timeout in seconds.
523523

524-
* ``30`` - :c:macro:`SO_SILENCE_ALL`.
524+
* ``30`` - :c:macro:`AT_SO_SILENCE_ALL`.
525525

526526
* ``<value>`` is an integer that indicates whether ICMP echo replies for IPv4 and IPv6 are disabled.
527527
It is ``0`` for allowing ICMP echo replies or ``1`` for disabling them.
528528

529-
* ``31`` - :c:macro:`SO_IP_ECHO_REPLY`.
529+
* ``31`` - :c:macro:`AT_SO_IP_ECHO_REPLY`.
530530

531531
* ``<value>`` is an integer that indicates whether ICMP echo replies for IPv4 are enabled.
532532
It is ``0`` for disabled or ``1`` for enabled.
533533

534-
* ``32`` - :c:macro:`SO_IPV6_ECHO_REPLY`.
534+
* ``32`` - :c:macro:`AT_SO_IPV6_ECHO_REPLY`.
535535

536536
* ``<value>`` is an integer that indicates whether ICMP echo replies for IPv6 are enabled.
537537
It is ``0`` for disabled or ``1`` for enabled.
538538

539-
* ``40`` - :c:macro:`SO_BINDTOPDN` (set-only).
539+
* ``40`` - :c:macro:`AT_SO_BINDTOPDN` (set-only).
540540

541541
* ``<value>`` is an integer that indicates the packet data network ID to bind to.
542542

543-
* ``55`` - :c:macro:`SO_TCP_SRV_SESSTIMEO`.
543+
* ``55`` - :c:macro:`AT_SO_TCP_SRV_SESSTIMEO`.
544544

545545
* ``<value>`` is an integer that indicates the TCP server session inactivity timeout for a socket.
546546
It accepts values from the range ``0`` to ``135``, where ``0`` is no timeout and ``135`` is 2 hours, 15 minutes.
547547

548-
* ``61`` - :c:macro:`SO_RAI` (set-only).
548+
* ``61`` - :c:macro:`AT_SO_RAI` (set-only).
549549
Release Assistance Indication (RAI).
550550

551551
* ``<value>`` The option accepts an integer, indicating the type of RAI.
@@ -571,7 +571,7 @@ Syntax
571571
Indicates that the socket is in active use by a server application.
572572
This lets the modem stay in connected mode longer.
573573

574-
* ``62`` - :c:macro:`SO_IPV6_DELAYED_ADDR_REFRESH`.
574+
* ``62`` - :c:macro:`AT_SO_IPV6_DELAYED_ADDR_REFRESH`.
575575

576576
* ``<value>`` is an integer that indicates whether delayed IPv6 address refresh is enabled.
577577
It is ``0`` for disabled or ``1`` for enabled.
@@ -651,31 +651,31 @@ Syntax
651651

652652
* The ``<name>`` parameter can accept one of the following values:
653653

654-
* ``2`` - :c:macro:`TLS_HOSTNAME`.
654+
* ``2`` - :c:macro:`AT_TLS_HOSTNAME`.
655655

656656
* ``<value>`` is a string that indicates the hostname to check against during TLS handshakes.
657657
It can be ``NULL`` to disable hostname verification.
658658

659-
* ``4`` - :c:macro:`TLS_CIPHERSUITE_USED` (get-only).
659+
* ``4`` - :c:macro:`AT_TLS_CIPHERSUITE_USED` (get-only).
660660
The TLS cipher suite chosen during the TLS handshake.
661661
This option is only supported with modem firmware 2.0.0 and newer.
662662

663-
* ``5`` - :c:macro:`TLS_PEER_VERIFY`.
663+
* ``5`` - :c:macro:`AT_TLS_PEER_VERIFY`.
664664

665665
* ``<value>`` is an integer that indicates what peer verification level should be used.
666666
It is ``0`` for none, ``1`` for optional or ``2`` for required.
667667

668-
* ``12`` - :c:macro:`TLS_SESSION_CACHE`.
668+
* ``12`` - :c:macro:`AT_TLS_SESSION_CACHE`.
669669

670670
* ``<value>`` is an integer that indicates whether TLS session caching should be used.
671671
It is ``0`` for disabled or ``1`` for enabled.
672672

673-
* ``13`` - :c:macro:`TLS_SESSION_CACHE_PURGE` (set-only).
673+
* ``13`` - :c:macro:`AT_TLS_SESSION_CACHE_PURGE` (set-only).
674674
Indicates that the TLS session cache should be deleted.
675675

676676
* ``<value>`` can be any integer value.
677677

678-
* ``14`` - :c:macro:`TLS_DTLS_CID` (set-only).
678+
* ``14`` - :c:macro:`AT_TLS_DTLS_CID` (set-only).
679679

680680
* ``<value>`` is an integer that indicates the DTLS connection identifier setting.
681681
It can be one of the following values:
@@ -687,13 +687,13 @@ Syntax
687687
This option is only supported with modem firmware 1.3.5 and newer.
688688
See :ref:`nrfxlib:dtls_cid_setting` for more details regarding the allowed values.
689689

690-
* ``15`` - :c:macro:`TLS_DTLS_CID_STATUS` (get-only).
690+
* ``15`` - :c:macro:`AT_TLS_DTLS_CID_STATUS` (get-only).
691691
It is the DTLS connection identifier status.
692692
It can be retrieved after the DTLS handshake.
693693
This option is only supported with modem firmware 1.3.5 and newer.
694694
See :ref:`nrfxlib:dtls_cid_status` for more details regarding the returned values.
695695

696-
* ``18`` - :c:macro:`TLS_DTLS_HANDSHAKE_TIMEO`.
696+
* ``18`` - :c:macro:`AT_TLS_DTLS_HANDSHAKE_TIMEO`.
697697

698698
* ``<value>`` is an integer that indicates the DTLS handshake timeout in seconds.
699699
It can be one of the following values: ``1``, ``3``, ``7``, ``15``, ``31``, ``63``, ``123``.

0 commit comments

Comments
 (0)