Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
TShutdownHandler
Purpose:
This abstract base class defines the shared protocol and members for both the client and server sides of a shutdown handler. Clients of shutdown services should only be concerned with TShutdownHandler, and should refer to that class for complete comments on usage.
Instantiation:
Abstract class; do not allocate.
Deriving Classes:
Do not derive TAbstractShutdownHandler directly. Derive from TShutdownHandler.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
TAbstractShutdownHandler ()
Interface Category:
API.
Purpose:
Default constructor.
Calling Context:
Called by TShutdownHandler constructor.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TAbstractShutdownHandler ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual EVerifyShutdownResponse VerifyShutdown ()
Interface Category:
API.
Purpose:
Called to verify that it is OK to shut down.
Calling Context:
Call by the system shutdown service.
Parameters:
Return Value:
TAbstractShutdownHandler::EVerifyShutdownResponse -Returns kContinueShutdown to the shutdown process (don't cancel), kCancelShutdown to cancel this pending shutdown, or kNeedUserInteraction to suspend the shutdown for user interaction.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
See TShutdownHandler::VerifyShutdown for details.
Member Function: TAbstractShutdownHandler::VerifyShutdownWithUserInteraction
virtual EVerifyShutdownResponse VerifyShutdownWithUserInteraction ()
Interface Category:
API.
Purpose:
Allows the handler to interact with the user to verify a shutdown.
Calling Context:
Called by the system shutdown service when the handler returns kNeedUserInteraction from VerifyShutdown.
Parameters:
Return Value:
TAbstractShutdownHandler::EVerifyShutdownResponse -Returns kContinueShutdown to the shutdown process (don't cancel), or kCancelShutdown to cancel the pending shutdown.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
See TShutdownHandler::VerifyShutdownWithUserInteraction for details.
virtual void PrepareForShutdown ()
Interface Category:
API.
Purpose:
Clients override this member function to save persistent state in preparation for termination.
Calling Context:
Called by the system shutdown service.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
See TShutdownHandler::PrepareForShutdown for details.
virtual void CompleteShutdown ()
Interface Category:
API.
Purpose:
Override this member function to release resources and terminate their service.
Calling Context:
Called by the system shutdown service.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
See TShutdownHandler::CompleteShutdown for details.
virtual void ShutdownCanceled ()
Interface Category:
API.
Purpose:
Override this member function to resume normal processing when a pending shutdown is canceled.
Calling Context:
Called by the system shutdown service when a pending shutdown is canceled.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
See TShutdownHandler::ShutdownCanceled for details.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.