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
GapConnectionCompleteEvent Struct Reference
Indicate to both ends (slave or master) the end of the connection process. More...
#include <GapEvents.h>
Inherits ble::pal::GapEvent.
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.10 LE Enhanced Connection Complete Event
Definition at line 146 of file pal/GapEvents.h.
| GapConnectionCompleteEvent | ( | uint8_t | status, |
| connection_handle_t | connection_handle, | ||
| connection_role_t | role, | ||
| peer_address_type_t | peer_address_type, | ||
| const address_t & | peer_address, | ||
| uint16_t | connection_interval, | ||
| uint16_t | connection_latency, | ||
| uint16_t | supervision_timeout, | ||
| const address_t & | local_resolvable_private_address, | ||
| const address_t & | peer_resolvable_private_address | ||
| ) |
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. local_resolvable_private_address Resolvable private address used by the local device to establish the connection. peer_resolvable_private_address Resolvable private address used by the peer to establish the connection.
- Note:
- : See Bluetooth 5 Vol 2 PartE: 7.7.65.10 LE Enhanced Connection Complete Event
Definition at line 207 of file pal/GapEvents.h.
Field Documentation
Handle of the connection created, valid if status is equal to 0.
- Attention:
- Valid if status is equal to 0.
Definition at line 245 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 267 of file pal/GapEvents.h.
| const uint16_t connection_latency |
Number of connection events the slave can drop.
Definition at line 272 of file pal/GapEvents.h.
Resolvable private address of the local device.
Set to all 0 if not available.
Definition at line 284 of file pal/GapEvents.h.
| const address_t peer_address |
Peer address.
Definition at line 261 of file pal/GapEvents.h.
Peer address type.
Definition at line 256 of file pal/GapEvents.h.
Resolvable private address of the peer.
Set to all 0 if not available. *
Definition at line 290 of file pal/GapEvents.h.
| const connection_role_t role |
Role of the device in the connection.
- Attention:
- Valid if status is equal to 0.
Definition at line 251 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 278 of file pal/GapEvents.h.
Generated on Tue Jul 12 2022 13:55:41 by
1.7.2