Keyple C++  0.9.0
Keyple, an Open Source SDK for Ticketing
Public Member Functions | List of all members
keyple::core::seproxy::plugin::SmartRemovalReader Class Referenceabstract

#include <SmartRemovalReader.h>

Inherits keyple::core::seproxy::plugin::ObservableReaderNotifier.

Inherited by keyple::plugin::pcsc::PcscReaderImpl, and keyple::plugin::stub::StubReaderImpl.

Public Member Functions

virtual ~SmartRemovalReader ()
 
virtual bool waitForCardAbsentNative ()=0
 
virtual void stopWaitForCardRemoval ()
 
- Public Member Functions inherited from keyple::core::seproxy::plugin::ObservableReaderNotifier
 ObservableReaderNotifier ()
 
virtual ~ObservableReaderNotifier ()
 
virtual void notifyObservers (const std::shared_ptr< ReaderEvent > event)=0
 
- Public Member Functions inherited from keyple::core::seproxy::event::ObservableReader
virtual ~ObservableReader ()=default
 
virtual void addObserver (const std::shared_ptr< ReaderObserver > observer)=0
 
virtual void removeObserver (const std::shared_ptr< ReaderObserver > observer)=0
 
virtual void clearObservers ()=0
 
virtual int countObservers () const =0
 
virtual void startSeDetection (const PollingMode pollingMode)=0
 
virtual void stopSeDetection ()=0
 
virtual void setDefaultSelectionRequest (std::shared_ptr< AbstractDefaultSelectionsRequest > defaultSelectionsRequest, const NotificationMode &notificationMode)=0
 
virtual void setDefaultSelectionRequest (std::shared_ptr< AbstractDefaultSelectionsRequest >defaultSelectionsRequest, const NotificationMode &notificationMode, const PollingMode pollingMode)=0
 
virtual void finalizeSeProcessing ()=0
 
- Public Member Functions inherited from keyple::core::seproxy::SeReader
virtual ~SeReader ()
 
virtual bool isSePresent ()=0
 
virtual void addSeProtocolSetting (std::shared_ptr< SeProtocol > seProtocol, const std::string &protocolRule)=0
 
virtual void setSeProtocolSetting (const std::map< std::shared_ptr< SeProtocol >, std::string > &protocolSetting)=0
 
virtual const TransmissionModegetTransmissionMode () const =0
 
virtual bool operator== (const SeReader &o) const
 
- Public Member Functions inherited from keyple::core::seproxy::ProxyElement
virtual ~ProxyElement ()=default
 
virtual const std::string & getName () const =0
 
virtual const std::map< const std::string, const std::string > & getParameters () const =0
 
virtual void setParameter (const std::string &key, const std::string &value)=0
 
virtual void setParameters (const std::map< const std::string, const std::string > &parameters)
 

Additional Inherited Members

- Public Types inherited from keyple::core::seproxy::event::ObservableReader
enum  PollingMode { PollingMode::REPEATING, PollingMode::SINGLESHOT }
 
- Public Attributes inherited from keyple::core::seproxy::plugin::ObservableReaderNotifier
std::atomic< bool > mShuttingDown
 

Detailed Description

Interface implemented by the readers able to handle natively the SE removal process.

Constructor & Destructor Documentation

◆ ~SmartRemovalReader()

virtual keyple::core::seproxy::plugin::SmartRemovalReader::~SmartRemovalReader ( )
inlinevirtual

Member Function Documentation

◆ stopWaitForCardRemoval()

virtual void keyple::core::seproxy::plugin::SmartRemovalReader::stopWaitForCardRemoval ( )
inlinevirtual

Interrupts the waiting of the removal of the SE

Reimplemented in keyple::plugin::stub::StubReaderImpl, and keyple::plugin::pcsc::PcscReaderImpl.

◆ waitForCardAbsentNative()

virtual bool keyple::core::seproxy::plugin::SmartRemovalReader::waitForCardAbsentNative ( )
pure virtual

Wait until the SE disappears.

This method must be implemented by the plugin's reader class when it implements the SmartRemovalReader interface. The reader implementation must manage the SE removal process itself. (for example by using the analogous waitForCardAbsent method in the case of a plugin based on smartcard.io [PC/SC]).

In the case where the reader plugin is not able to handle the SE removal process itself (not implementing the SmartRemovalReader interface, then it is managed by the isSePresentPing method defined in this class.

Returns true if the SE has disappeared.

  • Returns
    presence status
    Exceptions
    KeypleReaderIOExceptionif the communication with the reader or the SE has failed

Implemented in keyple::plugin::stub::StubReaderImpl, and keyple::plugin::pcsc::PcscReaderImpl.


The documentation for this class was generated from the following file: