ServerStateLifetimeManagement::InitiateShutdown Method

Initiates the shut down process.

Syntax

public:
void InitiateShutdown()  

Return value

None.

Remarks

InitiateShutdown should be called when either of the following happens:

• The server code determines the game server instance is no longer needed and should shut down
• The Xbox Live Compute platform indicates the server instance should shut down by calling the shutdown callback registered with RegisterShutdownCallback

After calling InitiateShutdown titles have five minutes to save their state and then call ServerStateLifetimeManagement::Startup Method. If the title has not called ServerStateLifetimeManagement::Startup Method within five minutes it will be automatically shut down.

To ensure that the game will shutdown correctly in all cases, please enclose your InitiateShutdown and Shutdown and the code inside the shutdown callback, in an exception handler. There may be an exception thrown in certain race conditions which can be safely ignored.

Requirements

Header: Declared in ServerStateLifetimeManagement.h.

Library: Use GSDK110.lib (VS 2012) or GSDK100.lib (VS 2010).

See also

ServerStateLifetimeManagement