Kleo::Assuan

Kleo::Assuan Namespace Reference

Functions

KLEO_EXPORT bool agentIsRunning ()
 
KLEO_EXPORT std::unique_ptr< GpgME::DefaultAssuanTransaction > sendCommand (std::shared_ptr< GpgME::Context > &assuanContext, const std::string &command, GpgME::Error &err)
 
KLEO_EXPORT std::unique_ptr< GpgME::AssuanTransaction > sendCommand (std::shared_ptr< GpgME::Context > &assuanContext, const std::string &command, std::unique_ptr< GpgME::AssuanTransaction > transaction, GpgME::Error &err)
 
KLEO_EXPORT std::string sendDataCommand (std::shared_ptr< GpgME::Context > assuanContext, const std::string &command, GpgME::Error &err)
 
KLEO_EXPORT std::string sendStatusCommand (const std::shared_ptr< GpgME::Context > &assuanContext, const std::string &command, GpgME::Error &err)
 
KLEO_EXPORT std::vector< std::pair< std::string, std::string > > sendStatusLinesCommand (std::shared_ptr< GpgME::Context > assuanContext, const std::string &command, GpgME::Error &err)
 

Detailed Description

The Assuan namespace collects functions for communicating with the GnuPG agent via the Assuan protocol.

Function Documentation

◆ agentIsRunning()

bool Kleo::Assuan::agentIsRunning ( )

Checks if the GnuPG agent is running and accepts connections.

Definition at line 54 of file assuan.cpp.

◆ sendCommand() [1/2]

KLEO_EXPORT std::unique_ptr<GpgME::DefaultAssuanTransaction> Kleo::Assuan::sendCommand ( std::shared_ptr< GpgME::Context > &  assuanContext,
const std::string &  command,
GpgME::Error &  err 
)

Sends the Assuan command using a default Assuan transaction and the assuanContext to the GnuPG agent and waits for the result.

The returned transaction can be used to retrieve the result. If an error occurred, then err provides details.

◆ sendCommand() [2/2]

std::unique_ptr< GpgME::AssuanTransaction > Kleo::Assuan::sendCommand ( std::shared_ptr< GpgME::Context > &  assuanContext,
const std::string &  command,
std::unique_ptr< GpgME::AssuanTransaction >  transaction,
GpgME::Error &  err 
)

Sends the Assuan command using the transaction and the assuanContext to the GnuPG agent and waits for the result.

The returned transaction can be used to retrieve the result. If an error occurred, then err provides details.

Definition at line 74 of file assuan.cpp.

◆ sendDataCommand()

KLEO_EXPORT std::string Kleo::Assuan::sendDataCommand ( std::shared_ptr< GpgME::Context >  assuanContext,
const std::string &  command,
GpgME::Error &  err 
)

Sends the Assuan command using a default Assuan transaction and the assuanContext to the GnuPG agent and waits for the result.

Returns the data that was sent by GnuPG agent in response to the command. If an error occurred, then err provides details.

◆ sendStatusCommand()

KLEO_EXPORT std::string Kleo::Assuan::sendStatusCommand ( const std::shared_ptr< GpgME::Context > &  assuanContext,
const std::string &  command,
GpgME::Error &  err 
)

Sends the Assuan command using a default Assuan transaction and the assuanContext to the GnuPG agent and waits for the result.

Returns the status that was sent by GnuPG agent in response to the command. If an error occurred, then err provides details.

◆ sendStatusLinesCommand()

KLEO_EXPORT std::vector<std::pair<std::string, std::string> > Kleo::Assuan::sendStatusLinesCommand ( std::shared_ptr< GpgME::Context >  assuanContext,
const std::string &  command,
GpgME::Error &  err 
)

Sends the Assuan command using a default Assuan transaction and the assuanContext to the GnuPG agent and waits for the result.

Returns the status lines that were sent by GnuPG agent in response to the command. If an error occurred, then err provides details.

This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Nov 27 2022 04:11:23 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.