Class: TAbstractShutdownHandlerIdentifier

Declaration: Shutdown.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TShutdownHandlerIdentifier

Purpose:

Abstract base class that defines the common protocol used to identify shutdown handlers both to public clients and internally to the system shutdown service. Clients should not use TAbstractShutdownHandlerIdentifier directly, but instead should use the concrete class TShutdownHandlerIdentifier.

Instantiation:

Don't allocate, abstract class.

Deriving Classes:

Only intended to be derived by the system shutdown service itself. Shutdown handler identifiers are not intended derived by clients.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAbstractShutdownHandlerIdentifier::TAbstractShutdownHandlerIdentifier

TAbstractShutdownHandlerIdentifier (const TShutdownHandlerName & wellKnownHandlerName)
TAbstractShutdownHandlerIdentifier ()
TAbstractShutdownHandlerIdentifier (const TAbstractShutdownHandlerIdentifier & source)

Interface Category:

API.

Purpose:

Constructs an identifier representing a named shutdown handler.
Default constructor.
Copy constructor.

Calling Context:

Called by shutdown clients to create an identifier that refers to a named shutdown handler.
Called by the stream-in operators.
Called to copy an object.

Parameters:

const TShutdownHandlerName & wellKnownHandlerName -The registered shutdown handler name.
Takes no parameters.
const TAbstractShutdownHandlerIdentifier & source -The identifier to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractShutdownHandlerIdentifier::GetShutdownHandlerName

virtual void GetShutdownHandlerName (TShutdownHandlerName &theHandlerName) const

Interface Category:

API.

Purpose:

Returns the registered name of the shutdown handler represented by this identifier. If the handler corresponding to this identifier is not registered or was registered anonymously, then an empty string is returned.

Calling Context:

Called to allow clients to obtain the registered name of a shutdown handler. Seldom used.

Parameters:

TShutdownHandlerName &theHandlerName -Receives the shutdown handler name or an empty string if no names exists for the handler represented by this identifier.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

If the identifier was constructed with a handler name, then that handler name is always available using this member function, regardless of the registration state of the shutdown handler. If the identifier was constructed by the system shutdown service for a specific handler, then the returned name is the name under which that handler is registered, if any. If the handler is not registered or is registered as anonymous, then an empty string is returned.

Member Function: TAbstractShutdownHandlerIdentifier::operator=

TAbstractShutdownHandlerIdentifier & operator =(const TAbstractShutdownHandlerIdentifier & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TAbstractShutdownHandlerIdentifier & source -The source identifier.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractShutdownHandlerIdentifier::~TAbstractShutdownHandlerIdentifier

virtual ~ TAbstractShutdownHandlerIdentifier ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractShutdownHandlerIdentifier::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractShutdownHandlerIdentifier::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractShutdownHandlerIdentifier::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.