takashi kadono / Mbed OS Nucleo_446

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.

Dependencies:   ssd1331

Embed: (wiki syntax)

« Back to documentation index

Gap::ConnectionCallbackParams_t Struct Reference
Public Member Functions | Data Fields

Gap::ConnectionCallbackParams_t Struct Reference

Connection events. More...

#include <Gap.h>

Public Member Functions

 ConnectionCallbackParams_t (Handle_t handleIn, Role_t roleIn, PeerAddressType_t peerAddrTypeIn, const uint8_t *peerAddrIn, BLEProtocol::AddressType_t ownAddrTypeIn, const uint8_t *ownAddrIn, const ConnectionParams_t *connectionParamsIn, const uint8_t *peerResolvableAddrIn=NULL, const uint8_t *localResolvableAddrIn=NULL)
 Construct an instance of ConnectionCallbackParams_t.
 MBED_DEPRECATED_SINCE ("mbed-os-5.9.0","The type BLEProtocol::AddressType_t is not suitable when privacy is ""enabled. Use the constructor that accepts a PeerAddressType_t instead.") ConnectionCallbackParams_t(Handle_t handleIn
 Construct an instance of ConnectionCallbackParams_t.

Data Fields

Handle_t handle
 Connection handle.
Role_t role
 Connection Role of the local device.
MBED_DEPRECATED_SINCE("mbed-os-5.9","The
type
BLEProtocol::AddressType_t is
not suitable when privacy is
""enabled. Use peerAddressType
instead.") BLEProtocol
BLEProtocol::AddressBytes_t 		peerAddr
 Type of the address the peer uses.
BLEProtocol::AddressType_t ownAddrType
 Address type of the local device.
MBED_DEPRECATED_SINCE("mbed-os-5.9","A
Bluetooth controller is not
supposed to return the address
it used""to connect. With
privacy enabled the controller
address may be unknown""to the
host. There is no replacement
for this deprecation.")
BLEProtocol const
ConnectionParams_t * 		connectionParams
 Address of the local device.
BLEProtocol::AddressBytes_t peerResolvableAddr
 Resolvable address used by the peer.
BLEProtocol::AddressBytes_t localResolvableAddr
 resolvable address of the local device.
PeerAddressType_t peerAddressType
 Type of the address the peer uses.

Detailed Description

Connection events.

It contains all the information related to a newly established connection.

Instances of this structure are passed to handlers that Gap::onConnection() registers when a connection is established.

Definition at line 744 of file Gap.h.

Constructor & Destructor Documentation

ConnectionCallbackParams_t ( Handle_t  handleIn,
Role_t  roleIn,
PeerAddressType_t  peerAddrTypeIn,
const uint8_t *  peerAddrIn,
BLEProtocol::AddressType_t  ownAddrTypeIn,
const uint8_t *  ownAddrIn,
const ConnectionParams_t *  connectionParamsIn,
const uint8_t *  peerResolvableAddrIn = NULL,
const uint8_t *  localResolvableAddrIn = NULL 
)

Construct an instance of ConnectionCallbackParams_t.

Parameters:
[in]handleInValue to assign to handle.
[in]roleInValue to assign to role.
[in]peerAddrTypeInValue to assign to peerAddrType.
[in]peerAddrInValue to assign to peerAddr.
[in]ownAddrTypeInValue to assign to ownAddrType.
[in]ownAddrInValue to assign to ownAddr. This may be NULL.
[in]connectionParamsInValue to assign to connectionParams.
[in]peerResolvableAddrInValue to assign to peerResolvableAddr.
[in]localResolvableAddrInValue to assign to localResolvableAddr.
Note:
Constructor is not meant to be called by user code. The BLE API vendor code generates ConnectionCallbackParams_t.

Definition at line 215 of file Gap.cpp.

Member Function Documentation

MBED_DEPRECATED_SINCE ( "mbed-os-5.9.0"  ,
"The type BLEProtocol::AddressType_t is not suitable when privacy is ""enabled. Use the constructor that accepts a PeerAddressType_t instead."   
)

Construct an instance of ConnectionCallbackParams_t.

Parameters:
[in]handleInValue to assign to handle.
[in]roleInValue to assign to role.
[in]peerAddrTypeInValue to assign to peerAddrType.
[in]peerAddrInValue to assign to peerAddr.
[in]ownAddrTypeInValue to assign to ownAddrType.
[in]ownAddrInValue to assign to ownAddr.
[in]connectionParamsInValue to assign to connectionParams.
[in]peerResolvableAddrInValue to assign to peerResolvableAddr.
[in]localResolvableAddrInValue to assign to localResolvableAddr.
Note:
Constructor is not meant to be called by user code. The BLE API vendor code generates ConnectionCallbackParams_t.

Field Documentation

MBED_DEPRECATED_SINCE ( "mbed-os-5.9", "A Bluetooth controller is not supposed to return the address it used" "to connect. With privacy enabled the controller address may be unknown" "to the host. There is no replacement for this deprecation." ) BLEProtocol const ConnectionParams_t* connectionParams

Address of the local device.

Note:
All bytes of the address are set to 0 if not applicable Connection parameters.

Definition at line 786 of file Gap.h.

Handle_t handle

Connection handle.

Definition at line 748 of file Gap.h.

BLEProtocol::AddressBytes_t localResolvableAddr

resolvable address of the local device.

Note:
All bytes of the address are set to 0 if not applicable

Definition at line 811 of file Gap.h.

BLEProtocol::AddressType_t ownAddrType

Address type of the local device.

Definition at line 776 of file Gap.h.

MBED_DEPRECATED_SINCE ( "mbed-os-5.9", "The type BLEProtocol::AddressType_t is not suitable when privacy is " "enabled. Use peerAddressType instead." ) BLEProtocol BLEProtocol::AddressBytes_t peerAddr

Type of the address the peer uses.

Address of the peer.

Definition at line 761 of file Gap.h.

PeerAddressType_t peerAddressType

Type of the address the peer uses.

Definition at line 816 of file Gap.h.

BLEProtocol::AddressBytes_t peerResolvableAddr

Resolvable address used by the peer.

Note:
All bytes of the address are set to 0 if not applicable

Definition at line 804 of file Gap.h.

Role_t role

Connection Role of the local device.

Definition at line 753 of file Gap.h.

Generated on Tue Aug 9 2022 00:37:33 by  doxygen 1.7.2