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

#include <AbstractApduException.hpp>

Inheritance diagram for keypop::card::AbstractApduException:
Inheritance graph
[legend]
Collaboration diagram for keypop::card::AbstractApduException:
Collaboration graph
[legend]

Public Member Functions

 AbstractApduException (const std::shared_ptr< CardResponseApi > cardResponseApi, const bool isCardResponseComplete, const std::string &message)
 
 AbstractApduException (const std::shared_ptr< CardResponseApi > cardResponseApi, const bool isCardResponseComplete, const std::string &message, const std::shared_ptr< std::exception > cause)
 
const std::shared_ptr< CardResponseApigetCardResponse ()
 
bool isCardResponseComplete () const
 

Detailed Description

Generic exception carrying response data received from the card until a communication failure occurs or an unexpected APDU status code is received.

Since
1.0.0

Definition at line 27 of file AbstractApduException.hpp.

Constructor & Destructor Documentation

◆ AbstractApduException() [1/2]

keypop::card::AbstractApduException::AbstractApduException ( const std::shared_ptr< CardResponseApi cardResponseApi,
const bool  isCardResponseComplete,
const std::string &  message 
)
inline

Builds a new exception embedding card response data.

Parameters
cardResponseApiThe card responses received so far.
isCardResponseCompleteTrue if the number responses equals the number of requests present in the original calypsonet::terminal::card::spi::CardRequestSpi.
messageThe message to identify the exception context.
Since
1.0.0

Definition at line 38 of file AbstractApduException.hpp.

◆ AbstractApduException() [2/2]

keypop::card::AbstractApduException::AbstractApduException ( const std::shared_ptr< CardResponseApi cardResponseApi,
const bool  isCardResponseComplete,
const std::string &  message,
const std::shared_ptr< std::exception >  cause 
)
inline

Builds a new exception embedding card response data with the originating exception.

Parameters
cardResponseApiThe card responses received so far.
isCardResponseCompleteTrue if the number responses equals the number of requests present in the original calypsonet::terminal::card::spi::CardRequestSpi.
messageMessage to identify the exception context.
causeThe cause
Since
1.0.0

Definition at line 57 of file AbstractApduException.hpp.

Member Function Documentation

◆ getCardResponse()

const std::shared_ptr< CardResponseApi > keypop::card::AbstractApduException::getCardResponse ( )
inline

Gets the response data received so far.

Returns
A not null reference.
Since
1.0.0

Definition at line 74 of file AbstractApduException.hpp.

◆ isCardResponseComplete()

bool keypop::card::AbstractApduException::isCardResponseComplete ( ) const
inline

Indicates if all the responses expected from the corresponding calypsonet::terminal::card::spi::CardRequestSpi have been received.

Returns
True if all expected responses have been received.
Since
1.0.0

Definition at line 86 of file AbstractApduException.hpp.


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