Rtos API example

Embed: (wiki syntax)

« Back to documentation index

GapDisconnectionCompleteEvent Struct Reference

GapDisconnectionCompleteEvent Struct Reference

Indicate the end of a disconnection process. More...

#include <GapEvents.h>

Inherits ble::pal::GapEvent.

Public Member Functions

 GapDisconnectionCompleteEvent (uint8_t status, connection_handle_t connection_handle, uint8_t reason)
 Construct a disconnection complete event.

Data Fields

const uint8_t status
 Status of the procedure.
const connection_handle_t connection_handle
 Handle of the connection used for the procedure.
const uint8_t reason
 Reason for disconnection.

Detailed Description

Indicate the end of a disconnection process.

Note:
: See Bluetooth 5 Vol 2 PartE: 7.7.5 Disconnection Complete Event.

Definition at line 398 of file pal/GapEvents.h.


Constructor & Destructor Documentation

GapDisconnectionCompleteEvent ( uint8_t  status,
connection_handle_t  connection_handle,
uint8_t  reason 
)

Construct a disconnection complete event.

Parameters:
statusStatus of the procedure. If equal to 0 then the disconnection process complete successfully. Otherwise it represents the error code associated with the faillure.
connection_handleHandle of the connection disconnected.
reasonReason of the disconnection

Definition at line 410 of file pal/GapEvents.h.


Field Documentation

Handle of the connection used for the procedure.

Definition at line 430 of file pal/GapEvents.h.

const uint8_t reason

Reason for disconnection.

ignored in case of faillure.

Definition at line 437 of file pal/GapEvents.h.

const uint8_t status

Status of the procedure.

If equal to 0 then the procedure was a success otherwise this variable contains the error code associated with the faillure.

Definition at line 425 of file pal/GapEvents.h.