Rtos API example
GapConnectionCompleteEvent Struct Reference
Indicate to both ends (slave or master) the end of the connection process. More...
#include <GapEvents.h>
Inherits ble::pal::GapEvent.
Public Member Functions | |
GapConnectionCompleteEvent (uint8_t status, connection_handle_t connection_handle, connection_role_t role, advertising_peer_address_type_t peer_address_type, const address_t &peer_address, uint16_t connection_interval, uint16_t connection_latency, uint16_t supervision_timeout) | |
Construct a new GapConnectionCompleteEvent. | |
Data Fields | |
const connection_handle_t | connection_handle |
Handle of the connection created, valid if status is equal to 0. | |
const connection_role_t | role |
Role of the device in the connection Valid if status is equal to 0. | |
const advertising_peer_address_type_t | peer_address_type |
Peer address type. | |
const address_t | peer_address |
Peer address. | |
const uint16_t | connection_interval |
Connection interval used in this connection. | |
const uint16_t | connection_latency |
Number of connection events the slave can drop. | |
const uint16_t | supervision_timeout |
Supervision timeout of the connection It shall be in the range [0x000A : 0x0C80] where a unit represent 10ms. |
Detailed Description
Indicate to both ends (slave or master) the end of the connection process.
This structure should be used for Connection Complete Events and Enhanced Connection Complete Event.
- Note:
- : See Bluetooth 5 Vol 2 PartE: 7.7.65.1 LE Connection Complete Event
- : See Bluetooth 5 Vol 2 PartE: 7.7.65.10 LE Enhanced Connection
Definition at line 117 of file pal/GapEvents.h.
Constructor & Destructor Documentation
GapConnectionCompleteEvent | ( | uint8_t | status, |
connection_handle_t | connection_handle, | ||
connection_role_t | role, | ||
advertising_peer_address_type_t | peer_address_type, | ||
const address_t & | peer_address, | ||
uint16_t | connection_interval, | ||
uint16_t | connection_latency, | ||
uint16_t | supervision_timeout | ||
) |
Construct a new GapConnectionCompleteEvent.
- Parameters:
-
status Status of the operation: 0x00 in case of success otherwise the error code associated with the failure. connection_handle handle of the connection created. This handle will be used to address the connection in any connection oriented operation. role Role of the LE subsystem in the connection. address_type Type of address used by the peer for this connection. address Address of the peer used to establish the connection. connection_interval Connection interval used on this connection. It shall be in a range [0x0006 : 0x0C80]. A unit is equal to 1.25ms. connection_latency Number of connection events the slave can drop. supervision_timeout Supervision timeout of the connection. It shall be in the range [0x000A : 0x0C80] where a unit represent 10ms.
- Note:
- : See Bluetooth 5 Vol 2 PartE: 7.7.65.1 LE Connection Complete Event
- : See Bluetooth 5 Vol 2 PartE: 7.7.65.10 LE Enhanced Connection Complete Event
Definition at line 147 of file pal/GapEvents.h.
Field Documentation
Handle of the connection created, valid if status is equal to 0.
Valid if status is equal to 0.
Definition at line 180 of file pal/GapEvents.h.
const uint16_t connection_interval |
Connection interval used in this connection.
It shall be in a range [0x0006 : 0x0C80]. A unit is equal to 1.25ms.
Definition at line 202 of file pal/GapEvents.h.
const uint16_t connection_latency |
Number of connection events the slave can drop.
Definition at line 207 of file pal/GapEvents.h.
const address_t peer_address |
Peer address.
Definition at line 196 of file pal/GapEvents.h.
Peer address type.
Definition at line 191 of file pal/GapEvents.h.
const connection_role_t role |
Role of the device in the connection Valid if status is equal to 0.
Definition at line 186 of file pal/GapEvents.h.
const uint16_t supervision_timeout |
Supervision timeout of the connection It shall be in the range [0x000A : 0x0C80] where a unit represent 10ms.
Definition at line 213 of file pal/GapEvents.h.
Generated on Sun Jul 17 2022 08:25:43 by 1.7.2