A service that can be added to the simulation and that can be used by a WMS when executing a workflow. More...

#include <Service.h>

Inheritance diagram for wrench::Service:

Public Types
enum	State { UP, DOWN }
	Service states. More...

Public Member Functions
std::string	getHostname ()
	Get the name of the host on which the service is / will be running. More...

double	getMessagePayloadValueAsDouble (std::string)
	Get a message payload of the Service as a double. More...

std::string	getMessagePayloadValueAsString (std::string)
	Get a message payload of the Service as a string. More...

double	getNetworkTimeoutValue ()
	Returns the service's network timeout value. More...

bool	getPropertyValueAsBoolean (std::string)
	Get a property of the Service as a boolean. More...

double	getPropertyValueAsDouble (std::string)
	Get a property of the Service as a double. More...

std::string	getPropertyValueAsString (std::string)
	Get a property of the Service as a string. More...

bool	isUp ()
	Returns true if the service is UP, false otherwise. More...

void	setNetworkTimeoutValue (double value)
	Sets the service's network timeout value. More...

void	setStateToDown ()
	Set the state of the service to DOWN.

void	start (std::shared_ptr< Service > this_service, bool daemonize, bool auto_restart)
	Start the service. More...

virtual void	stop ()
	Synchronously stop the service (does nothing if the service is already stopped) More...

Public Member Functions inherited from wrench::S4U_Daemon
	S4U_Daemon (std::string hostname, std::string process_name_prefix, std::string mailbox_prefix)
	Constructor (daemon with a mailbox) More...

virtual	~S4U_Daemon ()
	Constructor (daemon without a mailbox) More...

virtual void	cleanup ()
	Cleanup function called when the daemon terminates (for whatever reason)

void	createLifeSaver (std::shared_ptr< S4U_Daemon > reference)
	Create a life saver for the daemon. More...

std::string	getName ()
	Retrieve the process name. More...

bool	hasCleanlyTerminated ()
	Returned the terminated status of the daemon/actor.

bool	isSetToAutoRestart ()
	Return the auto-restart status of the daemon. More...

bool	join ()
	Join (i.e., wait for) the daemon. More...

virtual int	main ()=0
	The daemon's main method, to be overridden. More...

void	resume ()
	Resume the daemon/actor.

void	setCleanlyTerminated ()
	Set the terminated status of the daemon/actor.

void	startDaemon (bool daemonized, bool auto_restart)
	Start the daemon. More...

void	suspend ()
	Suspend the daemon/actor.

Protected Member Functions
	Service (std::string hostname, std::string process_name_prefix, std::string mailbox_name_prefix)
	Constructor. More...

void	serviceSanityCheck ()
	Check whether the service is properly configured and running. More...

void	setMessagePayload (std::string, std::string)
	Set a message payload of the Service. More...

void	setMessagePayloads (std::map< std::string, std::string > default_messagepayload_values, std::map< std::string, std::string > overriden_messagepayload_values)
	Set default and user-defined message payloads. More...

void	setProperties (std::map< std::string, std::string > default_property_values, std::map< std::string, std::string > overriden_property_values)
	Set default and user-defined properties. More...

void	setProperty (std::string, std::string)
	Set a property of the Service. More...

Protected Member Functions inherited from wrench::S4U_Daemon
void	acquireDaemonLock ()
	Lock the daemon's lock.

void	killActor ()
	Kill the daemon/actor.

void	releaseDaemonLock ()
	Unlock the daemon's lock.

void	runMainMethod ()
	Method that run's the user-defined main method (that's called by the S4U actor class)

Protected Attributes
std::map< std::string, std::string >	messagepayload_list
	The service's messagepayload list.

std::string	name
	The service's name.

double	network_timeout = 30.0
	The time (in seconds) after which a service that doesn't send back a reply (control) message causes a NetworkTimeOut exception. (default: 30 second; if <0 never timeout)

std::map< std::string, std::string >	property_list
	The service's property list.

State	state
	The service's state.

Protected Attributes inherited from wrench::S4U_Daemon
unsigned int	num_starts = 0

Additional Inherited Members
Public Attributes inherited from wrench::S4U_Daemon
std::string	hostname
	The name of the host on which the daemon is running.

LifeSaver *	life_saver = nullptr
	The daemon's life saver.

std::string	mailbox_name
	The name of the daemon's mailbox.

std::string	process_name
	The name of the daemon.

Simulation *	simulation
	a pointer to the simulation object

Detailed Description

A service that can be added to the simulation and that can be used by a WMS when executing a workflow.

Member Enumeration Documentation

◆ State

enum wrench::Service::State

Service states.

Enumerator
UP	UP state: the service has been started and is still running.
DOWN	DOWN state: the service has been shutdown and/or has terminated.

Constructor & Destructor Documentation

◆ Service()

wrench::Service::Service	(	std::string	hostname,
		std::string	process_name_prefix,
		std::string	mailbox_name_prefix
	)

protected

Constructor.

Parameters

hostname	the name of the host on which the service will run
process_name_prefix	the prefix for the process name
mailbox_name_prefix	the prefix for the mailbox name

Member Function Documentation

◆ getHostname()

std::string wrench::Service::getHostname ( )

Get the name of the host on which the service is / will be running.

Returns: the hostname

◆ getMessagePayloadValueAsDouble()

double wrench::Service::getMessagePayloadValueAsDouble ( std::string message_payload )

Get a message payload of the Service as a double.

Parameters

message_payload the message payload

Returns: the message payload value as a double

Exceptions

std::invalid_argument

◆ getMessagePayloadValueAsString()

std::string wrench::Service::getMessagePayloadValueAsString ( std::string message_payload )

Get a message payload of the Service as a string.

Parameters

message_payload the message payload

Returns: the message payload value as a string

Exceptions

std::invalid_argument

◆ getNetworkTimeoutValue()

double wrench::Service::getNetworkTimeoutValue ( )

Returns the service's network timeout value.

Returns: a duration in seconds

◆ getPropertyValueAsBoolean()

bool wrench::Service::getPropertyValueAsBoolean ( std::string property )

Get a property of the Service as a boolean.

Parameters

property the property

Returns: the property value as a boolean

Exceptions

std::invalid_argument

◆ getPropertyValueAsDouble()

double wrench::Service::getPropertyValueAsDouble ( std::string property )

Get a property of the Service as a double.

Parameters

property the property

Returns: the property value as a double

Exceptions

std::invalid_argument

◆ getPropertyValueAsString()

std::string wrench::Service::getPropertyValueAsString ( std::string property )

Get a property of the Service as a string.

Parameters

property the property

Returns: the property value as a string

Exceptions

std::invalid_argument

◆ isUp()

bool wrench::Service::isUp ( )

Returns true if the service is UP, false otherwise.

Returns: true or false

◆ serviceSanityCheck()

void wrench::Service::serviceSanityCheck ( )

protected

Check whether the service is properly configured and running.

Exceptions

WorkflowExecutionException

◆ setMessagePayload()

void wrench::Service::setMessagePayload	(	std::string	messagepayload,
		std::string	value
	)

protected

Set a message payload of the Service.

Parameters

messagepayload	the message payload (which must a a string representation of a >=0 double)
value	the message payload value

Exceptions

std::invalid_argument

◆ setMessagePayloads()

void wrench::Service::setMessagePayloads	(	std::map< std::string, std::string >	default_messagepayload_values,
		std::map< std::string, std::string >	overridden_messagepayload_values
	)

protected

Set default and user-defined message payloads.

Parameters

default_messagepayload_values	list of default message payloads
overridden_messagepayload_values	list of overridden message payloads (override the default)

◆ setNetworkTimeoutValue()

void wrench::Service::setNetworkTimeoutValue ( double value )

Sets the service's network timeout value.

Parameters

value a duration in seconds (<0 means: never timeout)

◆ setProperties()

void wrench::Service::setProperties	(	std::map< std::string, std::string >	default_property_values,
		std::map< std::string, std::string >	overridden_poperty_values
	)

protected

Set default and user-defined properties.

Parameters

default_property_values	list of default properties
overridden_poperty_values	list of overridden properties (override the default)

◆ setProperty()

void wrench::Service::setProperty	(	std::string	property,
		std::string	value
	)

protected

Set a property of the Service.

Parameters

property	the property
value	the property value

◆ start()

void wrench::Service::start	(	std::shared_ptr< Service >	this_service,
		bool	daemonize,
		bool	auto_restart
	)

Start the service.

Parameters

this_service	a shared pointer to the service
daemonize	true if the daemon is to be daemonized, false otherwise
auto_restart	true if the daemon should restart automatically after a reboot or not

Exceptions

std::runtime_error

◆ stop()

void wrench::Service::stop ( )

virtual

Synchronously stop the service (does nothing if the service is already stopped)

Exceptions

WorkflowExecutionException
std::runtime_error

Reimplemented in wrench::ComputeService, wrench::JobManager, wrench::StorageService, wrench::DataMovementManager, and wrench::EnergyMeter.

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

/Users/rafsilva/Documents/isi/workspace/wrench/wrench/include/wrench/services/Service.h
/Users/rafsilva/Documents/isi/workspace/wrench/wrench/src/wrench/services/Service.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ Service()

Member Function Documentation

◆ getHostname()

◆ getMessagePayloadValueAsDouble()

◆ getMessagePayloadValueAsString()

◆ getNetworkTimeoutValue()

◆ getPropertyValueAsBoolean()

◆ getPropertyValueAsDouble()

◆ getPropertyValueAsString()

◆ isUp()

◆ serviceSanityCheck()

◆ setMessagePayload()

◆ setMessagePayloads()

◆ setNetworkTimeoutValue()

◆ setProperties()

◆ setProperty()

◆ start()

◆ stop()