Keypop Card C++ API 2.0.0
Reference Card API for C++
Public Member Functions | Friends | List of all members
keypop::card::CardResponseApi Class Referenceabstract

#include <CardResponseApi.hpp>

Public Member Functions

virtual ~CardResponseApi ()=default
 
virtual const std::vector< std::shared_ptr< ApduResponseApi > > & getApduResponses () const =0
 
virtual bool isLogicalChannelOpen () const =0
 

Friends

std::ostream & operator<< (std::ostream &os, const std::shared_ptr< CardResponseApi > cra)
 

Detailed Description

Group of multiple APDU responses.

Contains a list of keypop::card::ApduResponseApi received from the card in response to a keypop::card::spi::CardRequestSpi and the associated execution status.

The execution status includes the state of the logical channel after the operation and the information saying whether a response is present for all APDUs in the keypop::card::spi::CardRequestSpi.

Responses may be missing when this object is embedded in an keypop::card::AbstractApduException, for example, if the card is removed durin processing or if an unsuccessful status word was received and processing was requested to be stopped in this case (see keypop::card::spi::CardRequestSpi::stopOnUnsuccessfulStatusWord()).

See also
keypop::card::spi::CardRequestSpi
Since
1.0.0

Definition at line 39 of file CardResponseApi.hpp.

Constructor & Destructor Documentation

◆ ~CardResponseApi()

virtual keypop::card::CardResponseApi::~CardResponseApi ( )
virtualdefault

Member Function Documentation

◆ getApduResponses()

virtual const std::vector< std::shared_ptr< ApduResponseApi > > & keypop::card::CardResponseApi::getApduResponses ( ) const
pure virtual

Gets a list of all responses received to the executed APDU requests.

Returns
A not null list, empty if there is no response.
Since
1.0.0

◆ isLogicalChannelOpen()

virtual bool keypop::card::CardResponseApi::isLogicalChannelOpen ( ) const
pure virtual

Gets the state of the logical channel following the execution of the request.

Returns
True if the logical channel is open.
Since
1.0.0

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const std::shared_ptr< CardResponseApi cra 
)
friend

Definition at line 65 of file CardResponseApi.hpp.


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