Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
NFCRemoteEndpoint Class Reference
[Nfc]
This is the base class for all remote endpoints (initiators and targets) addressable over the air interface. More...
#include <NFCRemoteEndpoint.h>
Inherited by NFCRemoteInitiator.
Data Structures | |
| struct | Delegate |
| The NFCRemoteEndpoint base delegate. More... | |
Public Member Functions | |
| NFCRemoteEndpoint (NFCController *controller) | |
| Create a NFCRemoteEndpointinstance. | |
| virtual | ~NFCRemoteEndpoint () |
| Destructor. | |
| virtual nfc_err_t | connect ()=0 |
| Connect the remote endpoint. | |
| virtual nfc_err_t | disconnect ()=0 |
| Disconnect the remote endpoint. | |
| virtual bool | is_connected () const =0 |
| Check if the endpoint is connected. | |
| virtual bool | is_disconnected () const =0 |
| Check if the endpoint is disconnected/lost. | |
| virtual nfc_rf_protocols_bitmask_t | rf_protocols ()=0 |
| Get the list of RF protocols supported and activated over the air interface. | |
Protected Member Functions | |
| virtual void | connected ()=0 |
| Mark endpoint as connected. | |
| virtual void | disconnected ()=0 |
| Mark endpoint as disconnected. | |
| NFCController * | nfc_controller () |
| Retrieve NFCController instance. | |
| const NFCController * | nfc_controller () const |
| Retrieve NFCController instance. | |
Detailed Description
This is the base class for all remote endpoints (initiators and targets) addressable over the air interface.
Definition at line 38 of file NFCRemoteEndpoint.h.
Constructor & Destructor Documentation
| NFCRemoteEndpoint | ( | NFCController * | controller ) |
Create a NFCRemoteEndpointinstance.
- Parameters:
-
[in] controller the NFCController instance that detected this endpoint
Definition at line 29 of file NFCRemoteEndpoint.cpp.
| ~NFCRemoteEndpoint | ( | ) | [virtual] |
Destructor.
Definition at line 34 of file NFCRemoteEndpoint.cpp.
Member Function Documentation
| virtual nfc_err_t connect | ( | ) | [pure virtual] |
| virtual void connected | ( | ) | [protected, pure 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 | ( | ) | [protected, pure 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.
Definition at line 51 of file NFCRemoteEndpoint.cpp.
| const NFCController * nfc_controller | ( | ) | const [protected] |
Retrieve NFCController instance.
- Returns:
- a pointer to the NFController instance that created this endpoint.
Definition at line 56 of file NFCRemoteEndpoint.cpp.
| 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.
Definition at line 39 of file NFCRemoteEndpoint.cpp.
Generated on Tue Aug 9 2022 00:37:39 by
1.7.2