NAME¶
Globus OpenSSL Error API -
Modules¶
Activation
Globus OpenSSL Error Object
Error Object Helper Functions
Detailed Description¶
The globus_gsi_openssl_error functions provide a wrapper to error types defined
by OpenSSL. The types and prototypes for the globus_gsi_openssl_error library
are defined in the
globus_error_openssl.h header. Applications which
use these functions must link with the libglobus_openssl_error library. The
library is distributed with a pkg-config module called
globus-gsi-openssl-error to automatically find header and library paths.
Library Initialization¶
Globus GSI OpenSSL Error uses standard Globus module activation and
deactivation. Before any Globus GSI OpenSSL Error functions are called, the
following function must be called:
globus_module_activate(GLOBUS_GSI_OPENSSL_ERROR_MODULE)
This function returns GLOBUS_SUCCESS if Globus GSI OpenSSL Error was
successfully initialized, and you are therefore allowed to subsequently call
Globus GSI OpenSSL Error functions. Otherwise, an error code is returned, and
Globus GSI OpenSSL Error functions should not be subsequently called. This
function may be called multiple times.
To deactivate Globus GSI OpenSSL Error, the following function must be called:
globus_module_deactivate(GLOBUS_GSI_OPENSSL_ERROR_MODULE)
This function should be called once for each time Globus GSI OpenSSL Error was
activated.
Error Object Data Definition¶
The globus_openssl_error_handle_t is an opaque structure pointer which contains
information about the OpenSSL call which generated an error. The functions in
the
Globus OpenSSL Error Object section of the API are used to create,
manipulate, and destroy Globus OpenSSL Error object data.
Error Object Manipulators¶
The functions in the
Error Object Helper Functions section deal with
Globus error objects constructed with OpenSSL error data. These functions
manipulate the generic globus_object_t representation of an OpenSSL error.
Author¶
Generated automatically by Doxygen for globus_gsi_openssl_error from the source
code.