nRF5 SDK v12.1.0
Modules | Macros | Enumerations
Connection state

Module for storing data on BLE connections. More...

Modules

 BLE connection state functions
 

Macros

#define BLE_CONN_STATE_N_USER_FLAGS   24
 

Enumerations

enum  ble_conn_state_status_t {
  BLE_CONN_STATUS_INVALID,
  BLE_CONN_STATUS_DISCONNECTED,
  BLE_CONN_STATUS_CONNECTED
}
 Connection handle statuses. More...
 
enum  ble_conn_state_user_flag_id_t {
  BLE_CONN_STATE_USER_FLAG0 = 0,
  BLE_CONN_STATE_USER_FLAG1,
  BLE_CONN_STATE_USER_FLAG2,
  BLE_CONN_STATE_USER_FLAG3,
  BLE_CONN_STATE_USER_FLAG4,
  BLE_CONN_STATE_USER_FLAG5,
  BLE_CONN_STATE_USER_FLAG6,
  BLE_CONN_STATE_USER_FLAG7,
  BLE_CONN_STATE_USER_FLAG8,
  BLE_CONN_STATE_USER_FLAG9,
  BLE_CONN_STATE_USER_FLAG10,
  BLE_CONN_STATE_USER_FLAG11,
  BLE_CONN_STATE_USER_FLAG12,
  BLE_CONN_STATE_USER_FLAG13,
  BLE_CONN_STATE_USER_FLAG14,
  BLE_CONN_STATE_USER_FLAG15,
  BLE_CONN_STATE_USER_FLAG16,
  BLE_CONN_STATE_USER_FLAG17,
  BLE_CONN_STATE_USER_FLAG18,
  BLE_CONN_STATE_USER_FLAG19,
  BLE_CONN_STATE_USER_FLAG20,
  BLE_CONN_STATE_USER_FLAG21,
  BLE_CONN_STATE_USER_FLAG22,
  BLE_CONN_STATE_USER_FLAG23,
  BLE_CONN_STATE_USER_FLAG_INVALID
}
 One ID for each user flag collection. More...
 

Detailed Description

Module for storing data on BLE connections.

This module stores certain states for each connection, which can be queried by connection handle. The module uses BLE events to keep the states updated.

In addition to the preprogrammed states, this module can also keep track of a number of binary user states, or user flags. These are reset to 0 for new connections, but otherwise not touched by this module.

This module uses the Mapped flags module, with connection handles as keys and the connection states as flags.

Note
A connection handle is not immediately invalidated when it is disconnected. Certain states, such as the role, can still be queried until the next time a new connection is established to any device.

To function properly, this module must be provided with BLE events from the SoftDevice through the ble_conn_state_on_ble_evt() function. This module should be the first to receive BLE events if they are dispatched to multiple modules.

Macro Definition Documentation

#define BLE_CONN_STATE_N_USER_FLAGS   24

The number of available user flags.

Enumeration Type Documentation

Connection handle statuses.

Enumerator
BLE_CONN_STATUS_INVALID 

The connection handle is invalid.

BLE_CONN_STATUS_DISCONNECTED 

The connection handle refers to a connection that has been disconnected, but not yet invalidated.

BLE_CONN_STATUS_CONNECTED 

The connection handle refers to an active connection.

One ID for each user flag collection.

These IDs are used to identify user flag collections in the API calls.


Documentation feedback | Developer Zone | Subscribe | Updated