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

#include <ATTPDUTypes.hpp>

Inheritance diagram for direct_bt::AttElementList:
Collaboration diagram for direct_bt::AttElementList:

Public Member Functions

virtual ~AttElementList () noexcept override
 
virtual jau::nsize_t getElementTotalSize () const =0
 
virtual jau::nsize_t getElementValueSize () const =0
 
virtual jau::nsize_t getElementCount () const =0
 
jau::nsize_t getElementPDUOffset (const jau::nsize_t elementIdx) const
 
uint8_t const * getElementPtr (const jau::nsize_t elementIdx) const
 
std::string getName () const noexcept override
 
- Public Member Functions inherited from direct_bt::AttPDUMsg
 AttPDUMsg (const uint8_t *source, const jau::nsize_t size)
 Persistent memory, w/ ownership . More...
 
 AttPDUMsg (const Opcode opc, const jau::nsize_t size)
 Persistent memory, w/ ownership . More...
 
 AttPDUMsg (const AttPDUMsg &o) noexcept=default
 
 AttPDUMsg (AttPDUMsg &&o) noexcept=default
 
AttPDUMsg & operator= (const AttPDUMsg &o) noexcept=delete
 
AttPDUMsg & operator= (AttPDUMsg &&o) noexcept=delete
 
virtual ~AttPDUMsg () noexcept
 
constexpr Opcode getOpcode () const noexcept
 ATT PDU Format Vol 3, Part F 3.3.1. More...
 
constexpr Opcode getOpMethod () const noexcept
 ATT PDU Format Vol 3, Part F 3.3.1. More...
 
constexpr bool getOpCommandFlag () const noexcept
 ATT PDU Format Vol 3, Part F 3.3.1. More...
 
constexpr bool getOpAuthSigFlag () const noexcept
 ATT PDU Format Vol 3, Part F 3.3.1. More...
 
constexpr jau::nsize_t getAuthSigSize () const noexcept
 ATT PDU Format Vol 3, Part F 3.3.1. More...
 
constexpr jau::nsize_t getPDUParamSize () const noexcept
 ATT PDU Format Vol 3, Part F 3.3.1. More...
 
virtual constexpr_cxx20 jau::nsize_t getPDUValueOffset () const noexcept
 Returns the octet offset to the value segment in this PDU including the mandatory opcode, i.e. More...
 
constexpr_cxx20 jau::nsize_t getPDUMinSize () const noexcept
 Returns this PDU's minimum size, i.e. More...
 
constexpr_cxx20 jau::nsize_t getPDUValueSize () const noexcept
 Returns the octet size of the value attributes in this PDI, i.e. More...
 
constexpr_cxx20 jau::nsize_t getMaxPDUValueSize (const jau::nsize_t mtu) const noexcept
 Returns the theoretical maximum value size of a PDU. More...
 
virtual std::string toString () const noexcept
 

Protected Member Functions

 AttElementList (const uint8_t *source, const jau::nsize_t length)
 
virtual std::string addValueString () const
 
virtual std::string elementString (const jau::nsize_t idx) const
 
std::string valueString () const noexcept override
 
- Protected Member Functions inherited from direct_bt::AttPDUMsg
void checkOpcode (const Opcode expected) const
 
void checkOpcode (const Opcode exp1, const Opcode exp2) const
 
virtual std::string baseString () const noexcept
 

Additional Inherited Members

- Public Types inherited from direct_bt::AttPDUMsg
enum  Opcode : uint8_t {
  Opcode::PDU_UNDEFINED = 0x00, Opcode::METHOD_MASK = 0x3F, Opcode::COMMAND_FLAG = 0x40, Opcode::AUTH_SIGNATURE_FLAG = 0x80,
  Opcode::ERROR_RSP = 0x01, Opcode::EXCHANGE_MTU_REQ = 0x02, Opcode::EXCHANGE_MTU_RSP = 0x03, Opcode::FIND_INFORMATION_REQ = 0x04,
  Opcode::FIND_INFORMATION_RSP = 0x05, Opcode::FIND_BY_TYPE_VALUE_REQ = 0x06, Opcode::FIND_BY_TYPE_VALUE_RSP = 0x07, Opcode::READ_BY_TYPE_REQ = 0x08,
  Opcode::READ_BY_TYPE_RSP = 0x09, Opcode::READ_REQ = 0x0A, Opcode::READ_RSP = 0x0B, Opcode::READ_BLOB_REQ = 0x0C,
  Opcode::READ_BLOB_RSP = 0x0D, Opcode::READ_MULTIPLE_REQ = 0x0E, Opcode::READ_MULTIPLE_RSP = 0x0F, Opcode::READ_BY_GROUP_TYPE_REQ = 0x10,
  Opcode::READ_BY_GROUP_TYPE_RSP = 0x11, Opcode::WRITE_REQ = 0x12, Opcode::WRITE_RSP = 0x13, Opcode::WRITE_CMD = WRITE_REQ + COMMAND_FLAG,
  Opcode::PREPARE_WRITE_REQ = 0x16, Opcode::PREPARE_WRITE_RSP = 0x17, Opcode::EXECUTE_WRITE_REQ = 0x18, Opcode::EXECUTE_WRITE_RSP = 0x19,
  Opcode::READ_MULTIPLE_VARIABLE_REQ = 0x20, Opcode::READ_MULTIPLE_VARIABLE_RSP = 0x21, Opcode::MULTIPLE_HANDLE_VALUE_NTF = 0x23, Opcode::HANDLE_VALUE_NTF = 0x1B,
  Opcode::HANDLE_VALUE_IND = 0x1D, Opcode::HANDLE_VALUE_CFM = 0x1E, Opcode::SIGNED_WRITE_CMD = WRITE_REQ + COMMAND_FLAG + AUTH_SIGNATURE_FLAG
}
 ATT Opcode Summary Vol 3, Part F 3.4.8. More...
 
- Static Public Member Functions inherited from direct_bt::AttPDUMsg
static constexpr uint8_t number (const Opcode rhs) noexcept
 
static std::string getOpcodeString (const Opcode opc) noexcept
 
static std::unique_ptr< const AttPDUMsg > getSpecialized (const uint8_t *buffer, jau::nsize_t const buffer_size) noexcept
 Return a newly created specialized instance pointer to base class. More...
 
- Public Attributes inherited from direct_bt::AttPDUMsg
POctets pdu
 actual received PDU More...
 
const uint64_t ts_creation
 creation timestamp in milliseconds More...
 

Detailed Description

Definition at line 1030 of file ATTPDUTypes.hpp.

Constructor & Destructor Documentation

◆ AttElementList()

direct_bt::AttElementList::AttElementList ( const uint8_t *  source,
const jau::nsize_t  length 
)
inlineprotected

Definition at line 1033 of file ATTPDUTypes.hpp.

◆ ~AttElementList()

virtual direct_bt::AttElementList::~AttElementList ( )
inlineoverridevirtualnoexcept

Definition at line 1051 of file ATTPDUTypes.hpp.

Member Function Documentation

◆ addValueString()

virtual std::string direct_bt::AttElementList::addValueString ( ) const
inlineprotectedvirtual

Reimplemented in direct_bt::AttFindInfoRsp.

Definition at line 1036 of file ATTPDUTypes.hpp.

Here is the caller graph for this function:

◆ elementString()

virtual std::string direct_bt::AttElementList::elementString ( const jau::nsize_t  idx) const
inlineprotectedvirtual

Reimplemented in direct_bt::AttFindInfoRsp, direct_bt::AttReadByGroupTypeRsp, and direct_bt::AttReadByTypeRsp.

Definition at line 1037 of file ATTPDUTypes.hpp.

Here is the caller graph for this function:

◆ getElementCount()

virtual jau::nsize_t direct_bt::AttElementList::getElementCount ( ) const
pure virtual

Implemented in direct_bt::AttFindInfoRsp, direct_bt::AttReadByGroupTypeRsp, and direct_bt::AttReadByTypeRsp.

Here is the caller graph for this function:

◆ getElementPDUOffset()

jau::nsize_t direct_bt::AttElementList::getElementPDUOffset ( const jau::nsize_t  elementIdx) const
inline

Definition at line 1057 of file ATTPDUTypes.hpp.

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

◆ getElementPtr()

uint8_t const* direct_bt::AttElementList::getElementPtr ( const jau::nsize_t  elementIdx) const
inline

Definition at line 1061 of file ATTPDUTypes.hpp.

Here is the call graph for this function:

◆ getElementTotalSize()

virtual jau::nsize_t direct_bt::AttElementList::getElementTotalSize ( ) const
pure virtual

Implemented in direct_bt::AttFindInfoRsp, direct_bt::AttReadByGroupTypeRsp, and direct_bt::AttReadByTypeRsp.

Here is the caller graph for this function:

◆ getElementValueSize()

virtual jau::nsize_t direct_bt::AttElementList::getElementValueSize ( ) const
pure virtual

Implemented in direct_bt::AttFindInfoRsp, direct_bt::AttReadByGroupTypeRsp, and direct_bt::AttReadByTypeRsp.

Here is the caller graph for this function:

◆ getName()

std::string direct_bt::AttElementList::getName ( ) const
inlineoverridevirtualnoexcept

Reimplemented from direct_bt::AttPDUMsg.

Reimplemented in direct_bt::AttFindInfoRsp, direct_bt::AttReadByGroupTypeRsp, and direct_bt::AttReadByTypeRsp.

Definition at line 1065 of file ATTPDUTypes.hpp.

◆ valueString()

std::string direct_bt::AttElementList::valueString ( ) const
inlineoverrideprotectedvirtualnoexcept

Reimplemented from direct_bt::AttPDUMsg.

Definition at line 1039 of file ATTPDUTypes.hpp.

Here is the call graph for this function:
The documentation for this class was generated from the following file:
Generated on Wed Sep 1 2021 22:27:56 for Direct-BT by   doxygen 1.8.18