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 class	TypeCode : uint8_t { PASSKEY_ENTRY_STARTED = 0x00 , PASSKEY_DIGIT_ENTERED = 0x01 , PASSKEY_DIGIT_ERASED = 0x02 , PASSKEY_CLEARED = 0x03 , PASSKEY_ENTRY_COMPLETED = 0x04 }

Public Types inherited from direct_bt::SMPPDUMsg
enum class	Opcode : uint8_t { UNDEFINED = 0x00 , PAIRING_REQUEST = 0x01 , PAIRING_RESPONSE = 0x02 , PAIRING_CONFIRM = 0x03 , PAIRING_RANDOM = 0x04 , PAIRING_FAILED = 0x05 , ENCRYPTION_INFORMATION = 0x06 , MASTER_IDENTIFICATION = 0x07 , IDENTITY_INFORMATION = 0x08 , IDENTITY_ADDRESS_INFORMATION = 0x09 , SIGNING_INFORMATION = 0x0A , SECURITY_REQUEST = 0x0B , PAIRING_PUBLIC_KEY = 0x0C , PAIRING_DHKEY_CHECK = 0x0D , PAIRING_KEYPRESS_NOTIFICATION = 0x0E }
	SMP Command Codes Vol 3, Part H (SM): 3.3. More...

Public Member Functions
	SMPPasskeyNotification (const TypeCode tc)

	SMPPasskeyNotification (const uint8_t *source, const jau::nsize_t length)

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...

std::string	getName () const noexcept override

constexpr TypeCode	getTypeCode () const noexcept

Public Member Functions inherited from direct_bt::SMPPDUMsg
	SMPPDUMsg (const Opcode opc, const jau::nsize_t size)
	Persistent memory, w/ ownership . More...

	SMPPDUMsg (const uint8_t *source, const jau::nsize_t size)
	Persistent memory, w/ ownership . More...

	SMPPDUMsg (const uint8_t *source, const jau::nsize_t size, const jau::nsize_t min_size)
	Persistent memory, w/ ownership . More...

virtual	~SMPPDUMsg () noexcept=default

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 constexpr_cxx20 jau::nsize_t	getDataSize () const noexcept
	Returns the required data size according to the specified packet, which should be within 0-22 or 64 octets. More...

virtual std::string	getName () 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 uint64_t	getTimestamp () const noexcept

virtual std::string	toString () const noexcept

Static Public Member Functions
static std::string	getTypeCodeString (const TypeCode tc) noexcept

static constexpr uint8_t	number (const TypeCode rhs) noexcept

Static Public Member Functions inherited from direct_bt::SMPPDUMsg
template<class T >
static T *	clone (const T &source) noexcept
	Clone template for convenience, based on derived class's copy-constructor. More...

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...

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::SMPPDUMsg
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
Protected Attributes inherited from direct_bt::SMPPDUMsg
jau::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 1602 of file SMPTypes.hpp.

Member Enumeration Documentation

◆ TypeCode

enum class direct_bt::SMPPasskeyNotification::TypeCode : uint8_t

strong

Enumerator
PASSKEY_ENTRY_STARTED
PASSKEY_DIGIT_ENTERED
PASSKEY_DIGIT_ERASED
PASSKEY_CLEARED
PASSKEY_ENTRY_COMPLETED

Definition at line 1605 of file SMPTypes.hpp.

Constructor & Destructor Documentation

◆ SMPPasskeyNotification() [1/2]

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

inline

Definition at line 1617 of file SMPTypes.hpp.

◆ SMPPasskeyNotification() [2/2]

direct_bt::SMPPasskeyNotification::SMPPasskeyNotification ( const TypeCode tc )

inline

Definition at line 1624 of file SMPTypes.hpp.

Member Function Documentation

◆ number()

static constexpr uint8_t direct_bt::SMPPasskeyNotification::number ( const TypeCode rhs )

inlinestaticconstexprnoexcept

Definition at line 1612 of file SMPTypes.hpp.

◆ getTypeCodeString()

std::string SMPPasskeyNotification::getTypeCodeString ( const TypeCode tc )

staticnoexcept

Definition at line 418 of file SMPTypes.cpp.

◆ getDataSize()

constexpr_cxx20 jau::nsize_t direct_bt::SMPPasskeyNotification::getDataSize ( ) const

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 1631 of file SMPTypes.hpp.

◆ getTypeCode()

constexpr TypeCode direct_bt::SMPPasskeyNotification::getTypeCode ( ) const

inlineconstexprnoexcept

Definition at line 1635 of file SMPTypes.hpp.

◆ getName()

std::string direct_bt::SMPPasskeyNotification::getName ( ) const

inlineoverridevirtualnoexcept

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 1639 of file SMPTypes.hpp.

◆ valueString()

std::string direct_bt::SMPPasskeyNotification::valueString ( ) const

inlineoverrideprotectedvirtualnoexcept

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 1644 of file SMPTypes.hpp.

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

api/direct_bt/SMPTypes.hpp
src/direct_bt/SMPTypes.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TypeCode

Constructor & Destructor Documentation

◆ SMPPasskeyNotification() [1/2]

◆ SMPPasskeyNotification() [2/2]

Member Function Documentation

◆ number()

◆ getTypeCodeString()

◆ getDataSize()

◆ getTypeCode()

◆ getName()

◆ valueString()