Rtos API example

Embed: (wiki syntax)

« Back to documentation index

Gap::ConnectionCallbackParams_t Struct Reference

Gap::ConnectionCallbackParams_t Struct Reference

Connection events. 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)
 Construct an instance of ConnectionCallbackParams_t.

Data Fields

Handle_t handle
 Connection handle.
Role_t role
 Connection Role of the local device.
BLEProtocol::AddressType_t peerAddrType
 Type of the address the peer uses.
BLEProtocol::AddressBytes_t peerAddr
 Address of the peer.
BLEProtocol::AddressType_t ownAddrType
 Address type of the local device.
BLEProtocol::AddressBytes_t ownAddr
 Address of the local device.
const ConnectionParams_tconnectionParams
 Connection parameters.

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 629 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 
)

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.
Note:
Constructor is not meant to be called by user code. The BLE API vendor code generates ConnectionCallbackParams_t.

Definition at line 679 of file Gap.h.


Field Documentation

Connection parameters.

Definition at line 663 of file Gap.h.

Connection handle.

Definition at line 633 of file Gap.h.

Address of the local device.

Definition at line 658 of file Gap.h.

Address type of the local device.

Definition at line 653 of file Gap.h.

Address of the peer.

Definition at line 648 of file Gap.h.

Type of the address the peer uses.

Definition at line 643 of file Gap.h.

Connection Role of the local device.

Definition at line 638 of file Gap.h.