hci-decoder  1.0
Lightweight Bluetooth HCI decoder library parsing individually HCI frames into JSON format
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
IHciCommandFrame Class Reference

IHciCommandFrame class Interface defining all a generic HCI Command Frame. More...

#include <IHciCommandFrame.h>

Inheritance diagram for IHciCommandFrame:
IHciFrame ctrl_bsb_host_buffer_size_cmd ctrl_bsb_read_class_of_device_cmd ctrl_bsb_set_event_filter_cmd ctrl_bsb_set_event_mask_cmd ctrl_bsb_write_class_of_device_cmd ctrl_bsb_write_extended_inquiry_response_cmd ctrl_bsb_write_iac_lap_cmd ctrl_bsb_write_inquiry_mode_cmd ctrl_bsb_write_inquiry_scan_activity_cmd ctrl_bsb_write_inquiry_scan_type_cmd ctrl_bsb_write_le_host_support_cmd ctrl_bsb_write_local_name_cmd ctrl_bsb_write_page_scan_type_cmd ctrl_bsb_write_page_timeout_cmd ctrl_bsb_write_scan_enable_cmd ctrl_bsb_write_simple_pairing_mode_cmd ctrl_bsb_write_voice_settings_cmd informational_read_local_extended_features_cmd le_create_connection_cmd le_read_remote_used_features_cmd le_remove_device_from_resolving_list_cmd le_set_advertising_data_cmd le_set_advertising_parameters_cmd le_set_event_mask_cmd le_set_random_address_cmd le_set_scan_enable_cmd le_set_scan_parameters_cmd link_control_disconnect_cmd link_control_inquiry_cmd vendor_specific_cmd void_cmd write_default_link_policy_settings_cmd

Public Member Functions

COMMAND_OGF_ENUM getOGF ()
 getOGF retrieve Opcode Group Frame More...
 
int getOCF ()
 getOCF retrieve Opcode Command Frame More...
 
HCI_PACKET_TYPE_ENUM getPacketType ()
 getPacketType retrieve HCI Packet type (HCI_COMMAND / HCI_ACL_DATA / HCI_SCO_DATA / HCI_EVENT) More...
 
void print ()
 
std::string toJson (bool beautify)
 toStyledJson convert frame information to beautiful json format More...
 
uint8_t getParamterTotalLength ()
 getParamterTotalLength number in bytes of total parameter length More...
 
- Public Member Functions inherited from IHciFrame
virtual Json::Value toJsonObj ()
 toStyledJson convert frame information to beautiful json format More...
 
virtual void clear ()
 
virtual ~IHciFrame ()
 

Protected Member Functions

void init (Json::Value &output)
 

Protected Attributes

COMMAND_OGF_ENUM ogf
 
uint8_t ocf
 
uint8_t parameter_total_length
 

Detailed Description

IHciCommandFrame class Interface defining all a generic HCI Command Frame.

IHciCommandFrame.h HCI event frame

Author
Bertrand Martel
Version
1.0

Member Function Documentation

int IHciCommandFrame::getOCF ( )
inline

getOCF retrieve Opcode Command Frame

Returns
COMMAND_OGF_ENUM IHciCommandFrame::getOGF ( )
inline

getOGF retrieve Opcode Group Frame

Returns
HCI_PACKET_TYPE_ENUM IHciCommandFrame::getPacketType ( )
inlinevirtual

getPacketType retrieve HCI Packet type (HCI_COMMAND / HCI_ACL_DATA / HCI_SCO_DATA / HCI_EVENT)

Returns

Reimplemented from IHciFrame.

uint8_t IHciCommandFrame::getParamterTotalLength ( )
inline

getParamterTotalLength number in bytes of total parameter length

Returns
void IHciCommandFrame::init ( Json::Value &  output)
inlineprotected
void IHciCommandFrame::print ( )
inlinevirtual

Reimplemented from IHciFrame.

std::string IHciCommandFrame::toJson ( bool  beautify)
inlinevirtual

toStyledJson convert frame information to beautiful json format

Returns

Reimplemented from IHciFrame.

Member Data Documentation

uint8_t IHciCommandFrame::ocf
protected
COMMAND_OGF_ENUM IHciCommandFrame::ogf
protected
uint8_t IHciCommandFrame::parameter_total_length
protected
The documentation for this class was generated from the following file: