nRF51 SDK: Types definitions for BLE support in SoftDevice handler.

| nRF51 SDK

- Home
- Related Pages
- API Reference
- Data Structures

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Macros | Typedefs | Functions
Types definitions for BLE support in SoftDevice handler.
SDK Common Libraries

This file contains the declarations of types required for BLE stack support. These types will be defined when the preprocessor define BLE_STACK_SUPPORT_REQD is defined. More...

## Macros

#define | BLE_STACK_EVT_MSG_BUF_SIZE (sizeof(ble_evt_t) + (GATT_MTU_SIZE_DEFAULT))
#define | BLE_STACK_HANDLER_SCHED_EVT_SIZE 0

## Typedefs

typedef void(* | ble_evt_handler_t )(ble_evt_t *p_ble_evt)
| Application stack event handler type.

## Functions

uint32_t | softdevice_ble_evt_handler_set (ble_evt_handler_t ble_evt_handler)
| Function for registering for BLE events. More...

## Detailed Description

This file contains the declarations of types required for BLE stack support. These types will be defined when the preprocessor define BLE_STACK_SUPPORT_REQD is defined.

## Macro Definition Documentation

#define BLE_STACK_EVT_MSG_BUF_SIZE (sizeof(ble_evt_t) + (GATT_MTU_SIZE_DEFAULT))

Size of BLE event message buffer. This will be provided to the SoftDevice while fetching an event.

#define BLE_STACK_HANDLER_SCHED_EVT_SIZE 0

The size of the scheduler event used by SoftDevice handler when passing BLE events using the Scheduler.

## Function Documentation

uint32_t softdevice_ble_evt_handler_set | ( | ble_evt_handler_t | ble_evt_handler | ) |

Function for registering for BLE events.

The application should use this function to register for receiving BLE events from the SoftDevice. If the application does not call this function, then any BLE event that may be generated by the SoftDevice will NOT be fetched. Once the application has registered for the events, it is not possible to possible to cancel the registration. However, it is possible to register a different function for handling the events at any point of time.

Parameters

  [in] | ble_evt_handler | Function to be called for each received BLE event.

Return values

  NRF_SUCCESS | Successful registration.
  NRF_ERROR_NULL | Null pointer provided as input.