Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
GapConnectionUpdateEvent Struct Reference
Indicates the connection update process completion. More...
#include <GapEvents.h>
Inherits ble::pal::GapEvent.
Public Member Functions | |
GapConnectionUpdateEvent (uint8_t status, connection_handle_t connection_handle, uint16_t connection_interval, uint16_t connection_latency, uint16_t supervision_timeout) | |
Construct a connection update event for a successful process. | |
Data Fields | |
const uint8_t | status |
If equal to 0, the connection update has succesfully completed otherwise the process has failled and this field represent the error associated to the faillure. | |
const connection_handle_t | connection_handle |
Handle of the connection which has completed the connection update process. | |
const uint16_t | connection_interval |
New connection interval used by the connection. |
Detailed Description
Indicates the connection update process completion.
If no parameters are updated after a connection update request from the peer then this event shall not be emmited.
- Note:
- : See Bluetooth 5 Vol 2 PartE: 7.7.65.3 LE Connection Update Complete Event.
Definition at line 339 of file pal/GapEvents.h.
Constructor & Destructor Documentation
GapConnectionUpdateEvent | ( | uint8_t | status, |
connection_handle_t | connection_handle, | ||
uint16_t | connection_interval, | ||
uint16_t | connection_latency, | ||
uint16_t | supervision_timeout | ||
) |
Construct a connection update event for a successful process.
- Parameters:
-
status Status of the connection update event operation. If equal to 0x00 then the process was successful, otherwise the status indicates the reason of the faillure. connection_handle Handle of the connection updated. connection_interval New connection interval used by the connection. Connection_latency New connection latency used by the connection. supervision_timeout New connection supervision timeout.
Definition at line 356 of file pal/GapEvents.h.
Field Documentation
Handle of the connection which has completed the connection update process.
Definition at line 382 of file pal/GapEvents.h.
const uint16_t connection_interval |
New connection interval used by the connection.
It shall be in a range [0x0006 : 0x0C80]. A unit is equal to 1.25ms.
Definition at line 388 of file pal/GapEvents.h.
const uint8_t status |
If equal to 0, the connection update has succesfully completed otherwise the process has failled and this field represent the error associated to the faillure.
Definition at line 376 of file pal/GapEvents.h.
Generated on Tue Jul 12 2022 13:55:41 by
