.. _nrf_modem_api:

API documentation
#################

.. contents::
   :local:
   :depth: 2

Library Management
******************

.. doxygengroup:: nrf_modem
   :project: nrfxlib
   :members:

nrf_modem_init() return values for modem firmware updates
=========================================================

.. doxygengroup:: nrf_modem_dfu
   :project: nrfxlib
   :members:

.. _nrf_modem_trace:

Modem traces
============

.. doxygengroup:: nrf_modem_trace
   :project: nrfxlib
   :members:

.. _nrf_modem_fault:

Modem fault reasons
===================

.. doxygengroup:: nrf_modem_fault_handling
   :project: nrfxlib
   :members:

Limits of the Modem library
***************************

.. doxygengroup:: nrf_modem_limits
   :project: nrfxlib
   :members:

Socket parameter enumerators
****************************

Socket families
===============

.. doxygengroup:: nrf_socket_families
   :project: nrfxlib
   :members:

Socket types
============

.. doxygengroup:: nrf_socket_types
   :project: nrfxlib
   :members:

Socket protocols
================

.. doxygengroup:: nrf_socket_protocols
   :project: nrfxlib
   :members:

Socket option levels
====================

.. doxygengroup:: nrf_socket_options_levels
   :project: nrfxlib
   :members:

Generic socket options
======================

.. doxygengroup:: nrf_socket_options_sockets
   :project: nrfxlib
   :members:

Socket send and recv flags
==========================

.. doxygengroup:: nrf_socket_send_recv_flags
   :project: nrfxlib
   :members:

fcntl parameters
================

.. doxygengroup:: nrf_fcnt_commands
   :project: nrfxlib
   :members:

.. doxygengroup:: nrf_fcnt_flags
   :project: nrfxlib
   :members:

Socket API
**********

.. doxygengroup:: nrf_socket_api
   :project: nrfxlib
   :members:

TLS socket
**********

.. doxygengroup:: nrf_socket_tls
   :project: nrfxlib
   :members:

DTLS handshake timeout values
=============================

.. doxygengroup:: nrf_socket_so_sec_handshake_timeouts
   :project: nrfxlib
   :members:

TLS/DTLS peer verification options
==================================

.. doxygengroup:: nrf_socket_sec_peer_verify_options
   :project: nrfxlib
   :members:

TLS/DTLS session cache options
==============================

.. doxygengroup:: nrf_socket_session_cache_options
   :project: nrfxlib
   :members:

TLS/DTLS socket connection roles
================================

.. doxygengroup:: nrf_socket_sec_roles
   :project: nrfxlib
   :members:

.. _nrf_supported_tls_cipher_suites:

Supported cipher suites
=======================

.. doxygengroup:: nrf_socket_tls_cipher_suites
   :project: nrfxlib
   :members:

DTLS connection ID settings
===========================

.. doxygengroup:: nrf_so_sec_dtls_cid_settings
   :project: nrfxlib
   :members:

DTLS connection ID statuses
===========================

.. doxygengroup:: nrf_so_sec_dtls_cid_statuses
   :project: nrfxlib
   :members:

TLS/DTLS handshake statuses
===========================

.. doxygengroup:: nrf_so_sec_handshake_statuses
   :project: nrfxlib
   :members:


Socket address resolution API
*****************************

.. doxygengroup:: nrf_socket_address_resolution
   :project: nrfxlib
   :members:

Socket polling API
******************

Necessary data types and defines to poll for
events on one or more sockets using :c:func:`nrf_poll`.

.. doxygengroup:: nrf_socket_api_poll
   :project: nrfxlib
   :members:

.. _nrf_modem_at_api:

AT API
******

.. doxygengroup:: nrf_modem_at
   :project: nrfxlib
   :members:

.. _nrf_modem_bootloader_api:
.. _nrf_modem_full_dfu_api:

Bootloader API
**************

.. doxygengroup:: nrf_modem_bootloader
   :project: nrfxlib
   :members:

.. _nrf_modem_delta_dfu_api:

Delta DFU API
*************

.. doxygengroup:: nrf_modem_delta_dfu
   :project: nrfxlib
   :members:

.. doxygengroup:: nrf_modem_delta_dfu_errors
   :project: nrfxlib
   :members:

.. _nrf_modem_gnss_api:

GNSS API
********

.. doxygengroup:: nrf_modem_gnss
   :project: nrfxlib
   :members:

Event types
===========

.. doxygengroup:: nrf_modem_gnss_event_type
   :project: nrfxlib
   :members:

Data types
==========

.. doxygengroup:: nrf_modem_gnss_data_type
   :project: nrfxlib
   :members:

PVT notification flags bitmask values
=====================================

.. doxygengroup:: nrf_modem_gnss_pvt_flag_bitmask
   :project: nrfxlib
   :members:

Satellite flags bitmask values
==============================

.. doxygengroup:: nrf_modem_gnss_sv_flag_bitmask
   :project: nrfxlib
   :members:

A-GNSS data request bitmask values
==================================

.. doxygengroup:: nrf_modem_gnss_agnss_data_bitmask
   :project: nrfxlib
   :members:

A-GNSS data type enumerator
===========================

.. doxygengroup:: nrf_modem_gnss_agnss_data_type
   :project: nrfxlib
   :members:

Delete bitmask values
=====================

.. doxygengroup:: nrf_modem_gnss_delete_bitmask
   :project: nrfxlib
   :members:

GNSS signal bitmask values
==========================

.. doxygengroup:: nrf_modem_gnss_signal_bitmask
   :project: nrfxlib
   :members:

NMEA string bitmask values
==========================

.. doxygengroup:: nrf_modem_gnss_nmea_string_bitmask
   :project: nrfxlib
   :members:

Power save modes
================

.. doxygengroup:: nrf_modem_gnss_power_save_modes
   :project: nrfxlib
   :members:

Use case bitmask values
=======================

.. doxygengroup:: nrf_modem_gnss_use_case_bitmask
   :project: nrfxlib
   :members:

Sleep timing sources
====================

.. doxygengroup:: nrf_modem_gnss_timing_source
   :project: nrfxlib
   :members:

QZSS NMEA modes
===============

.. doxygengroup:: nrf_modem_gnss_qzss_nmea_mode
   :project: nrfxlib
   :members:

Dynamics modes
==============

.. doxygengroup:: nrf_modem_gnss_dynamics_mode
   :project: nrfxlib
   :members:

.. _nrf_modem_softsim_api:

SoftSIM API
***********

.. doxygengroup:: nrf_modem_softsim
   :project: nrfxlib
   :members:

OS specific definitions
***********************

.. doxygengroup:: nrf_modem_os
   :project: nrfxlib
   :members: