Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Public Member Functions | Protected Member Functions
NFCTarget Class Referenceabstract

This class represents a NFC target (either a remote target when the local controller in in initiator mode, or a target connected through a wired connection). More...

#include <NFCTarget.h>

Inheritance diagram for NFCTarget:
NFCNDEFCapable NFCEEPROM

Data Structures

struct  Delegate
 

Public Member Functions

 NFCTarget (const Span< uint8_t > &buffer)
 Create a NFCTarget. More...
 
virtual ~NFCTarget ()
 NFCTarget destructor. More...
 
virtual void write_ndef_message ()=0
 Write a NDEF message to the target. More...
 
virtual void read_ndef_message ()=0
 Read a NDEF message from the target. More...
 
virtual void erase_ndef_message ()=0
 Erase the NDEF message in the target. More...
 
virtual bool is_ndef_supported () const
 Check if this instance actually supports NDEF content. More...
 

Protected Member Functions

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

Detailed Description

This class represents a NFC target (either a remote target when the local controller in in initiator mode, or a target connected through a wired connection).

A target can be a NFC tag/card, a NFC-enabled phone or other NFC device capable of modulating a RF field.

Definition at line 40 of file NFCTarget.h.

Constructor & Destructor Documentation

NFCTarget ( const Span< uint8_t > &  buffer)

Create a NFCTarget.

Parameters
[in]buffera bytes array used to store NDEF messages
virtual ~NFCTarget ( )
virtual

NFCTarget destructor.

Member Function Documentation

void build_ndef_message ( ac_buffer_builder_t buffer_builder)
protectedinherited

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.
virtual void erase_ndef_message ( )
pure virtual

Erase the NDEF message in the target.

on_ndef_message_erased() will be called on completion.

Implemented in NFCEEPROM.

virtual bool is_ndef_supported ( ) const
virtualinherited

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 ( )
protectedinherited

Retrieve underlying NDEF message instance.

Returns
pointer to NDEF message instance
void parse_ndef_message ( const ac_buffer_t buffer)
protectedinherited

Parse a NDEF message.

Parameters
[in]buffera buffer containing a NDEF message
virtual void read_ndef_message ( )
pure virtual

Read a NDEF message from the target.

on_ndef_message_read() will be called on completion.

Implemented in NFCEEPROM.

virtual void write_ndef_message ( )
pure virtual

Write a NDEF message to the target.

on_ndef_message_written() will be called on completion.

Implemented in NFCEEPROM.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.