Botan::Global_State_Management Namespace Reference

Functions
Library_State &	global_state ()
bool	global_state_exists ()
void	set_global_state (Library_State *new_state)
bool	set_global_state_unless_set (Library_State *new_state)
Library_State *	swap_global_state (Library_State *new_state)

Detailed Description

Namespace for management of the global state

Function Documentation

global_state()

BOTAN_DLL Library_State & Botan::Global_State_Management::global_state

(

)

Access the global library state

Returns

reference to the global library state

Definition at line 32 of file global_state.cpp.

   {
   /* Lazy initialization. Botan still needs to be deinitialized later
      on or memory might leak.
   */
   if(!global_lib_state)
      {
      global_lib_state = new Library_State;
      global_lib_state->initialize(true);
      }
 
   return (*global_lib_state);
   }

References global_state(), and Botan::Library_State::initialize().

Referenced by global_state().

global_state_exists()

BOTAN_DLL bool Botan::Global_State_Management::global_state_exists

(

)

Query if the library is currently initialized

Returns

true iff the library is initialized

Definition at line 84 of file global_state.cpp.

   {
   return (global_lib_state != 0);
   }

References global_state_exists().

Referenced by global_state_exists().

set_global_state()

BOTAN_DLL void Botan::Global_State_Management::set_global_state

(

Library_State *

state

)

Set the global state object

Parameters

state

the new global state to use

Definition at line 49 of file global_state.cpp.

   {
   delete swap_global_state(new_state);
   }

References set_global_state(), and swap_global_state().

Referenced by Botan::LibraryInitializer::deinitialize(), Botan::LibraryInitializer::initialize(), and set_global_state().

set_global_state_unless_set()

BOTAN_DLL bool Botan::Global_State_Management::set_global_state_unless_set

(

Library_State *

state

)

Set the global state object unless it is already set

Parameters

state

the new global state to use

Returns

true if the state parameter is now being used as the global state, or false if one was already set, in which case the parameter was deleted immediately

Definition at line 57 of file global_state.cpp.

   {
   if(global_lib_state)
      {
      delete new_state;
      return false;
      }
   else
      {
      delete swap_global_state(new_state);
      return true;
      }
   }

References set_global_state_unless_set(), and swap_global_state().

Referenced by set_global_state_unless_set().

swap_global_state()

BOTAN_DLL Library_State * Botan::Global_State_Management::swap_global_state

(

Library_State *

new_state

)

Swap the current state for another

Parameters

new_state

the new state object to use

Returns

previous state (or NULL if none)

Definition at line 74 of file global_state.cpp.

   {
   Library_State* old_state = global_lib_state;
   global_lib_state = new_state;
   return old_state;
   }

References swap_global_state().

Referenced by set_global_state(), set_global_state_unless_set(), and swap_global_state().