Keypop Reader C++ API - 2.1.0
Component of the Keypop C++ API
keypop::reader Namespace Reference

Namespaces

namespace  cpp
 
namespace  selection
 
namespace  spi
 
namespace  transaction
 

Classes

class  CardCommunicationException
 Indicates that the communication with the card failed. More...
 
class  CardReader
 Card reader driving the underlying hardware to manage the card detection. More...
 
class  CardReaderEvent
 Card event data container indicating a change of state. More...
 
class  ConfigurableCardReader
 Configurable card reader providing the methods to manage the card protocols. More...
 
class  InvalidCardResponseException
 Indicates that a response received from the card during the command processing was invalid. More...
 
class  ObservableCardReader
 Card reader able to observe the insertion/removal of cards. More...
 
class  ReaderApiFactory
 Reader API Factory. More...
 
class  ReaderCommunicationException
 Indicates that the communication with the reader failed. More...
 
class  ReaderProtocolNotSupportedException
 Indicates that the current card protocol is not supported by the reader. More...
 

Enumerations

enum class  ChannelControl { KEEP_OPEN , CLOSE_AFTER }
 Policy for managing the physical channel after a card request is executed. More...
 

Functions

std::ostream & operator<< (std::ostream &os, const CardReaderEvent::Type type)
 Operator << for CardReaderEvent::Type enum to enable readable logging. More...
 
ChannelControl valueOf (const int value)
 Returns the enum constant of this type with the specified value. More...
 

Enumeration Type Documentation

◆ ChannelControl

enum class keypop::reader::ChannelControl
strong

Policy for managing the physical channel after a card request is executed.

Since
2.1.0
Enumerator
KEEP_OPEN 

Leaves the physical channel open.

Since
2.1.0
CLOSE_AFTER 

Terminates communication with the card.


The physical channel closes instantly or a card removal sequence is initiated depending on the observation mode.

Since
2.1.0

Definition at line 26 of file ChannelControl.hpp.

Function Documentation

◆ operator<<()

std::ostream & keypop::reader::operator<< ( std::ostream &  os,
const CardReaderEvent::Type  type 
)
inline

Operator << for CardReaderEvent::Type enum to enable readable logging.

Parameters
osThe output stream.
typeThe event type.
Returns
The output stream.

Definition at line 114 of file CardReaderEvent.hpp.

◆ valueOf()

ChannelControl keypop::reader::valueOf ( const int  value)
inline

Returns the enum constant of this type with the specified value.

Parameters
valueThe value of the enum constant to be returned.
Returns
The enum constant with the specified value.
Exceptions
std::invalid_argumentIf this enum has no constant with the specified value.
Since
2.1.0

Definition at line 54 of file ChannelControl.hpp.