KDE API ReferenceKIO
#include <kssl.h>
Public Member Functions | |
| KSSL (bool init=true) | |
| ~KSSL () | |
| void | close () |
| bool | initialize () |
| bool | reconfig () |
| bool | reInitialize () |
| int | seedWithEGD () |
| void | setAutoReconfig (bool ar) |
| bool | setSession (const KSSLSession *session) |
| bool | setSettings (KSSLSettings *settings) |
| KSSLSettings * | settings () |
| bool | TLSInit () |
Static Public Member Functions | |
| static bool | doesSSLWork () |
Detailed Description
KDE SSL Wrapper Class.
This class implements KDE's SSL support by wrapping OpenSSL.
- See also
- KExtendedSocket, TCPSlaveBase KDE SSL Class
Constructor & Destructor Documentation
| KSSL::KSSL | ( | bool | init = true | ) |
| KSSL::~KSSL | ( | ) |
Member Function Documentation
|
static |
| bool KSSL::initialize | ( | ) |
Initialize OpenSSL.
- Returns
- true on success
This will do nothing if it is already initialized.
- See also
- reInitialize
| bool KSSL::reconfig | ( | ) |
Trigger a reread of KSSL configuration and reInitialize() KSSL.
- Returns
- true on successful reinitalizations
If you setAutoReconfig() to false, then this will simply reInitialize() and not read in the new configuration.
- See also
- setAutoReconfig
| bool KSSL::reInitialize | ( | ) |
Reinitialize OpenSSL.
- Returns
- true on success
This is not generally needed unless you are reusing the KSSL object for a new session.
- See also
- initialize
| int KSSL::seedWithEGD | ( | ) |
| void KSSL::setAutoReconfig | ( | bool | ar | ) |
Enable or disable automatic reconfiguration on initialize().
- Parameters
-
ar Set to false in order to disable auto-reloading of the KSSL configuration during initialize().
By default, KSSL will read its configuration on initialize(). You might want to disable this for performance reasons.
| bool KSSL::setSession | ( | const KSSLSession * | session | ) |
Set an SSL session to use.
This deep copies the session so it doesn't have to remain valid. You need to call it after calling initialize or reInitialize. The ID is cleared in close().
- Parameters
-
session A valid session to reuse. If 0L, it will clear the session ID in memory.
- Returns
- true on success
| bool KSSL::setSettings | ( | KSSLSettings * | settings | ) |
Set a new KSSLSettings instance as the settings.
This deletes the current instance of KSSLSettings.
- Parameters
-
settings A new, valid settings object.
- Returns
- true on success
| KSSLSettings * KSSL::settings | ( | ) |
One is built by the constructor, so this will only return a NULL pointer if you set one with setSettings().
- Returns
- the current settings instance
| bool KSSL::TLSInit | ( | ) |
This is used for applicationss which do STARTTLS or something similar.
It creates a TLS method regardless of the user's settings.
- Returns
- true if TLS is successfully initialized
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:24:55 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
