TAO_Singleton_Manager Class Reference

Manager for TAO library services and singleton cleanup. More...

#include <TAO_Singleton_Manager.h>

Inheritance diagram for TAO_Singleton_Manager:

Collaboration diagram for TAO_Singleton_Manager:

List of all members.

Public Member Functions

virtual int init (void)

Explicitly initialize.

int init (int register_with_object_manager)

virtual int fini (void)

Explicitly destroy.

Static Public Member Functions

static int starting_up (void)

static int shutting_down (void)

static sigset_t * default_mask (void)

static ACE_Thread_Hook * thread_hook (void)

Returns the current thread hook for the process.

static ACE_Thread_Hook * thread_hook (ACE_Thread_Hook *new_thread_hook)

Returns the existing thread hook and assign a new_thread_hook.

static TAO_Singleton_Manager * instance (void)

Accessor to singleton instance.

static int at_exit (ACE_Cleanup *object, void *param=0)

static int at_exit (void *object, ACE_CLEANUP_FUNC cleanup_hook, void *param)

Protected Member Functions

TAO_Singleton_Manager (void)

Force allocation on the heap.

~TAO_Singleton_Manager (void)

Force allocation on the heap.

Private Member Functions

int at_exit_i (void *object, ACE_CLEANUP_FUNC cleanup_hook, void *param)

TAO_Singleton_Manager (const TAO_Singleton_Manager &)

Disallow copying by not implementing the following ...

TAO_Singleton_Manager & operator= (const TAO_Singleton_Manager &)

Disallow copying by not implementing the following ...

Private Attributes

sigset_t * default_mask_

Default signal set used, for example, in ACE_Sig_Guard.

ACE_Thread_Hook * thread_hook_

Thread hook that's used by this process.

ACE_OS_Exit_Info exit_info_

For at_exit support.

int registered_with_object_manager_

Detailed Description

Manager for TAO library services and singleton cleanup.

The TAO_Singleton_Manager is basically simplified version of the ACE_Object_Manager. It is designed specifically to manage singletons created by TAO. For example, singleton instances created by TAO will be automatically registered with the singleton instance of this Singleton Manager.

: This class is necessary to ensure that TAO-specific singletons are isolated to TAO itself, not ACE, for example. The idea is that destruction of the instance of the TAO_Singleton_Manager triggers destruction of all objects/services registered with it.

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_Singleton_Manager::TAO_Singleton_Manager ( void ) [protected]

Force allocation on the heap.

TAO_Singleton_Manager::~TAO_Singleton_Manager ( void ) [protected]

Force allocation on the heap.

TAO_Singleton_Manager::TAO_Singleton_Manager ( const TAO_Singleton_Manager & ) [private]

Disallow copying by not implementing the following ...

Member Function Documentation

int TAO_Singleton_Manager::init ( void ) [virtual]

Explicitly initialize.

Implements ACE_Object_Manager_Base.

int TAO_Singleton_Manager::init ( int register_with_object_manager )

Explicitly initialize the TAO_Singleton_Manager, in addition to explicitly registering (or not registering) with the ACE_Object_Manager.

int TAO_Singleton_Manager::fini ( void ) [virtual]

Explicitly destroy.

Implements ACE_Object_Manager_Base.

int TAO_Singleton_Manager::starting_up ( void ) [static]

Returns 1 before the TAO_Singleton_Manager has been constructed. See ACE_Object_Manager::starting_up for more information.

int TAO_Singleton_Manager::shutting_down ( void ) [static]

Returns 1 after the TAO_Singleton_Manager has been destroyed. See ACE_Object_Manager::shutting_down for more information.

sigset_t * TAO_Singleton_Manager::default_mask ( void ) [static]

Accesses a default signal set used, for example, in ACE_Sig_Guard methods.

ACE_Thread_Hook * TAO_Singleton_Manager::thread_hook ( void ) [static]

Returns the current thread hook for the process.

ACE_Thread_Hook * TAO_Singleton_Manager::thread_hook ( ACE_Thread_Hook * new_thread_hook ) [static]

Returns the existing thread hook and assign a new_thread_hook.

TAO_Singleton_Manager * TAO_Singleton_Manager::instance ( void ) [static]

Accessor to singleton instance.

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE int TAO_Singleton_Manager::at_exit	(	ACE_Cleanup *	object,
		void *	param = `0`
	)			`[static]`

Register an ACE_Cleanup object for cleanup at process termination. The object is deleted via the ace_cleanup_destroyer. If you need more flexiblity, see the other at_exit method below. For OS's that do not have processes, cleanup takes place at the end of main. Returns 0 on success. On failure, returns -1 and sets errno to: EAGAIN if shutting down, ENOMEM if insufficient virtual memory, or EEXIST if the object (or array) had already been registered.

ACE_INLINE int TAO_Singleton_Manager::at_exit	(	void *	object,
		ACE_CLEANUP_FUNC	cleanup_hook,
		void *	param
	)			`[static]`

Register an object (or array) for cleanup at process termination. cleanup_hook points to a (global, or static member) function that is called for the object or array when it to be destroyed. It may perform any necessary cleanup specific for that object or its class. param is passed as the second parameter to the cleanup_hook function; the first parameter is the object (or array) to be destroyed. cleanup_hook, for example, may delete the object (or array). For OS's that do not have processes, this function is the same as <at_thread_exit>. Returns 0 on success. On failure, returns -1 and sets errno to: EAGAIN if shutting down, ENOMEM if insufficient virtual memory, or EEXIST if the object (or array) had already been registered.

TAO_Singleton_Manager& TAO_Singleton_Manager::operator= ( const TAO_Singleton_Manager & ) [private]

Disallow copying by not implementing the following ...

int TAO_Singleton_Manager::at_exit_i	(	void *	object,
		ACE_CLEANUP_FUNC	cleanup_hook,
		void *	param
	)			`[private]`

Register an object or array for deletion at program termination. See description of static version above for return values.

Member Data Documentation

sigset_t* TAO_Singleton_Manager::default_mask_ [private]

Default signal set used, for example, in ACE_Sig_Guard.

ACE_Thread_Hook* TAO_Singleton_Manager::thread_hook_ [private]

Thread hook that's used by this process.

ACE_OS_Exit_Info TAO_Singleton_Manager::exit_info_ [private]

For at_exit support.

int TAO_Singleton_Manager::registered_with_object_manager_ [private]

Indicates if TAO_Singleton_Manager is registered with the ACE_Object_Manager.

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


Public Member Functions
virtual int	init (void)
	Explicitly initialize.
int	init (int register_with_object_manager)
virtual int	fini (void)
	Explicitly destroy.
Static Public Member Functions
static int	starting_up (void)
static int	shutting_down (void)
static sigset_t *	default_mask (void)
static ACE_Thread_Hook *	thread_hook (void)
	Returns the current thread hook for the process.
static ACE_Thread_Hook *	thread_hook (ACE_Thread_Hook *new_thread_hook)
	Returns the existing thread hook and assign a new_thread_hook.
static TAO_Singleton_Manager *	instance (void)
	Accessor to singleton instance.
static int	at_exit (ACE_Cleanup object, void param=0)
static int	at_exit (void object, ACE_CLEANUP_FUNC cleanup_hook, void param)
Protected Member Functions

	TAO_Singleton_Manager (void)
	Force allocation on the heap.
	~TAO_Singleton_Manager (void)
	Force allocation on the heap.
Private Member Functions
int	at_exit_i (void object, ACE_CLEANUP_FUNC cleanup_hook, void param)

	TAO_Singleton_Manager (const TAO_Singleton_Manager &)
	Disallow copying by not implementing the following ...
TAO_Singleton_Manager &	operator= (const TAO_Singleton_Manager &)
	Disallow copying by not implementing the following ...
Private Attributes
sigset_t *	default_mask_
	Default signal set used, for example, in ACE_Sig_Guard.
ACE_Thread_Hook *	thread_hook_
	Thread hook that's used by this process.
ACE_OS_Exit_Info	exit_info_
	For at_exit support.
int	registered_with_object_manager_