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 Member Functions
void	assertServiceIsUp ()
	Throws an exception if the service is not up. More...

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

const WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE &	getMessagePayloadList () const
	Get all message payloads and their values of the Service. More...

double	getMessagePayloadValue (WRENCH_MESSAGEPAYLOAD_TYPE)
	Get a message payload of the Service as a double. More...

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

std::string	getPhysicalHostname ()
	Get the physical name of the host on which the service is / will be running. More...

bool	getPropertyValueAsBoolean (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a boolean. More...

double	getPropertyValueAsDouble (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as a double. More...

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

unsigned long	getPropertyValueAsUnsignedLong (WRENCH_PROPERTY_TYPE)
	Get a property of the Service as an unsigned long. More...

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

void	resume ()
	Resume the service. 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...

void	suspend ()
	Suspend the service.

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

void	acquireDaemonLock ()
	Method to acquire the daemon's lock. More...

virtual void	cleanup (bool has_returned_from_main, int return_value)
	Cleanup function called when the daemon terminates (for whatever reason). The default behavior is to throw an exception if the host is off. This method should be overriden in a daemons implements some fault-tolerant behavior, or is naturally tolerant. More...

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

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

int	getReturnValue ()
	Returns the value returned by main() (if the daemon has returned from main) More...

Simulation *	getSimulation ()
	Get the service's simulation. More...

S4U_Daemon::State	getState ()
	Get the daemon's state. More...

bool	hasReturnedFromMain ()
	Returns true if the daemon has returned from main() (i.e., not brutally killed) More...

bool	isDaemonized ()
	Return the daemonized status of the daemon. More...

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

std::pair< bool, int >	join ()
	Join (i.e., wait for) the daemon. More...

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

void	releaseDaemonLock ()
	Method to release the daemon's lock. More...

void	resumeActor ()
	Resume the daemon/actor.

void	setSimulation (Simulation *simulation)
	Set the service's simulation. More...

void	setupOnExitFunction ()
	Sets up the on_exit function for the actor.

void	startDaemon (bool _daemonized, bool _auto_restart)
	Start the daemon. More...

void	suspendActor ()
	Suspend the daemon/actor.

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

	~Service () override
	Destructor.

template<class T >
std::shared_ptr< T >	getSharedPtr ()
	Method to retrieve the shared_ptr to a service. More...

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

void	setMessagePayload (WRENCH_MESSAGEPAYLOAD_TYPE, double)
	Set a message payload of the Service. More...

void	setMessagePayloads (WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE default_messagepayload_values, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE overriden_messagepayload_values)
	Set default and user-defined message payloads. More...

void	setProperties (WRENCH_PROPERTY_COLLECTION_TYPE default_property_values, WRENCH_PROPERTY_COLLECTION_TYPE overriden_property_values)
	Set default and user-defined properties. More...

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

Protected Member Functions inherited from wrench::S4U_Daemon
bool	killActor ()
	Kill the daemon/actor (does nothing if already dead) More...

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

Static Protected Member Functions
static void	assertServiceIsUp (std::shared_ptr< Service > s)
	Assert for the service being up. More...

Protected Attributes
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE	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)

WRENCH_PROPERTY_COLLECTION_TYPE	property_list
	The service's property list.

bool	shutting_down = false
	A boolean that indicates if the service is in the middle of shutting down.

Protected Attributes inherited from wrench::S4U_Daemon
unsigned int	num_starts = 0
	The number of time that this daemon has started (i.e., 1 + number of restarts)

Simulation *	simulation
	a pointer to the simulation object

State	state
	The service's state.

Additional Inherited Members
Public Types inherited from wrench::S4U_Daemon
enum	State { UP, DOWN, SUSPENDED }
	Daemon states. More...

Static Public Member Functions inherited from wrench::S4U_Daemon
static simgrid::s4u::Mailbox *	getRunningActorRecvMailbox ()
	Return the running actor's recv mailbox. More...

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.

simgrid::s4u::Mailbox *	mailbox
	The daemon's mailbox.

std::string	process_name
	The name of the daemon.

simgrid::s4u::Mailbox *	recv_mailbox
	The daemon's receive mailbox (to send to another daemon so that that daemon can reply)

Static Public Attributes inherited from wrench::S4U_Daemon
static std::unordered_map< aid_t, simgrid::s4u::Mailbox * >	map_actor_to_recv_mailbox

Detailed Description

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

Constructor & Destructor Documentation

◆ Service()

wrench::Service::Service	(	std::string	hostname,
		std::string	process_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

Member Function Documentation

◆ assertServiceIsUp() [1/2]

void wrench::Service::assertServiceIsUp ( )

Throws an exception if the service is not up.

Exceptions

ExecutionException

◆ assertServiceIsUp() [2/2]

static void wrench::Service::assertServiceIsUp ( std::shared_ptr< Service > s )

inlinestaticprotected

Assert for the service being up.

Parameters

s a service

◆ getHostname()

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

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

Returns: the hostname

◆ getMessagePayloadList()

const WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE & wrench::Service::getMessagePayloadList ( ) const

Get all message payloads and their values of the Service.

Returns: the message payload map

◆ getMessagePayloadValue()

double wrench::Service::getMessagePayloadValue ( WRENCH_MESSAGEPAYLOAD_TYPE 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

◆ getNetworkTimeoutValue()

double wrench::Service::getNetworkTimeoutValue ( )

Returns the service's network timeout value.

Returns: a duration in seconds

◆ getPhysicalHostname()

std::string wrench::Service::getPhysicalHostname ( )

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

Returns: the physical hostname

◆ getPropertyValueAsBoolean()

bool wrench::Service::getPropertyValueAsBoolean ( WRENCH_PROPERTY_TYPE 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 ( WRENCH_PROPERTY_TYPE 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 ( WRENCH_PROPERTY_TYPE 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

◆ getPropertyValueAsUnsignedLong()

unsigned long wrench::Service::getPropertyValueAsUnsignedLong ( WRENCH_PROPERTY_TYPE property )

Get a property of the Service as an unsigned long.

Parameters

property the property

Returns: the property value as an unsigned long

Exceptions

std::invalid_argument

◆ getSharedPtr()

template<class T >

std::shared_ptr<T> wrench::Service::getSharedPtr ( )

inlineprotected

Method to retrieve the shared_ptr to a service.

Template Parameters

T	the class of the service (the base class is Service)

Returns: a shared pointer

◆ isUp()

bool wrench::Service::isUp ( )

Returns true if the service is UP, false otherwise.

Returns: true or false

◆ resume()

void wrench::Service::resume ( )

Resume the service.

Exceptions

ExecutionException

◆ serviceSanityCheck()

void wrench::Service::serviceSanityCheck ( )

protected

Check whether the service is properly configured and running.

Exceptions

WorkflowExecutionException

◆ setMessagePayload()

void wrench::Service::setMessagePayload	(	WRENCH_MESSAGEPAYLOAD_TYPE	messagepayload,
		double	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	(	WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE	default_messagepayload_values,
		WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE	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	(	WRENCH_PROPERTY_COLLECTION_TYPE	default_property_values,
		WRENCH_PROPERTY_COLLECTION_TYPE	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	(	WRENCH_PROPERTY_TYPE	property,
		const 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
std::shared_ptr<HostError>

◆ stop()

void wrench::Service::stop ( )

virtual

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

Exceptions

ExecutionException
std::runtime_error

Reimplemented in wrench::ComputeService, wrench::JobManager, wrench::StorageService, wrench::DataMovementManager, wrench::EnergyMeterService, and wrench::BandwidthMeterService.

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

Service.h
Service.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Service()

Member Function Documentation

◆ assertServiceIsUp() [1/2]

◆ assertServiceIsUp() [2/2]

◆ getHostname()

◆ getMessagePayloadList()

◆ getMessagePayloadValue()

◆ getNetworkTimeoutValue()

◆ getPhysicalHostname()

◆ getPropertyValueAsBoolean()

◆ getPropertyValueAsDouble()

◆ getPropertyValueAsString()

◆ getPropertyValueAsUnsignedLong()

◆ getSharedPtr()

◆ isUp()

◆ resume()

◆ serviceSanityCheck()

◆ setMessagePayload()

◆ setMessagePayloads()

◆ setNetworkTimeoutValue()

◆ setProperties()

◆ setProperty()

◆ start()

◆ stop()