Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

XSECPlatformUtils Class Reference
[Internal Classes]

#include <XSECPlatformUtils.hpp>

Collaboration diagram for XSECPlatformUtils:

Collaboration graph
[legend]
List of all members.

Detailed Description

High level library interface class.

This class is used primarily to initialise the library and communicate high level parameters that will be common to all objects from the class in any given session.

It is primarily a static class.


Static Public Methods

void Initialise (XSECCryptoProvider *p=NULL)
void Terminate (void)
 Terminate.


Static Public Attributes

int initCount
 Number of times initialise has been called.

XSECCryptoProviderg_cryptoProvider
 The main cryptographic provider.


Member Function Documentation

void XSECPlatformUtils::Initialise XSECCryptoProvider   p = NULL [static]
 

\Initialise the library

Must be called prior to using any functions in the library.

Primarily sets up static variables used by all classes in the library.

Parameters:
p  A pointer to a XSECCryptoProvider object that the library should use for cryptographic functions. If p == NULL, the library will instantiate an OpenSSLCryptoProvider object.

void XSECPlatformUtils::Terminate void    [static]
 

Terminate.

Should be called prior to any program exist to allow the library to cleanly delete any memory associated with the library as a whole.

Note:
Do not call this function while any xml-security-c object remain instantiated. The results of doing so is undefined, and could cause bad results.


Member Data Documentation

XSECCryptoProvider* XSECPlatformUtils::g_cryptoProvider [static]
 

The main cryptographic provider.

This pointer can be used to determine the primary crypto provider registered in the library.

Individual signatures can over-ride this default.

int XSECPlatformUtils::initCount [static]
 

Number of times initialise has been called.

initCount can be read by any class or function to determine how many times the library has been initialised.


The documentation for this class was generated from the following file:
Generated on Wed Mar 26 20:59:31 2003 for XML-Security-C by doxygen1.2.18