Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions | Protected Member Functions
Type4RemoteInitiator Class Reference

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

#include <Type4RemoteInitiator.h>

Inheritance diagram for Type4RemoteInitiator:
NFCRemoteInitiator NFCRemoteEndpoint NFCNDEFCapable

Public Member Functions

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

Protected Member Functions

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

Definition at line 44 of file Type4RemoteInitiator.h.

Constructor & Destructor Documentation

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

Create a Type4RemoteInitiator.

Parameters
[in]controllerpointer to the NFCController instance that created this object
[in]buffera bytes array used to store NDEF messages
virtual ~Type4RemoteInitiator ( )
virtual

Type4RemoteInitiator destructor.

Member Function Documentation

virtual void add_iso7816_application ( nfc_tech_iso7816_app_t application)
virtual

Register an ISO7816 application to be used by the initiator.

Parameters
[in]applicationa pointer to an nfc_tech_iso7816_app_t instance as defined by the MuNFC stack

Implements NFCRemoteInitiator.

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 nfc_err_t connect ( )
virtual

Connect the remote endpoint.

Returns
NFC_OK or an error code

Implements NFCRemoteEndpoint.

virtual void connected ( )
protectedvirtualinherited

Mark endpoint as connected.

Implements NFCRemoteEndpoint.

virtual nfc_err_t disconnect ( )
virtual

Disconnect the remote endpoint.

Returns
NFC_OK or an error code

Implements NFCRemoteEndpoint.

virtual void disconnected ( )
protectedvirtualinherited

Mark endpoint as disconnected.

Implements NFCRemoteEndpoint.

virtual bool is_connected ( ) const
virtual

Check if the endpoint is connected.

Returns
whether the endpoint is connected

Implements NFCRemoteEndpoint.

virtual bool is_disconnected ( ) const
virtual

Check if the endpoint is disconnected/lost.

Returns
whether the endpoint has been disconnected

Implements NFCRemoteEndpoint.

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.

virtual bool is_ndef_supported ( ) const
virtual

Check if this instance actually supports NDEF content.

Returns
whether NDEF content is supported

Reimplemented from NFCNDEFCapable.

ndef_msg_t* ndef_message ( )
protectedinherited

Retrieve underlying NDEF message instance.

Returns
pointer to NDEF message instance
NFCController* nfc_controller ( )
protectedinherited

Retrieve NFCController instance.

Returns
a pointer to the NFController instance that created this endpoint.
const NFCController* nfc_controller ( ) const
protectedinherited

Retrieve NFCController instance.

Returns
a pointer to the NFController instance that created this endpoint.
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.

void parse_ndef_message ( const ac_buffer_t buffer)
protectedinherited

Parse a NDEF message.

Parameters
[in]buffera buffer containing a NDEF message
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.

void set_delegate ( Delegate delegate)
inherited

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

Parameters
[in]delegatethe delegate instance to use
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.