wns::events::scheduler::ICommand Class Reference

Base of commands that may be queued using the EventScheduler::queueCommand interface. More...

#include <events/scheduler/ICommand.hpp>

Inheritance diagram for wns::events::scheduler::ICommand:

[legend]

Collaboration diagram for wns::events::scheduler::ICommand:

[legend]

List of all members.

Public Member Functions
virtual bool	isCanceled () const =0
	Return true if the Command was canceled.
virtual bool	isFinished () const =0
	Return true if the Command was executed (no longer queued, no longer running).
virtual bool	isNotSubmitted () const =0
	Return true, if the Command is not submitted to the queue so far (initial state).
virtual bool	isQueued () const =0
	Return true if the Command is queued (waiting for execution).
virtual bool	isRunning () const =0
	Return true if the Command is currently being executed.
virtual	~ICommand ()
Classes
class	CancelException
	If a command can be canceled this exception should be thrown by the command queue. More...

---

Detailed Description

A command runs through the following life cycle:

A command can only be cancled if it is currently Queued. It can't be re-submitted if it was cancled or has finished. The final state is either finished or cancled. The Command that is returned by the queue method will be in state Queued! The user will never see NotSubmitted.

Definition at line 56 of file ICommand.hpp.

---

Constructor & Destructor Documentation

virtual wns::events::scheduler::ICommand::~ICommand

(

)

[inline, virtual]

Definition at line 86 of file ICommand.hpp.

---

Member Function Documentation

virtual bool wns::events::scheduler::ICommand::isCanceled

(

)

const [pure virtual]

Implemented in wns::events::scheduler::CommandQueue::Command, and wns::events::scheduler::NullCommand.

virtual bool wns::events::scheduler::ICommand::isFinished

(

)

const [pure virtual]

Implemented in wns::events::scheduler::CommandQueue::Command, and wns::events::scheduler::NullCommand.

virtual bool wns::events::scheduler::ICommand::isNotSubmitted

(

)

const [pure virtual]

Implemented in wns::events::scheduler::CommandQueue::Command, and wns::events::scheduler::NullCommand.

virtual bool wns::events::scheduler::ICommand::isQueued

(

)

const [pure virtual]

Implemented in wns::events::scheduler::CommandQueue::Command, and wns::events::scheduler::NullCommand.

virtual bool wns::events::scheduler::ICommand::isRunning

(

)

const [pure virtual]

Implemented in wns::events::scheduler::CommandQueue::Command, and wns::events::scheduler::NullCommand.

---

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

• framework/library/src/events/scheduler/ICommand.hpp