Mistake on this page?
Report an issue in GitHub or email us
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. More...
 
 ConnectionCallbackParams_t (Handle_t handleIn, Role_t roleIn, BLEProtocol::AddressType_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. More...
 

Data Fields

Handle_t handle
 Connection handle. More...
 
Role_t role
 Connection Role of the local device. More...
 
BLEProtocol::AddressType_t peerAddrType
 Type of the address the peer uses. More...
 
BLEProtocol::AddressBytes_t peerAddr
 Address of the peer. More...
 
BLEProtocol::AddressType_t ownAddrType
 Address type of the local device. More...
 
BLEProtocol::AddressBytes_t ownAddr
 Address of the local device. More...
 
const ConnectionParams_tconnectionParams
 Connection parameters. More...
 
BLEProtocol::AddressBytes_t peerResolvableAddr
 Resolvable address used by the peer. More...
 
BLEProtocol::AddressBytes_t localResolvableAddr
 resolvable address of the local device. More...
 
PeerAddressType_t peerAddressType
 Type of the address the peer uses. More...
 

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 469 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.
ConnectionCallbackParams_t ( Handle_t  handleIn,
Role_t  roleIn,
BLEProtocol::AddressType_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.
[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.
Deprecated:
The type BLEProtocol::AddressType_t is not suitable when privacy is enabled. Use the constructor that accepts a PeerAddressType_t instead.

Field Documentation

const ConnectionParams_t* connectionParams

Connection parameters.

Definition at line 522 of file Gap.h.

Handle_t handle

Connection handle.

Definition at line 473 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 536 of file Gap.h.

Address of the local device.

Deprecated:
The local address used for the connection may not be known, Therefore this field is not reliable.
Note
All bytes of the address are set to 0 if not applicable

Definition at line 517 of file Gap.h.

Address type of the local device.

Definition at line 501 of file Gap.h.

Address of the peer.

Definition at line 496 of file Gap.h.

PeerAddressType_t peerAddressType

Type of the address the peer uses.

Definition at line 541 of file Gap.h.

Type of the address the peer uses.

Deprecated:
The type BLEProtocol::AddressType_t is not suitable when privacy is enabled. Use peerAddressType instead.

Definition at line 491 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 529 of file Gap.h.

Role_t role

Connection Role of the local device.

Definition at line 478 of file Gap.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.