Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

NFCNDEFCapable Class Reference

NFCNDEFCapable Class Reference
[Nfc]

The base class for all endpoints that can support NDEF content. More...

#include <NFCNDEFCapable.h>

Inherited by NFCRemoteInitiator, and NFCTarget.

Public Member Functions

 NFCNDEFCapable (const Span< uint8_t > &buffer)
 Construct a NFCNDEFCapable instance.
virtual bool is_ndef_supported () const
 Check if this instance actually supports NDEF content.

Protected Member Functions

void parse_ndef_message (const ac_buffer_t &buffer)
 Parse a NDEF message.
void build_ndef_message (ac_buffer_builder_t &buffer_builder)
 Build NDEF message.
ndef_msg_t * ndef_message ()
 Retrieve underlying NDEF message instance.

Detailed Description

The base class for all endpoints that can support NDEF content.

Definition at line 42 of file NFCNDEFCapable.h.


Constructor & Destructor Documentation

NFCNDEFCapable ( const Span< uint8_t > &  buffer )

Construct a NFCNDEFCapable instance.

Parameters:
[in]buffera bytes array used to store NDEF messages

Definition at line 28 of file NFCNDEFCapable.cpp.


Member Function Documentation

void build_ndef_message ( ac_buffer_builder_t &  buffer_builder ) [protected]

Build NDEF message.

Parameters:
[in,out]buffer_buildera buffer builder in which to create the NDEF message. The backing buffer is guaranteed to be continuous.

Definition at line 44 of file NFCNDEFCapable.cpp.

virtual bool is_ndef_supported (  ) const [virtual]

Check if this instance actually supports NDEF content.

Returns:
whether NDEF content is supported

Reimplemented in Type4RemoteInitiator.

Definition at line 55 of file NFCNDEFCapable.h.

ndef_msg_t * ndef_message (  ) [protected]

Retrieve underlying NDEF message instance.

Returns:
pointer to NDEF message instance

Definition at line 77 of file NFCNDEFCapable.cpp.

void parse_ndef_message ( const ac_buffer_t &  buffer ) [protected]

Parse a NDEF message.

Parameters:
[in]buffera buffer containing a NDEF message

Definition at line 33 of file NFCNDEFCapable.cpp.