xronos::sdk::BaseReaction::ShutdownEffect Class Reference

A reaction's effect on Shutdown. More...

#include <xronos/sdk/reaction.hh>

Public Member Functions
	ShutdownEffect (Shutdown &shutdown, const ReactionContext &context)
	Constructor.
void	trigger_shutdown ()
	Terminate the currently running application.

Detailed Description

A reaction's effect on Shutdown.

Through it the handler requests that the application stop.

Constructor & Destructor Documentation

ShutdownEffect()

xronos::sdk::BaseReaction::ShutdownEffect::ShutdownEffect	(	Shutdown &	shutdown,
		const ReactionContext &	context )

Constructor.

Parameters

shutdown	The shutdown event source through which the reaction stops the application.
context	The context of the reaction the effect is declared for. Can be obtained using context().

Member Function Documentation

trigger_shutdown()

void xronos::sdk::BaseReaction::ShutdownEffect::trigger_shutdown

(

)

Terminate the currently running application.

Terminates a running application at the next convenience. After completing all currently active reactions, shutdown emits its event in every reactor. Once all reactions triggered by shutdown are processed, the application terminates.

Exceptions

ValidationError

If called before execution has started.

---

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

• sdk/reaction.hh