Type4RemoteInitiator Class Reference

This class is an implementation of the Type 4 tag application. More...

#include <Type4RemoteInitiator.h>

Inheritance diagram for Type4RemoteInitiator:

Public Member Functions
	Type4RemoteInitiator (NFCController *controller, const Span< uint8_t > &buffer)
	Create a Type4RemoteInitiator.
virtual	~Type4RemoteInitiator ()
	Type4RemoteInitiator destructor.
virtual nfc_err_t	connect ()
	Connect the remote endpoint.
virtual nfc_err_t	disconnect ()
	Disconnect the remote endpoint.
virtual bool	is_connected () const
	Check if the endpoint is connected.
virtual bool	is_disconnected () const
	Check if the endpoint is disconnected/lost.
virtual nfc_rf_protocols_bitmask_t	rf_protocols ()
	Get the list of RF protocols supported and activated over the air interface.
virtual nfc_tag_type_t	nfc_tag_type () const
	Retrieve the NFC tag type exposed by the controller to communicate with the initiator.
virtual bool	is_iso7816_supported () const
	Retrieve whether ISO7816 applications are supported by the underlying technology.
virtual void	add_iso7816_application (nfc_tech_iso7816_app_t *application)
	Register an ISO7816 application to be used by the initiator.
virtual bool	is_ndef_supported () const
	Check if this instance actually supports NDEF content.
void	set_delegate (Delegate *delegate)
	Set the delegate that will receive events generated by the initiator.

Protected Member Functions
virtual void	connected ()
	Mark endpoint as connected.
virtual void	disconnected ()
	Mark endpoint as disconnected.
NFCController *	nfc_controller ()
	Retrieve NFCController instance.
const NFCController *	nfc_controller () const
	Retrieve NFCController instance.
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 is an implementation of the Type 4 tag application.

Definition at line 45 of file Type4RemoteInitiator.h.

Constructor & Destructor Documentation

Type4RemoteInitiator()

Type4RemoteInitiator	(	NFCController *	controller,
		const Span< uint8_t > &	buffer
	)

Create a Type4RemoteInitiator.

Parameters

[in]	controller	pointer to the NFCController instance that created this object
[in]	buffer	a bytes array used to store NDEF messages

~Type4RemoteInitiator()

virtual ~Type4RemoteInitiator ( )

virtual

Type4RemoteInitiator destructor.

Member Function Documentation

connect()

virtual nfc_err_t connect ( )

virtual

Connect the remote endpoint.

Returns

NFC_OK or an error code

Implements NFCRemoteEndpoint.

disconnect()

virtual nfc_err_t disconnect ( )

virtual

Disconnect the remote endpoint.

Returns

NFC_OK or an error code

Implements NFCRemoteEndpoint.

is_connected()

virtual bool is_connected ( ) const

virtual

Check if the endpoint is connected.

Returns

whether the endpoint is connected

Implements NFCRemoteEndpoint.

is_disconnected()

virtual bool is_disconnected ( ) const

virtual

Check if the endpoint is disconnected/lost.

Returns

whether the endpoint has been disconnected

Implements NFCRemoteEndpoint.

rf_protocols()

virtual nfc_rf_protocols_bitmask_t rf_protocols ( )

virtual

Get the list of RF protocols supported and activated over the air interface.

Returns

a bitmask of activated protocols

Implements NFCRemoteEndpoint.

nfc_tag_type()

virtual nfc_tag_type_t nfc_tag_type ( ) const

virtual

Retrieve the NFC tag type exposed by the controller to communicate with the initiator.

Returns

the relevant NFC tag type

Implements NFCRemoteInitiator.

is_iso7816_supported()

virtual bool is_iso7816_supported ( ) const

virtual

Retrieve whether ISO7816 applications are supported by the underlying technology.

Returns

whether ISO7816 applications are supported

Implements NFCRemoteInitiator.

add_iso7816_application()

virtual void add_iso7816_application ( nfc_tech_iso7816_app_t *  application )

virtual

Register an ISO7816 application to be used by the initiator.

Parameters

[in]

application

a pointer to an nfc_tech_iso7816_app_t instance as defined by the MuNFC stack

Implements NFCRemoteInitiator.

is_ndef_supported()

virtual bool is_ndef_supported ( ) const

virtual

Check if this instance actually supports NDEF content.

Returns

whether NDEF content is supported

Reimplemented from NFCNDEFCapable.

set_delegate()

void set_delegate ( Delegate *  delegate )

inherited

Set the delegate that will receive events generated by the initiator.

Parameters

[in]

delegate

the delegate instance to use

connected()

virtual void connected ( )

protectedvirtualinherited

Mark endpoint as connected.

Implements NFCRemoteEndpoint.

disconnected()

virtual void disconnected ( )

protectedvirtualinherited

Mark endpoint as disconnected.

Implements NFCRemoteEndpoint.

nfc_controller() [1/2]

NFCController * nfc_controller ( )

protectedinherited

Retrieve NFCController instance.

Returns

a pointer to the NFController instance that created this endpoint.

nfc_controller() [2/2]

const NFCController * nfc_controller ( ) const

protectedinherited

Retrieve NFCController instance.

Returns

a pointer to the NFController instance that created this endpoint.

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