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
IHciEventFrame Class Reference

IHciEventFrame class Interface defining all a generic HCI Event Frame. More...

#include <IHciEventFrame.h>

Inheritance diagram for IHciEventFrame:
IHciFrame 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

EVENT_ENUM getEventCode ()
 getEventCode retrieve event code More...
 
void print ()
 
std::string toJson (bool beautify)
 toStyledJson convert frame information to beautiful json format More...
 
HCI_PACKET_TYPE_ENUM getPacketType ()
 getPacketType retrieve HCI Packet type (HCI_COMMAND / HCI_ACL_DATA / HCI_SCO_DATA / HCI_EVENT) 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

EVENT_ENUM event_code
 
uint8_t parameter_total_length
 

Detailed Description

IHciEventFrame class Interface defining all a generic HCI Event Frame.

IHciEventFrame.h HCI event frame

Author
Bertrand Martel
Version
1.0

Member Function Documentation

EVENT_ENUM IHciEventFrame::getEventCode ( )
inline

getEventCode retrieve event code

Returns
HCI_PACKET_TYPE_ENUM IHciEventFrame::getPacketType ( )
inlinevirtual

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

Returns

Reimplemented from IHciFrame.

uint8_t IHciEventFrame::getParamterTotalLength ( )
inline

getParamterTotalLength number in bytes of total parameter length

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

Reimplemented from IHciFrame.

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

toStyledJson convert frame information to beautiful json format

Returns

Reimplemented from IHciFrame.

Member Data Documentation

EVENT_ENUM IHciEventFrame::event_code
protected
uint8_t IHciEventFrame::parameter_total_length
protected
The documentation for this class was generated from the following file: