carma::util::ConfigureImr Class Reference

This class is responsible for taking server information retrieved from the ImrConfigHandlers class (which reads it from an XML file) and adding the servers to the IMR. More...

#include <carma/util/ConfigureImr.h>

Public Member Functions
void	addOads ()
	Add OADs Take all oads input to this class and add them to the IMR. More...
void	addServers (const std::string &oad, const std::string prioritySpec="0-9", unsigned long SleepyTimeMs=0)
	Add Servers Take all servers specific to the input OAD and add them to the IMR. More...
void	clean (const std::string &oad)
	Clean IMR of currently registered servers and non-running oads This routine stops all currently running servers on the imr and then removes the servers and oad entries from the IMR. More...
	ConfigureImr (carma::corba::Client &client, std::string imrHost, carma::util::domainType domain)
	Constructor. More...
void	resetServers (const std::string &oad)
	Reset servers Reset all servers associated with input OAD. More...
void	startServers (const std::string &oad, const std::string prioritySpec="0-9", unsigned int waitForRunningMs=0, unsigned long sleepyTimeMs=0, bool waitForEachPriorityStage=false, unsigned long waitAfterEachStageMs=0, bool verbose=true)
	Start servers Start all servers associated with input OAD. More...
void	stopServers (const std::string &oad, const std::string prioritySpec="9-0", unsigned int waitForStoppedMs=0, bool waitForEachPriorityStage=false)
	Stop servers Stop all servers associated with input OAD. More...
virtual	~ConfigureImr ()
	Destructor. More...

Detailed Description

This class is responsible for taking server information retrieved from the ImrConfigHandlers class (which reads it from an XML file) and adding the servers to the IMR.

Definition at line 25 of file ConfigureImr.h.

Constructor & Destructor Documentation

carma::util::ConfigureImr::ConfigureImr	(	carma::corba::Client &	client,
		std::string	imrHost,
		carma::util::domainType	domain
	)

Constructor.

Parameters

client	Initialized corba::Client reference.
imrHost	hosntame of IMR
domain	Structure containing oads/servers to be added to the IMR.

virtual carma::util::ConfigureImr::~ConfigureImr ( )

virtual

Destructor.

Member Function Documentation

void carma::util::ConfigureImr::addOads

(

)

Add OADs Take all oads input to this class and add them to the IMR.

void carma::util::ConfigureImr::addServers	(	const std::string &	oad,
		const std::string	prioritySpec = "0-9",
		unsigned long	SleepyTimeMs = 0
	)

Add Servers Take all servers specific to the input OAD and add them to the IMR.

Parameters

oad	Hostname of oad to start servers on.
sleepyTime	Time in milliseconds to sleep between adding servers.

void carma::util::ConfigureImr::clean

(

const std::string &

oad

)

Clean IMR of currently registered servers and non-running oads This routine stops all currently running servers on the imr and then removes the servers and oad entries from the IMR.

void carma::util::ConfigureImr::resetServers

(

const std::string &

oad

)

Reset servers Reset all servers associated with input OAD.

void carma::util::ConfigureImr::startServers	(	const std::string &	oad,
		const std::string	prioritySpec = "0-9",
		unsigned int	waitForRunningMs = 0,
		unsigned long	sleepyTimeMs = 0,
		bool	waitForEachPriorityStage = false,
		unsigned long	waitAfterEachStageMs = 0,
		bool	verbose = true
	)

Start servers Start all servers associated with input OAD.

Parameters

oad	Hostname of oad to start servers on.
prioritySpec	String specifying priority of machines to stop. Priority is specified by a number 0-9. Ranges are specified with a '-' and are inclusive. Startup is from highest (0) to lowest (9) priority.
waitForRunningMs	Time in milliseconds to wait for servers to transition to the RUNNING state. Waiting starts AFTER all servers in given priority range have been instructed to start.
sleepyTimeMs	Time in ms to sleep between starting servers.
waitForEachPriorityStage	Wait at most waitForRunningMs for all servers in each priority level specified in prioritySpec to start.

void carma::util::ConfigureImr::stopServers	(	const std::string &	oad,
		const std::string	prioritySpec = "9-0",
		unsigned int	waitForStoppedMs = 0,
		bool	waitForEachPriorityStage = false
	)

Stop servers Stop all servers associated with input OAD.

Parameters

oad	String identifying OAD.
prioritySpec	String specifying priority of machines to stop. Priority is specified by a number 0-9. Ranges are specified with a '-' and are inclusive. Shutdown is from lowest (9) to highest (0) priority.
waitForStoppedMs	Max number of milliseconds to wait for a server to transition to STOPPED state. Waiting starts AFTER all servers in a given priority range have been instructed to terminate.
waitForEachPriorityStage	Wait at most waitForRunningMs for all servers in each priority level specified in prioritySpec to stop.

---

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

• carma/util/ConfigureImr.h