Keyple Card Calypso C++ Library 2.1.0
Reference Terminal Reader API for C++
Public Member Functions | Friends | List of all members
keyple::card::calypso::ApduRequestAdapter Class Referencefinal

#include <ApduRequestAdapter.h>

Inheritance diagram for keyple::card::calypso::ApduRequestAdapter:
Inheritance graph
[legend]
Collaboration diagram for keyple::card::calypso::ApduRequestAdapter:
Collaboration graph
[legend]

Public Member Functions

 ApduRequestAdapter (const std::vector< uint8_t > &apdu)
 
ApduRequestAdapteraddSuccessfulStatusWord (const int successfulStatusWord)
 
const std::vector< int > & getSuccessfulStatusWords () const override
 
ApduRequestAdaptersetInfo (const std::string &info)
 
const std::string & getInfo () const override
 
const std::vector< uint8_t > & getApdu () const override
 

Friends

std::ostream & operator<< (std::ostream &os, const std::shared_ptr< ApduRequestAdapter > ara)
 

Detailed Description

(package-private)
This POJO contains a set of data related to an ISO-7816 APDU command.

Attaching an optional name to the request facilitates the enhancement of the application logs using the toString method.

Since
2.0.0

Definition at line 46 of file ApduRequestAdapter.h.

Constructor & Destructor Documentation

◆ ApduRequestAdapter()

keyple::card::calypso::ApduRequestAdapter::ApduRequestAdapter ( const std::vector< uint8_t > &  apdu)

Builds an APDU request from a raw byte buffer.

The default status words list is initialized with the standard successful code 9000h.

Parameters
apduThe bytes of the APDU's body.
Since
2.0.0

Definition at line 24 of file ApduRequestAdapter.cpp.

Member Function Documentation

◆ addSuccessfulStatusWord()

ApduRequestAdapter & keyple::card::calypso::ApduRequestAdapter::addSuccessfulStatusWord ( const int  successfulStatusWord)

Adds a status word to the list of those that should be considered successful for the APDU.

Note: initially, the list contains the standard successful status word

9000h

.

Parameters
successfulStatusWordA positive int ≤
FFFFh
.
Returns
The object instance.
Since
2.0.0

Definition at line 28 of file ApduRequestAdapter.cpp.

◆ getApdu()

const std::vector< uint8_t > & keyple::card::calypso::ApduRequestAdapter::getApdu ( ) const
override
Since
2.0.0

Definition at line 52 of file ApduRequestAdapter.cpp.

◆ getInfo()

const std::string & keyple::card::calypso::ApduRequestAdapter::getInfo ( ) const
override
Since
2.0.0

Definition at line 47 of file ApduRequestAdapter.cpp.

◆ getSuccessfulStatusWords()

const std::vector< int > & keyple::card::calypso::ApduRequestAdapter::getSuccessfulStatusWords ( ) const
override
Since
2.0.0

Definition at line 35 of file ApduRequestAdapter.cpp.

◆ setInfo()

ApduRequestAdapter & keyple::card::calypso::ApduRequestAdapter::setInfo ( const std::string &  info)

Names the APDU request.

This string is dedicated to improve the readability of logs and should therefore only be invoked conditionally (e.g. when log level >= debug).

Parameters
infoThe request name (free text).
Returns
The object instance.
Since
2.0.0

Definition at line 40 of file ApduRequestAdapter.cpp.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const std::shared_ptr< ApduRequestAdapter ara 
)
friend

Definition at line 58 of file ApduRequestAdapter.cpp.


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