BlueToe
an alternative GATT/BLE implementation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
bluetoe::link_layer::connection_details Class Reference

data type to store details of an established link layer connection More...

#include <bluetoe/link_layer/include/bluetoe/connection_details.hpp>

Public Member Functions

 connection_details ()=default
 default c'tor leaving all data members in a meaningless state
 
 connection_details (const channel_map &channels, std::uint16_t inter, std::uint16_t lat, std::uint16_t to, unsigned acc)
 construct the data object from its required parts.
 
const channel_mapchannels () const
 channels that a currently in use
 
std::uint16_t interval () const
 connection interval
 
std::uint16_t latency () const
 peripheral latency
 
std::uint16_t timeout () const
 connection timeout
 
unsigned cumulated_sleep_clock_accuracy_ppm () const
 the cumulated sleep clock accuracy in parts per million.
 

Detailed Description

data type to store details of an established link layer connection

Member Function Documentation

◆ cumulated_sleep_clock_accuracy_ppm()

unsigned bluetoe::link_layer::connection_details::cumulated_sleep_clock_accuracy_ppm ( ) const

the cumulated sleep clock accuracy in parts per million.

The cumulated sleep clock accuracy is the sum of the central's and peripheral's accuracy (clock error) and is taken into account for this connection.

◆ interval()

std::uint16_t bluetoe::link_layer::connection_details::interval ( ) const

connection interval

The connection interval of the current connection in units of 1.25ms.

◆ latency()

std::uint16_t bluetoe::link_layer::connection_details::latency ( ) const

peripheral latency

The peripheral defined the number of connection events, the peripheral can skip (do not respond).

◆ timeout()

std::uint16_t bluetoe::link_layer::connection_details::timeout ( ) const

connection timeout

The connection timeout of the current connection in units of 10ms.


The documentation for this class was generated from the following file: