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

This is the base class for all remote endpoints (initiators and targets) addressable over the air interface. More...

#include <NFCRemoteEndpoint.h>

Inheritance diagram for NFCRemoteEndpoint:
NFCRemoteInitiator Type4RemoteInitiator

Data Structures

struct  Delegate
 The NFCRemoteEndpoint base delegate. More...
 

Public Member Functions

 NFCRemoteEndpoint (NFCController *controller)
 Create a NFCRemoteEndpointinstance. More...
 
virtual ~NFCRemoteEndpoint ()
 Destructor. More...
 
virtual nfc_err_t connect ()=0
 Connect the remote endpoint. More...
 
virtual nfc_err_t disconnect ()=0
 Disconnect the remote endpoint. More...
 
virtual bool is_connected () const =0
 Check if the endpoint is connected. More...
 
virtual bool is_disconnected () const =0
 Check if the endpoint is disconnected/lost. More...
 
virtual nfc_rf_protocols_bitmask_t rf_protocols ()=0
 Get the list of RF protocols supported and activated over the air interface. More...
 

Protected Member Functions

virtual void connected ()=0
 Mark endpoint as connected. More...
 
virtual void disconnected ()=0
 Mark endpoint as disconnected. More...
 
NFCControllernfc_controller ()
 Retrieve NFCController instance. More...
 
const NFCControllernfc_controller () const
 Retrieve NFCController instance. More...
 

Detailed Description

This is the base class for all remote endpoints (initiators and targets) addressable over the air interface.

Definition at line 39 of file NFCRemoteEndpoint.h.

Constructor & Destructor Documentation

NFCRemoteEndpoint ( NFCController controller)

Create a NFCRemoteEndpointinstance.

Parameters
[in]controllerthe NFCController instance that detected this endpoint
virtual ~NFCRemoteEndpoint ( )
virtual

Destructor.

Member Function Documentation

virtual nfc_err_t connect ( )
pure virtual

Connect the remote endpoint.

Returns
NFC_OK or an error code

Implemented in Type4RemoteInitiator.

virtual void connected ( )
protectedpure virtual

Mark endpoint as connected.

Implemented in NFCRemoteInitiator.

virtual nfc_err_t disconnect ( )
pure virtual

Disconnect the remote endpoint.

Returns
NFC_OK or an error code

Implemented in Type4RemoteInitiator.

virtual void disconnected ( )
protectedpure virtual

Mark endpoint as disconnected.

Implemented in NFCRemoteInitiator.

virtual bool is_connected ( ) const
pure virtual

Check if the endpoint is connected.

Returns
whether the endpoint is connected

Implemented in Type4RemoteInitiator.

virtual bool is_disconnected ( ) const
pure virtual

Check if the endpoint is disconnected/lost.

Returns
whether the endpoint has been disconnected

Implemented in Type4RemoteInitiator.

NFCController* nfc_controller ( )
protected

Retrieve NFCController instance.

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

Retrieve NFCController instance.

Returns
a pointer to the NFController instance that created this endpoint.
virtual nfc_rf_protocols_bitmask_t rf_protocols ( )
pure virtual

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

Returns
a bitmask of activated protocols

Implemented in Type4RemoteInitiator.

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.