takashi kadono / Mbed OS Nucleo_446

Dependencies:   ssd1331

Embed: (wiki syntax)

« Back to documentation index

NFCController::Delegate Struct Reference

NFCController::Delegate Struct Reference

The NFCController delegate. More...

#include <NFCController.h>

Public Types

enum  nfc_discovery_terminated_reason_t { nfc_discovery_terminated_completed = 0, nfc_discovery_terminated_canceled, nfc_discovery_terminated_rf_error }
 

A enumeration of causes for the discovery process terminating.

More...

Public Member Functions

virtual void on_discovery_terminated (nfc_discovery_terminated_reason_t reason)
 The discovery process terminated.
virtual void on_nfc_initiator_discovered (const SharedPtr< NFCRemoteInitiator > &nfc_initiator)
 A remote initiator was discovered (the local controller is in target mode).
virtual void on_nfc_target_discovered (const SharedPtr< NFCRemoteTarget > &nfc_target)
 A remote target was discovered (the local controller is in initiator mode).

Detailed Description

The NFCController delegate.

Users of the NFCController class need to implement this delegate's methods to receive events.

Definition at line 60 of file NFCController.h.


Member Enumeration Documentation

A enumeration of causes for the discovery process terminating.

Enumerator:
nfc_discovery_terminated_completed 

Process completed, at least one endpoint was discovered.

nfc_discovery_terminated_canceled 

Process was canceled by the user.

nfc_discovery_terminated_rf_error 

An unexpected error was encountered during an exchange on the air interface.

Definition at line 64 of file NFCController.h.


Member Function Documentation

virtual void on_discovery_terminated ( nfc_discovery_terminated_reason_t  reason ) [virtual]

The discovery process terminated.

Parameters:
[in]reasonthe cause for the termination

Definition at line 74 of file NFCController.h.

virtual void on_nfc_initiator_discovered ( const SharedPtr< NFCRemoteInitiator > &  nfc_initiator ) [virtual]

A remote initiator was discovered (the local controller is in target mode).

Parameters:
[in]nfc_initiatorthe NFCRemoteInitiator instance

Definition at line 80 of file NFCController.h.

virtual void on_nfc_target_discovered ( const SharedPtr< NFCRemoteTarget > &  nfc_target ) [virtual]

A remote target was discovered (the local controller is in initiator mode).

Parameters:
[in]nfc_targetthe NFCRemoteTarget instance

Definition at line 86 of file NFCController.h.