Marco Zecchini
Rtos API example
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 262 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 279 of file pal/GapEvents.h.
Field Documentation
Handle of the connection which has completed the connection update process.
Definition at line 305 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 311 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 299 of file pal/GapEvents.h.
Generated on Sun Jul 17 2022 08:25:43 by
1.7.2