direct_bt::HCICommandCompleteEvent Class Reference

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

#include <HCITypes.hpp>

Inheritance diagram for direct_bt::HCICommandCompleteEvent:

Collaboration diagram for direct_bt::HCICommandCompleteEvent:

Public Member Functions
	HCICommandCompleteEvent (const uint8_t *buffer, const jau::nsize_t buffer_len)
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...
const uint8_t *	getReturnParam () const
jau::nsize_t	getReturnParamSize () const noexcept
bool	validate (const HCICommand &cmd) const noexcept override
Public Member Functions inherited from direct_bt::HCIEvent
	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...
	HCIEvent (const uint8_t *buffer, const jau::nsize_t buffer_len, const jau::nsize_t exp_param_size)
	Persistent memory, w/ ownership . More...
	~HCIEvent () noexcept override=default
constexpr HCIEventType	getEventType () const noexcept
virtual HCIMetaEventType	getMetaEventType () const noexcept
	The meta subevent type. More...
virtual const uint8_t *	getParam () const noexcept
virtual jau::nsize_t	getParamSize () const noexcept
uint64_t	getTimestamp () const noexcept
constexpr bool	isEvent (HCIEventType t) const noexcept
bool	isMetaEvent (HCIMetaEventType t) const noexcept
virtual bool	validate (const HCICommand &cmd) 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=default
HCIPacketType	getPacketType () noexcept
jau::TROOctets &	getPDU () noexcept
	Return the underlying octets read only. More...
constexpr jau::nsize_t	getTotalSize () const noexcept
std::string	toString () const noexcept

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

Additional Inherited Members
Static Public Member Functions inherited from direct_bt::HCIEvent
static std::unique_ptr< HCIEvent >	getSpecialized (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 exp)
static void	checkEventType (const HCIEventType has, const HCIEventType min, const HCIEventType max)
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
jau::POctets	pdu

Detailed Description

BT Core Spec v5.2: Vol 4, Part E HCI: 7.7.14 Command Complete event.

Size 3 + return size __u8 ncmd; __le16 opcode; Return_Paramters of variable length, usually with '__u8 status' first.

Definition at line 1254 of file HCITypes.hpp.

Constructor & Destructor Documentation

HCICommandCompleteEvent()

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

inline

Definition at line 1266 of file HCITypes.hpp.

Member Function Documentation

nameString()

std::string direct_bt::HCICommandCompleteEvent::nameString ( ) const

inlineoverrideprotectedvirtualnoexcept

Reimplemented from direct_bt::HCIEvent.

Definition at line 1257 of file HCITypes.hpp.

baseString()

std::string direct_bt::HCICommandCompleteEvent::baseString ( ) const

inlineoverrideprotectedvirtualnoexcept

Reimplemented from direct_bt::HCIEvent.

Definition at line 1259 of file HCITypes.hpp.

getNumCommandPackets()

uint8_t direct_bt::HCICommandCompleteEvent::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 1278 of file HCITypes.hpp.

Here is the caller graph for this function:

getOpcode()

HCIOpcode direct_bt::HCICommandCompleteEvent::getOpcode ( ) const

inlinenoexcept

The associated command.

Definition at line 1283 of file HCITypes.hpp.

Here is the caller graph for this function:

getReturnParamSize()

jau::nsize_t direct_bt::HCICommandCompleteEvent::getReturnParamSize ( ) const

inlinenoexcept

Definition at line 1285 of file HCITypes.hpp.

getReturnParam()

const uint8_t * direct_bt::HCICommandCompleteEvent::getReturnParam ( ) const

inline

Definition at line 1286 of file HCITypes.hpp.

validate()

bool direct_bt::HCICommandCompleteEvent::validate ( const HCICommand &  cmd ) const

inlineoverridevirtualnoexcept

Reimplemented from direct_bt::HCIEvent.

Definition at line 1288 of file HCITypes.hpp.

---

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

• api/direct_bt/HCITypes.hpp