GSsl::Library Class Reference

A RAII class for initialising the underlying ssl library. More...

#include <gssl.h>

List of all members.

Public Member Functions

 Library ()
 Constructor. Initialises the underlying ssl library.
 Library (bool active, const std::string &pem_file)
 Constructor.
 ~Library ()
 Destructor. Cleans up the underlying ssl library.
bool enabled (bool for_serving=false) const
 Returns true if this is a real and enabled ssl library.

Static Public Member Functions

static Libraryinstance ()
 Returns a pointer to a library object, if any.
static std::string credit (const std::string &prefix, const std::string &eol, const std::string &final)
 Returns a credit string.

Friends

class GSsl::Protocol


Detailed Description

A RAII class for initialising the underlying ssl library.

Definition at line 97 of file gssl.h.


Constructor & Destructor Documentation

GSsl::Library::Library (  ) 

Constructor. Initialises the underlying ssl library.

Definition at line 189 of file gssl_openssl.cpp.

GSsl::Library::Library ( bool  active,
const std::string &  pem_file 
)

Constructor.

Initialises the underlying ssl library or not. The pem file is needed if acting as a server.

Definition at line 197 of file gssl_openssl.cpp.

GSsl::Library::~Library (  ) 

Destructor. Cleans up the underlying ssl library.

Definition at line 206 of file gssl_openssl.cpp.


Member Function Documentation

GSsl::Library * GSsl::Library::instance (  )  [static]

Returns a pointer to a library object, if any.

Definition at line 213 of file gssl_openssl.cpp.

Referenced by GSmtp::ServerProtocol::ServerProtocol(), and GNet::SocketProtocol::sslCapable().

bool GSsl::Library::enabled ( bool  for_serving = false  )  const

Returns true if this is a real and enabled ssl library.

Definition at line 218 of file gssl_openssl.cpp.

References GSsl::LibraryImp::pem().

Referenced by GSmtp::ServerProtocol::ServerProtocol().

std::string GSsl::Library::credit ( const std::string &  prefix,
const std::string &  eol,
const std::string &  final 
) [static]

Returns a credit string.

Definition at line 223 of file gssl_openssl.cpp.

Referenced by Main::Admin::newServer(), and Main::CommandLineImp::showCredit().


Friends And Related Function Documentation

friend class GSsl::Protocol [friend]

Definition at line 126 of file gssl.h.


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

Generated on Fri Apr 18 15:56:14 2008 for E-MailRelay by  doxygen 1.5.5