Direct-BT  2.3.1
Direct-BT - Direct Bluetooth Programming.
Static Public Member Functions | Public Attributes | Friends | List of all members
direct_bt::HCIEnv Class Reference

HCI Singleton runtime environment properties. More...

#include <HCIHandler.hpp>

Inheritance diagram for direct_bt::HCIEnv:
Collaboration diagram for direct_bt::HCIEnv:

Static Public Member Functions

static HCIEnvget () noexcept
 

Public Attributes

const int32_t HCI_READER_THREAD_POLL_TIMEOUT
 Poll timeout for HCI reader thread, defaults to 10s. More...
 
const int32_t HCI_COMMAND_STATUS_REPLY_TIMEOUT
 Timeout for HCI command status replies, excluding command complete, defaults to 3s. More...
 
const int32_t HCI_COMMAND_COMPLETE_REPLY_TIMEOUT
 Timeout for HCI command complete replies, defaults to 10s. More...
 
const int32_t HCI_COMMAND_POLL_PERIOD
 Poll period for certain HCI commands actively waiting for clearance, defaults to 125ms. More...
 
const int32_t HCI_EVT_RING_CAPACITY
 Small ringbuffer capacity for synchronized commands, defaults to 64 messages. More...
 
const bool DEBUG_EVENT
 Debug all HCI event communication. More...
 
const bool DEBUG_SCAN_AD_EIR
 Debug all scanned HCI 'Advertising Data' (AD) 'Extended Inquiry Response' (EIR) packages. More...
 

Friends

class HCIHandler
 

Detailed Description

HCI Singleton runtime environment properties.

Also see DBTEnv::getExplodingProperties(const std::string & prefixDomain).

Definition at line 66 of file HCIHandler.hpp.

Member Function Documentation

◆ get()

static HCIEnv& direct_bt::HCIEnv::get ( )
inlinestaticnoexcept

Definition at line 142 of file HCIHandler.hpp.

Friends And Related Function Documentation

◆ HCIHandler

friend class HCIHandler
friend

Definition at line 67 of file HCIHandler.hpp.

Member Data Documentation

◆ DEBUG_EVENT

const bool direct_bt::HCIEnv::DEBUG_EVENT

Debug all HCI event communication.

Environment variable is 'direct_bt.debug.hci.event'.

Definition at line 127 of file HCIHandler.hpp.

◆ DEBUG_SCAN_AD_EIR

const bool direct_bt::HCIEnv::DEBUG_SCAN_AD_EIR

Debug all scanned HCI 'Advertising Data' (AD) 'Extended Inquiry Response' (EIR) packages.

Environment variable is 'direct_bt.debug.hci.scan_ad_eir'.

Definition at line 135 of file HCIHandler.hpp.

◆ HCI_COMMAND_COMPLETE_REPLY_TIMEOUT

const int32_t direct_bt::HCIEnv::HCI_COMMAND_COMPLETE_REPLY_TIMEOUT

Timeout for HCI command complete replies, defaults to 10s.

This timeout is rather longer, as it may include waiting for pending command complete.

Environment variable is 'direct_bt.hci.cmd.complete.timeout'.

Definition at line 98 of file HCIHandler.hpp.

◆ HCI_COMMAND_POLL_PERIOD

const int32_t direct_bt::HCIEnv::HCI_COMMAND_POLL_PERIOD

Poll period for certain HCI commands actively waiting for clearance, defaults to 125ms.

Used for LE_Create_Connection or Create_Connection when waiting for any pending connection commands or the addressed device's disconnect command to been completed up to HCI_COMMAND_COMPLETE_REPLY_TIMEOUT.

Environment variable is 'direct_bt.hci.cmd.complete.timeout'.

Definition at line 111 of file HCIHandler.hpp.

◆ HCI_COMMAND_STATUS_REPLY_TIMEOUT

const int32_t direct_bt::HCIEnv::HCI_COMMAND_STATUS_REPLY_TIMEOUT

Timeout for HCI command status replies, excluding command complete, defaults to 3s.

Environment variable is 'direct_bt.hci.cmd.status.timeout'.

Definition at line 89 of file HCIHandler.hpp.

◆ HCI_EVT_RING_CAPACITY

const int32_t direct_bt::HCIEnv::HCI_EVT_RING_CAPACITY

Small ringbuffer capacity for synchronized commands, defaults to 64 messages.

Environment variable is 'direct_bt.hci.ringsize'.

Definition at line 119 of file HCIHandler.hpp.

◆ HCI_READER_THREAD_POLL_TIMEOUT

const int32_t direct_bt::HCIEnv::HCI_READER_THREAD_POLL_TIMEOUT

Poll timeout for HCI reader thread, defaults to 10s.

Environment variable is 'direct_bt.hci.reader.timeout'.

Definition at line 81 of file HCIHandler.hpp.


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