Direct-BT v3.3.0-1-gc2d430c
Direct-BT - Direct Bluetooth Programming.
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
direct_bt::AttErrorRsp Class Referencefinal
Direct-BT System Level API

BT Core Spec v5.2: Vol 3, Part F ATT: 3.4.1.1 ATT_ERROR_RSP. More...

#include <ATTPDUTypes.hpp>

Inheritance diagram for direct_bt::AttErrorRsp:
Collaboration diagram for direct_bt::AttErrorRsp:

Public Types

enum class  ErrorCode : uint8_t {
  NO_ERROR = 0x00 , INVALID_HANDLE = 0x01 , NO_READ_PERM = 0x02 , NO_WRITE_PERM = 0x03 ,
  INVALID_PDU = 0x04 , INSUFF_AUTHENTICATION = 0x05 , UNSUPPORTED_REQUEST = 0x06 , INVALID_OFFSET = 0x07 ,
  INSUFF_AUTHORIZATION = 0x08 , PREPARE_QUEUE_FULL = 0x09 , ATTRIBUTE_NOT_FOUND = 0x0A , ATTRIBUTE_NOT_LONG = 0x0B ,
  INSUFF_ENCRYPTION_KEY_SIZE = 0x0C , INVALID_ATTRIBUTE_VALUE_LEN = 0x0D , UNLIKELY_ERROR = 0x0E , INSUFF_ENCRYPTION = 0x0F ,
  UNSUPPORTED_GROUP_TYPE = 0x10 , INSUFFICIENT_RESOURCES = 0x11 , DB_OUT_OF_SYNC = 0x12 , FORBIDDEN_VALUE = 0x13
}
 
- Public Types inherited from direct_bt::AttPDUMsg
enum class  Opcode : uint8_t {
  PDU_UNDEFINED = 0x00 , METHOD_MASK = 0x3F , COMMAND_FLAG = 0x40 , AUTH_SIGNATURE_FLAG = 0x80 ,
  ERROR_RSP = 0x01 , EXCHANGE_MTU_REQ = 0x02 , EXCHANGE_MTU_RSP = 0x03 , FIND_INFORMATION_REQ = 0x04 ,
  FIND_INFORMATION_RSP = 0x05 , FIND_BY_TYPE_VALUE_REQ = 0x06 , FIND_BY_TYPE_VALUE_RSP = 0x07 , READ_BY_TYPE_REQ = 0x08 ,
  READ_BY_TYPE_RSP = 0x09 , READ_REQ = 0x0A , READ_RSP = 0x0B , READ_BLOB_REQ = 0x0C ,
  READ_BLOB_RSP = 0x0D , READ_MULTIPLE_REQ = 0x0E , READ_MULTIPLE_RSP = 0x0F , READ_BY_GROUP_TYPE_REQ = 0x10 ,
  READ_BY_GROUP_TYPE_RSP = 0x11 , WRITE_REQ = 0x12 , WRITE_RSP = 0x13 , WRITE_CMD = WRITE_REQ + COMMAND_FLAG ,
  PREPARE_WRITE_REQ = 0x16 , PREPARE_WRITE_RSP = 0x17 , EXECUTE_WRITE_REQ = 0x18 , EXECUTE_WRITE_RSP = 0x19 ,
  READ_MULTIPLE_VARIABLE_REQ = 0x20 , READ_MULTIPLE_VARIABLE_RSP = 0x21 , MULTIPLE_HANDLE_VALUE_NTF = 0x23 , HANDLE_VALUE_NTF = 0x1B ,
  HANDLE_VALUE_IND = 0x1D , HANDLE_VALUE_CFM = 0x1E , SIGNED_WRITE_CMD = WRITE_REQ + COMMAND_FLAG + AUTH_SIGNATURE_FLAG
}
 ATT Opcode Summary Vol 3, Part F 3.4.8. More...
 
enum class  OpcodeType : uint8_t {
  UNDEFINED = 0 , REQUEST = 1 , RESPONSE = 2 , NOTIFICATION = 3 ,
  INDICATION = 4
}
 
enum class  ReqRespType : bool { REQUEST = true , RESPONSE = false }
 

Public Member Functions

 AttErrorRsp (const ErrorCode error_code, const Opcode cause_opc, const uint16_t cause_handle)
 
 AttErrorRsp (const uint8_t *source, const jau::nsize_t length)
 
constexpr uint16_t getCausingHandle () const noexcept
 
constexpr Opcode getCausingOpcode () const noexcept
 
constexpr ErrorCode getErrorCode () const noexcept
 
std::string getName () const noexcept override
 
constexpr_cxx20 jau::nsize_t getPDUValueOffset () const noexcept override
 opcode + reqOpcodeCause + handleCause + errorCode More...
 
- Public Member Functions inherited from direct_bt::AttPDUMsg
 AttPDUMsg (AttPDUMsg &&o) noexcept=default
 
 AttPDUMsg (const AttPDUMsg &o)=default
 
 AttPDUMsg (const Opcode opc, const jau::nsize_t size)
 Persistent memory, w/ ownership . More...
 
 AttPDUMsg (const uint8_t *source, const jau::nsize_t size)
 Persistent memory, w/ ownership . More...
 
virtual ~AttPDUMsg () noexcept=default
 
constexpr jau::nsize_t getAuthSigSize () const noexcept
 ATT PDU Format Vol 3, Part F 3.3.1. More...
 
constexpr_cxx20 jau::nsize_t getMaxPDUValueSize (const jau::nsize_t mtu) const noexcept
 Returns the theoretical maximum value size of a PDU's attribute value. More...
 
virtual std::string getName () const noexcept
 
constexpr bool getOpAuthSigFlag () const noexcept
 ATT PDU Format Vol 3, Part F 3.3.1. More...
 
constexpr Opcode getOpcode () 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 Opcode getOpMethod () 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 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 getPDUValueSize () const noexcept
 Returns the net octet size of this PDU's attributes value, i.e. More...
 
AttPDUMsg & operator= (AttPDUMsg &&o) noexcept=delete
 
AttPDUMsg & operator= (const AttPDUMsg &o) noexcept=delete
 
virtual std::string toString () const noexcept
 

Static Public Member Functions

static std::string getErrorCodeString (const ErrorCode errorCode) noexcept
 
static constexpr uint8_t number (const ErrorCode rhs) noexcept
 
- Static Public Member Functions inherited from direct_bt::AttPDUMsg
static constexpr OpcodeType get_type (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...
 
static constexpr bool is_request (const ReqRespType rhs) noexcept
 
static constexpr uint8_t number (const Opcode rhs) noexcept
 

Protected Member Functions

std::string valueString () const noexcept override
 
- Protected Member Functions inherited from direct_bt::AttPDUMsg
virtual std::string baseString () const noexcept
 
void check_range ()
 
void checkOpcode (const Opcode exp1, const Opcode exp2) const
 
void checkOpcode (const Opcode expected) const
 
virtual std::string valueString () const noexcept
 

Additional Inherited Members

- Public Attributes inherited from direct_bt::AttPDUMsg
jau::POctets pdu
 actual received PDU More...
 
const uint64_t ts_creation
 creation timestamp in milliseconds More...
 

Detailed Description

BT Core Spec v5.2: Vol 3, Part F ATT: 3.4.1.1 ATT_ERROR_RSP.

Used to send a error reply for any request.

Definition at line 702 of file ATTPDUTypes.hpp.

Member Enumeration Documentation

◆ ErrorCode

enum class direct_bt::AttErrorRsp::ErrorCode : uint8_t
strong
Enumerator
NO_ERROR 

Direct-BT's extension to indicate no error.

INVALID_HANDLE 
NO_READ_PERM 
NO_WRITE_PERM 
INVALID_PDU 
INSUFF_AUTHENTICATION 
UNSUPPORTED_REQUEST 
INVALID_OFFSET 
INSUFF_AUTHORIZATION 
PREPARE_QUEUE_FULL 
ATTRIBUTE_NOT_FOUND 
ATTRIBUTE_NOT_LONG 
INSUFF_ENCRYPTION_KEY_SIZE 
INVALID_ATTRIBUTE_VALUE_LEN 
UNLIKELY_ERROR 
INSUFF_ENCRYPTION 
UNSUPPORTED_GROUP_TYPE 
INSUFFICIENT_RESOURCES 
DB_OUT_OF_SYNC 
FORBIDDEN_VALUE 

Definition at line 705 of file ATTPDUTypes.hpp.

Constructor & Destructor Documentation

◆ AttErrorRsp() [1/2]

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

Definition at line 733 of file ATTPDUTypes.hpp.

◆ AttErrorRsp() [2/2]

direct_bt::AttErrorRsp::AttErrorRsp ( const ErrorCode  error_code,
const Opcode  cause_opc,
const uint16_t  cause_handle 
)
inline

Definition at line 738 of file ATTPDUTypes.hpp.

Member Function Documentation

◆ number()

static constexpr uint8_t direct_bt::AttErrorRsp::number ( const ErrorCode  rhs)
inlinestaticconstexprnoexcept

Definition at line 728 of file ATTPDUTypes.hpp.

Here is the caller graph for this function:

◆ getErrorCodeString()

std::string AttErrorRsp::getErrorCodeString ( const ErrorCode  errorCode)
staticnoexcept

Definition at line 86 of file ATTPDUTypes.cpp.

Here is the caller graph for this function:

◆ getPDUValueOffset()

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

opcode + reqOpcodeCause + handleCause + errorCode

Reimplemented from direct_bt::AttPDUMsg.

Definition at line 748 of file ATTPDUTypes.hpp.

◆ getCausingOpcode()

constexpr Opcode direct_bt::AttErrorRsp::getCausingOpcode ( ) const
inlineconstexprnoexcept

Definition at line 750 of file ATTPDUTypes.hpp.

Here is the caller graph for this function:

◆ getCausingHandle()

constexpr uint16_t direct_bt::AttErrorRsp::getCausingHandle ( ) const
inlineconstexprnoexcept

Definition at line 752 of file ATTPDUTypes.hpp.

Here is the caller graph for this function:

◆ getErrorCode()

constexpr ErrorCode direct_bt::AttErrorRsp::getErrorCode ( ) const
inlineconstexprnoexcept

Definition at line 754 of file ATTPDUTypes.hpp.

Here is the caller graph for this function:

◆ getName()

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

Reimplemented from direct_bt::AttPDUMsg.

Definition at line 756 of file ATTPDUTypes.hpp.

◆ valueString()

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

Reimplemented from direct_bt::AttPDUMsg.

Definition at line 761 of file ATTPDUTypes.hpp.

The documentation for this class was generated from the following files:
Generated on Sun May 12 2024 09:25:38 for Direct-BT by doxygen 1.9.4