High level Bluetooth Low Energy API and radio abstraction layer

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

Embed: (wiki syntax)

« Back to documentation index

Gap::ConnectionCallbackParams_t Struct Reference

Gap::ConnectionCallbackParams_t Struct Reference

Encapsulates the parameters of a connection. More...

#include <Gap.h>

Public Member Functions

 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)
 Constructor for ConnectionCallbackParams_t.

Data Fields

Handle_t handle
 The ID for this connection.
Role_t role
 This device's role in the connection.
BLEProtocol::AddressType_t peerAddrType
 The peer's BLE address type.
BLEProtocol::AddressBytes_t peerAddr
 The peer's BLE address.
BLEProtocol::AddressType_t ownAddrType
 This device's BLE address type.
BLEProtocol::AddressBytes_t ownAddr
 This devices's BLE address.
const ConnectionParams_tconnectionParams
 The currently configured connection parameters.

Detailed Description

Encapsulates the parameters of a connection.

This information is passed to the registered handler of connection events. Refer to Gap::onConnection().

Definition at line 218 of file Gap.h.


Constructor & Destructor Documentation

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 
)

Constructor for ConnectionCallbackParams_t.

Parameters:
[in]handleInValue for ConnectionCallbackParams_t::handle
[in]roleInValue for ConnectionCallbackParams_t::role
[in]peerAddrTypeInValue for ConnectionCallbackParams_t::peerAddrType
[in]peerAddrInValue for ConnectionCallbackParams_t::peerAddr
[in]ownAddrTypeInValue for ConnectionCallbackParams_t::ownAddrType
[in]ownAddrInValue for ConnectionCallbackParams_t::ownAddr
[in]connectionParamsInValue for ConnectionCallbackParams_t::connectionParams

Definition at line 245 of file Gap.h.


Field Documentation

The currently configured connection parameters.

Definition at line 225 of file Gap.h.

Handle_t handle

The ID for this connection.

Definition at line 219 of file Gap.h.

This devices's BLE address.

Definition at line 224 of file Gap.h.

This device's BLE address type.

Definition at line 223 of file Gap.h.

The peer's BLE address.

Definition at line 222 of file Gap.h.

The peer's BLE address type.

Definition at line 221 of file Gap.h.

Role_t role

This device's role in the connection.

Definition at line 220 of file Gap.h.