Direct-BT  2.3.1
Direct-BT - Direct Bluetooth Programming.
Public Member Functions | Protected Member Functions | List of all members
direct_bt::HCICommandStatusEvent Class Reference

BT Core Spec v5.2: Vol 4, Part E HCI: 7.7.15 Command Status event. More...

#include <HCITypes.hpp>

Inheritance diagram for direct_bt::HCICommandStatusEvent:
Collaboration diagram for direct_bt::HCICommandStatusEvent:

Public Member Functions

 HCICommandStatusEvent (const uint8_t *buffer, const jau::nsize_t buffer_len)
 
HCIStatusCode getStatus () const noexcept
 
uint8_t getNumCommandPackets () const noexcept
 The Number of HCI Command packets which are allowed to be sent to the Controller from the Host. More...
 
HCIOpcode getOpcode () const noexcept
 The associated command. More...
 
bool validate (const HCICommand &cmd) const noexcept override
 
- Public Member Functions inherited from direct_bt::HCIEvent
 HCIEvent (const uint8_t *buffer, const jau::nsize_t buffer_len, const jau::nsize_t exp_param_size)
 Persistent memory, w/ ownership . More...
 
 HCIEvent (const HCIEventType evt, const jau::nsize_t param_size=0)
 Enabling manual construction of event without given value. More...
 
 HCIEvent (const HCIEventType evt, const uint8_t *param, const jau::nsize_t param_size)
 Enabling manual construction of event with given value. More...
 
virtual ~HCIEvent () noexcept
 
uint64_t getTimestamp () const noexcept
 
constexpr HCIEventType getEventType () const noexcept
 
constexpr bool isEvent (HCIEventType t) const noexcept
 
virtual HCIMetaEventType getMetaEventType () const noexcept
 The meta subevent type. More...
 
bool isMetaEvent (HCIMetaEventType t) const noexcept
 
virtual jau::nsize_t getParamSize () const noexcept
 
virtual const uint8_t * getParam () const noexcept
 
- Public Member Functions inherited from direct_bt::HCIPacket
 HCIPacket (const HCIPacketType type, const jau::nsize_t total_packet_size)
 
 HCIPacket (const uint8_t *packet_data, const jau::nsize_t total_packet_size)
 Persistent memory, w/ ownership . More...
 
virtual ~HCIPacket () noexcept
 
constexpr jau::nsize_t getTotalSize () const noexcept
 
TROOctetsgetPDU () noexcept
 Return the underlying octets read only. More...
 
HCIPacketType getPacketType () noexcept
 
std::string toString () const noexcept
 

Protected Member Functions

std::string nameString () const noexcept override
 
std::string baseString () const noexcept override
 
- Protected Member Functions inherited from direct_bt::HCIEvent
std::string valueString () const noexcept override
 
jau::nsize_t getBaseParamSize () const noexcept
 

Additional Inherited Members

- Static Public Member Functions inherited from direct_bt::HCIEvent
static std::unique_ptr< HCIEventgetSpecialized (const uint8_t *buffer, jau::nsize_t const buffer_size) noexcept
 Return a newly created specialized instance pointer to base class. More...
 
- Static Public Member Functions inherited from direct_bt::HCIPacket
template<class T >
static T * clone (const T &source) noexcept
 Clone template for convenience, based on derived class's copy-constructor. More...
 
- Static Protected Member Functions inherited from direct_bt::HCIEvent
static void checkEventType (const HCIEventType has, const HCIEventType min, const HCIEventType max)
 
static void checkEventType (const HCIEventType has, const HCIEventType exp)
 
- Static Protected Member Functions inherited from direct_bt::HCIPacket
static void checkPacketType (const HCIPacketType type)
 
- Protected Attributes inherited from direct_bt::HCIEvent
uint64_t ts_creation
 
- Protected Attributes inherited from direct_bt::HCIPacket
POctets pdu
 

Detailed Description

BT Core Spec v5.2: Vol 4, Part E HCI: 7.7.15 Command Status event.

Size 4 __u8 status; __u8 ncmd; __le16 opcode;

Definition at line 989 of file HCITypes.hpp.

Constructor & Destructor Documentation

◆ HCICommandStatusEvent()

direct_bt::HCICommandStatusEvent::HCICommandStatusEvent ( const uint8_t *  buffer,
const jau::nsize_t  buffer_len 
)
inline

Definition at line 1002 of file HCITypes.hpp.

Here is the call graph for this function:

Member Function Documentation

◆ baseString()

std::string direct_bt::HCICommandStatusEvent::baseString ( ) const
inlineoverrideprotectedvirtualnoexcept

Reimplemented from direct_bt::HCIEvent.

Definition at line 994 of file HCITypes.hpp.

Here is the call graph for this function:

◆ getNumCommandPackets()

uint8_t direct_bt::HCICommandStatusEvent::getNumCommandPackets ( ) const
inlinenoexcept

The Number of HCI Command packets which are allowed to be sent to the Controller from the Host.

Range: 0 to 255

Definition at line 1016 of file HCITypes.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getOpcode()

HCIOpcode direct_bt::HCICommandStatusEvent::getOpcode ( ) const
inlinenoexcept

The associated command.

Definition at line 1021 of file HCITypes.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getStatus()

HCIStatusCode direct_bt::HCICommandStatusEvent::getStatus ( ) const
inlinenoexcept

Definition at line 1008 of file HCITypes.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nameString()

std::string direct_bt::HCICommandStatusEvent::nameString ( ) const
inlineoverrideprotectedvirtualnoexcept

Reimplemented from direct_bt::HCIEvent.

Definition at line 992 of file HCITypes.hpp.

◆ validate()

bool direct_bt::HCICommandStatusEvent::validate ( const HCICommand cmd) const
inlineoverridevirtualnoexcept

Reimplemented from direct_bt::HCIEvent.

Definition at line 1023 of file HCITypes.hpp.

Here is the call graph for this function:

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