winss::Control Class Reference

Orchestrates control. More...

#include <control.hpp>

Public Member Functions
	Control (winss::NotOwningPtr< winss::WaitMultiplexer > multiplexer, DWORD timeout=INFINITE, int timeout_exit_code=1, bool finish_all=true)
	Control constructor. More...
	Control (const Control &)=delete
	No copy. More...
	Control (Control &&)=delete
	No move. More...
bool	IsStarted () const
	Gets if control has started. More...
void	Add (winss::NotOwningPtr< ControlItem > item)
	Add a control item. More...
void	Ready (std::string name)
	Mark a control item as ready. More...
void	Remove (std::string name)
	Remove a control item. More...
int	Start ()
	Starts the orchestration. More...
Control &	operator= (const Control &)=delete
	No copy. More...
Control &	operator= (Control &&)=delete
	No move. More...

Detailed Description

Orchestrates control.

Control is used for the supervisor and svscan. This is to reuse the orchestration logic.

Constructor & Destructor Documentation

winss::Control::Control ( winss::NotOwningPtr< winss::WaitMultiplexer >  multiplexer, DWORD  timeout = INFINITE, int  timeout_exit_code = 1, bool  finish_all = true  )

explicit

Control constructor.

Parameters

multiplexer	The shared multiplexer.
timeout	Orchestration timeout.
timeout_exit_code	exit code for timeout.
finish_all	If all control items must finish. \

References winss::WaitMultiplexer::AddInitCallback(), winss::WaitMultiplexer::AddStopCallback(), winss::WaitMultiplexer::AddTimeoutCallback(), winss::WaitMultiplexer::RemoveTimeoutCallback(), and winss::WaitMultiplexer::Stop().

winss::Control::Control ( const Control &  )

delete

No copy.

winss::Control::Control ( Control &&  )

delete

No move.

Member Function Documentation

void winss::Control::Add

(

winss::NotOwningPtr< ControlItem >

item

)

Add a control item.

Parameters

[in]

item

The item to add to control.

References winss::WaitMultiplexer::AddInitCallback(), winss::ControlItem::GetName(), and winss::ControlItem::Init().

Referenced by winss::OutboundControlItem::OutboundControlItem().

bool winss::Control::IsStarted

(

)

const

Gets if control has started.

Returns

True if started otherwise false.

Control& winss::Control::operator= ( const Control &  )

delete

No copy.

Control& winss::Control::operator= ( Control &&  )

delete

No move.

void winss::Control::Ready

(

std::string

name

)

Mark a control item as ready.

Parameters

[in]

name

The name of the control item.

void winss::Control::Remove

(

std::string

name

)

Remove a control item.

Parameters

[in]

name

The name of the control item.

References winss::WaitMultiplexer::Stop().

int winss::Control::Start

(

)

Starts the orchestration.

References winss::WaitMultiplexer::Start().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/control.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/control.cpp