Vol 3, Part H: 3.5.8 Passkey Entry: Keypress notification messages. More...
#include <SMPTypes.hpp>
Inheritance diagram for direct_bt::SMPPasskeyNotification:
Collaboration diagram for direct_bt::SMPPasskeyNotification:
Public Types | |
| enum | TypeCode : uint8_t { TypeCode::PASSKEY_ENTRY_STARTED = 0x00, TypeCode::PASSKEY_DIGIT_ENTERED = 0x01, TypeCode::PASSKEY_DIGIT_ERASED = 0x02, TypeCode::PASSKEY_CLEARED = 0x03, TypeCode::PASSKEY_ENTRY_COMPLETED = 0x04 } |
 Public Types inherited from direct_bt::SMPPDUMsg | |
| enum | Opcode : uint8_t { Opcode::UNDEFINED = 0x00, Opcode::PAIRING_REQUEST = 0x01, Opcode::PAIRING_RESPONSE = 0x02, Opcode::PAIRING_CONFIRM = 0x03, Opcode::PAIRING_RANDOM = 0x04, Opcode::PAIRING_FAILED = 0x05, Opcode::ENCRYPTION_INFORMATION = 0x06, Opcode::MASTER_IDENTIFICATION = 0x07, Opcode::IDENTITY_INFORMATION = 0x08, Opcode::IDENTITY_ADDRESS_INFORMATION = 0x09, Opcode::SIGNING_INFORMATION = 0x0A, Opcode::SECURITY_REQUEST = 0x0B, Opcode::PAIRING_PUBLIC_KEY = 0x0C, Opcode::PAIRING_DHKEY_CHECK = 0x0D, Opcode::PAIRING_KEYPRESS_NOTIFICATION = 0x0E } |
| SMP Command Codes Vol 3, Part H (SM): 3.3. More... | |
Public Member Functions | |
| SMPPasskeyNotification (const uint8_t *source, const jau::nsize_t length) | |
| SMPPasskeyNotification (const TypeCode tc) | |
| constexpr_cxx20 jau::nsize_t | getDataSize () const noexcept override |
| Returns the required data size according to the specified packet, which should be within 0-22 or 64 octets. More... | |
| constexpr TypeCode | getTypeCode () const noexcept |
| constexpr_cxx20 std::string | getName () const noexcept override |
| Public Member Functions inherited from direct_bt::SMPPDUMsg | |
| SMPPDUMsg (const uint8_t *source, const jau::nsize_t size) | |
| Persistent memory, w/ ownership . More... | |
| SMPPDUMsg (const Opcode opc, const jau::nsize_t size) | |
| Persistent memory, w/ ownership . More... | |
| virtual | ~SMPPDUMsg () noexcept |
| constexpr uint64_t | getTimestamp () const noexcept |
| constexpr Opcode | getOpcode () const noexcept |
| SMP Command Codes Vol 3, Part H (SM): 3.3. More... | |
| constexpr jau::nsize_t | getPDUParamSize () const noexcept |
| Returns the actual PDU size less one octet for the opcode, which should result in 0-22 octets or 64 octets. More... | |
| constexpr jau::nsize_t | getDataOffset () const noexcept |
| Returns the octet offset to the data segment in this PDU including the mandatory opcode, i.e. More... | |
| virtual std::string | toString () const noexcept |
Static Public Member Functions | |
| static constexpr uint8_t | number (const TypeCode rhs) noexcept |
| static std::string | getTypeCodeString (const TypeCode tc) noexcept |
| Static Public Member Functions inherited from direct_bt::SMPPDUMsg | |
| static constexpr uint8_t | number (const Opcode rhs) noexcept |
| static std::string | getOpcodeString (const Opcode opc) noexcept |
| static std::unique_ptr< const SMPPDUMsg > | getSpecialized (const uint8_t *buffer, jau::nsize_t const buffer_size) noexcept |
| Return a newly created specialized instance pointer to base class. More... | |
| template<class T > | |
| static T * | clone (const T &source) noexcept |
| Clone template for convenience, based on derived class's copy-constructor. More... | |
Protected Member Functions | |
| std::string | valueString () const noexcept override |
| Protected Member Functions inherited from direct_bt::SMPPDUMsg | |
| void | checkOpcode (const Opcode expected) const |
| void | checkOpcode (const Opcode exp1, const Opcode exp2) const |
| virtual std::string | baseString () const noexcept |
Additional Inherited Members | |
| Protected Attributes inherited from direct_bt::SMPPDUMsg | |
| POctets | pdu |
| actual received PDU More... | |
| uint64_t | ts_creation |
| creation timestamp in milliseconds More... | |
Detailed Description
Vol 3, Part H: 3.5.8 Passkey Entry: Keypress notification messages.
Vol 3 (Host), Part H (SM): 3 (SMP), 3.5 Pairing Methods
Opcode::PAIRING_KEYPRESS_NOTIFICATION
[uint8_t opcode] uint8_t notification_type
Message is used during the Passkey Entry protocol by a device with KeyboardOnly IO capabilities to inform the remote device when keys have been entered or erased.
Definition at line 1379 of file SMPTypes.hpp.
Member Enumeration Documentation
◆ TypeCode
|
strong |
| Enumerator | |
|---|---|
| PASSKEY_ENTRY_STARTED | |
| PASSKEY_DIGIT_ENTERED | |
| PASSKEY_DIGIT_ERASED | |
| PASSKEY_CLEARED | |
| PASSKEY_ENTRY_COMPLETED | |
Definition at line 1382 of file SMPTypes.hpp.
Constructor & Destructor Documentation
◆ SMPPasskeyNotification() [1/2]
|
inline |
◆ SMPPasskeyNotification() [2/2]
|
inline |
Member Function Documentation
◆ getDataSize()
|
inlineoverridevirtualnoexcept |
Returns the required data size according to the specified packet, which should be within 0-22 or 64 octets.
- See also
- SMPPDUMsg::getPDUParamSize()
Reimplemented from direct_bt::SMPPDUMsg.
Definition at line 1404 of file SMPTypes.hpp.
◆ getName()
|
inlineoverridevirtualnoexcept |
Reimplemented from direct_bt::SMPPDUMsg.
Definition at line 1412 of file SMPTypes.hpp.
◆ getTypeCode()
|
inlineconstexprnoexcept |
Definition at line 1408 of file SMPTypes.hpp.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getTypeCodeString()
|
staticnoexcept |
◆ number()
|
inlinestaticconstexprnoexcept |
◆ valueString()
|
inlineoverrideprotectedvirtualnoexcept |
Reimplemented from direct_bt::SMPPDUMsg.
Definition at line 1417 of file SMPTypes.hpp.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
- /usr/local/projects/direct_bt/api/direct_bt/SMPTypes.hpp
- /usr/local/projects/direct_bt/src/direct_bt/SMPTypes.cpp
