Add doc for NFCRemoteEndpoint

pull/7822/head
Donatien Garnier 2018-08-07 18:16:05 +01:00
parent 717b2f599f
commit 97f72cae2f
1 changed files with 30 additions and 0 deletions

View File

@ -23,16 +23,46 @@
namespace mbed { namespace mbed {
namespace nfc { namespace nfc {
/**
* @addtogroup nfc
* @{
*/
/**
* This is the base class for all remote endpoints (initiators and targets)
* addressable over the air interface.
*/
class NFCRemoteEndpoint { class NFCRemoteEndpoint {
public: public:
/**
* The NFCRemoteEndpoint base delegate.
*/
struct Delegate { struct Delegate {
/**
* This method is called when the endpoint is lost (air interface link disconnnected)
*/
virtual void on_lost() {}; virtual void on_lost() {};
}; };
/**
* Check if the endpoint is lost.
* @return whether the endpoint is lost
*/
bool is_lost() const; bool is_lost() const;
/**
* Get the list of RF protocols supported and activated over the air interface.
* @return a bitmask of activated protocols
*/
nfc_rf_protocols_bitmask_t rf_protocols() const; nfc_rf_protocols_bitmask_t rf_protocols() const;
}; };
/**
* @}
*/
} // namespace nfc } // namespace nfc
} // namespace mbed } // namespace mbed