NFCTarget Class Reference

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:

Data Structures
struct	Delegate

Public Member Functions
	NFCTarget (const Span< uint8_t > &buffer)
	Create a NFCTarget.
virtual	~NFCTarget ()
	NFCTarget destructor.
virtual void	write_ndef_message ()=0
	Write a NDEF message to the target.
virtual void	read_ndef_message ()=0
	Read a NDEF message from the target.
virtual void	erase_ndef_message ()=0
	Erase the NDEF message in the target.
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

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 41 of file NFCTarget.h.

Constructor & Destructor Documentation

NFCTarget()

NFCTarget

(

const Span< uint8_t > &

buffer

)

Create a NFCTarget.

Parameters

[in]

buffer

a bytes array used to store NDEF messages

~NFCTarget()

virtual ~NFCTarget ( )

virtual

NFCTarget destructor.

Member Function Documentation

write_ndef_message()

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.

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

erase_ndef_message()

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.

is_ndef_supported()

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 56 of file NFCNDEFCapable.h.

parse_ndef_message()

void parse_ndef_message ( const ac_buffer_t &  buffer )

protectedinherited

Parse a NDEF message.

Parameters

[in]

buffer

a buffer containing a NDEF message

build_ndef_message()

void build_ndef_message ( ac_buffer_builder_t &  buffer_builder )

protectedinherited

Build NDEF message.

Parameters

[in,out]

buffer_builder

a buffer builder in which to create the NDEF message. The backing buffer is guaranteed to be continuous.

ndef_message()

ndef_msg_t * ndef_message ( )

protectedinherited

Retrieve underlying NDEF message instance.

Returns

pointer to NDEF message instance