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

The IHciFrame class Interface defining all a generic HCI Frame. More...

#include <IHciFrame.h>

Inheritance diagram for IHciFrame:
hci_acl IHciCommandFrame IHciEventFrame 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 command_status CommandComplete disconnection_complete_event extended_inquiry_result_event inquiry_complete_event le_meta_advertising_report_event le_meta_connection_complete_event number_of_completed_packet_event

Public Member Functions

virtual std::string toJson (bool beautify)
 toStyledJson convert frame information to beautiful json format More...
 
virtual Json::Value toJsonObj ()
 toStyledJson convert frame information to beautiful json format More...
 
virtual HCI_PACKET_TYPE_ENUM getPacketType ()
 getPacketType retrieve HCI Packet type (HCI_COMMAND / HCI_ACL_DATA / HCI_SCO_DATA / HCI_EVENT) More...
 
virtual void print ()
 
virtual void clear ()
 
virtual ~IHciFrame ()
 

Detailed Description

The IHciFrame class Interface defining all a generic HCI Frame.

IHciFrame.h HCI frame template

Author
Bertrand Martel
Version
1.0

Constructor & Destructor Documentation

virtual IHciFrame::~IHciFrame ( )
inlinevirtual

Member Function Documentation

virtual void IHciFrame::clear ( )
inlinevirtual

Reimplemented in number_of_completed_packet_event, and le_meta_advertising_report_event.

virtual HCI_PACKET_TYPE_ENUM IHciFrame::getPacketType ( )
inlinevirtual

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

Returns

Reimplemented in IHciCommandFrame, IHciEventFrame, and hci_acl.

virtual void IHciFrame::print ( )
inlinevirtual

Reimplemented in IHciCommandFrame, hci_acl, IHciEventFrame, and CommandComplete.

virtual std::string IHciFrame::toJson ( bool  beautify)
inlinevirtual

toStyledJson convert frame information to beautiful json format

Returns

Reimplemented in IHciCommandFrame, hci_acl, IHciEventFrame, and CommandComplete.

virtual Json::Value IHciFrame::toJsonObj ( )
inlinevirtual

toStyledJson convert frame information to beautiful json format

Returns

Reimplemented in ctrl_bsb_host_buffer_size_cmd, ctrl_bsb_write_page_timeout_cmd, ctrl_bsb_set_event_mask_cmd, ctrl_bsb_write_inquiry_scan_type_cmd, ctrl_bsb_write_scan_enable_cmd, ctrl_bsb_write_extended_inquiry_response_cmd, ctrl_bsb_write_simple_pairing_mode_cmd, ctrl_bsb_write_page_scan_type_cmd, ctrl_bsb_write_iac_lap_cmd, ctrl_bsb_write_voice_settings_cmd, ctrl_bsb_write_inquiry_scan_activity_cmd, ctrl_bsb_write_le_host_support_cmd, ctrl_bsb_write_inquiry_mode_cmd, ctrl_bsb_write_class_of_device_cmd, ctrl_bsb_read_class_of_device_cmd, ctrl_bsb_set_event_filter_cmd, ctrl_bsb_write_local_name_cmd, informational_read_local_extended_features_cmd, le_meta_connection_complete_event, write_default_link_policy_settings_cmd, le_set_advertising_parameters_cmd, extended_inquiry_result_event, le_set_advertising_data_cmd, inquiry_complete_event, le_set_scan_enable_cmd, disconnection_complete_event, le_remove_device_from_resolving_list_cmd, number_of_completed_packet_event, le_set_random_address_cmd, le_set_event_mask_cmd, le_set_scan_parameters_cmd, command_status, le_create_connection_cmd, le_meta_advertising_report_event, le_read_remote_used_features_cmd, link_control_inquiry_cmd, link_control_disconnect_cmd, hci_acl, vendor_specific_cmd, CommandComplete, and void_cmd.

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