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

ATT Protocol PDUs Vol 3, Part F 3.4.7.1 and 3.4.7.2. More...

#include <ATTPDUTypes.hpp>

Inheritance diagram for direct_bt::AttHandleValueRcv:
Collaboration diagram for direct_bt::AttHandleValueRcv:

Public Member Functions

 AttHandleValueRcv (const uint8_t *source, const jau::nsize_t length)
 
constexpr_cxx20 jau::nsize_t getPDUValueOffset () const noexcept override
 opcode + handle More...
 
constexpr uint16_t getHandle () const noexcept
 
constexpr uint8_t const * getValuePtr () const noexcept
 
TOctetSlice const & getValue () const noexcept
 
bool isNotification () const noexcept
 
bool isIndication () const noexcept
 
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
 
AttPDUMsgoperator= (const AttPDUMsg &o) noexcept=delete
 
AttPDUMsgoperator= (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...
 
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

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 AttPDUMsggetSpecialized (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

ATT Protocol PDUs Vol 3, Part F 3.4.7.1 and 3.4.7.2.

A received ATT_HANDLE_VALUE_NTF or ATT_HANDLE_VALUE_IND from server.

Used in:

BT Core Spec v5.2: Vol 3, Part G GATT: 4.10 Characteristic Value Notification

BT Core Spec v5.2: Vol 3, Part G GATT: 4.11 Characteristic Value Indications

Send by server to notify or indicate an ATT value (at any time).

Definition at line 964 of file ATTPDUTypes.hpp.

Constructor & Destructor Documentation

◆ AttHandleValueRcv()

direct_bt::AttHandleValueRcv::AttHandleValueRcv ( const uint8_t *  source,
const jau::nsize_t  length 
)
inline

Definition at line 972 of file ATTPDUTypes.hpp.

Here is the call graph for this function:

Member Function Documentation

◆ getHandle()

constexpr uint16_t direct_bt::AttHandleValueRcv::getHandle ( ) const
inlineconstexprnoexcept

Definition at line 980 of file ATTPDUTypes.hpp.

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

◆ getName()

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

Reimplemented from direct_bt::AttPDUMsg.

Definition at line 994 of file ATTPDUTypes.hpp.

◆ getPDUValueOffset()

constexpr_cxx20 jau::nsize_t direct_bt::AttHandleValueRcv::getPDUValueOffset ( ) const
inlineoverridevirtualnoexcept

opcode + handle

Reimplemented from direct_bt::AttPDUMsg.

Definition at line 978 of file ATTPDUTypes.hpp.

◆ getValue()

TOctetSlice const& direct_bt::AttHandleValueRcv::getValue ( ) const
inlinenoexcept

Definition at line 984 of file ATTPDUTypes.hpp.

◆ getValuePtr()

constexpr uint8_t const* direct_bt::AttHandleValueRcv::getValuePtr ( ) const
inlineconstexprnoexcept

Definition at line 982 of file ATTPDUTypes.hpp.

Here is the call graph for this function:

◆ isIndication()

bool direct_bt::AttHandleValueRcv::isIndication ( ) const
inlinenoexcept

Definition at line 990 of file ATTPDUTypes.hpp.

Here is the call graph for this function:

◆ isNotification()

bool direct_bt::AttHandleValueRcv::isNotification ( ) const
inlinenoexcept

Definition at line 986 of file ATTPDUTypes.hpp.

Here is the call graph for this function:

◆ valueString()

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

Reimplemented from direct_bt::AttPDUMsg.

Definition at line 999 of file ATTPDUTypes.hpp.

Here is the call graph for this function:

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