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>
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... | |
double | getMessagePayloadValue (std::string) |
Get a message payload of the Service as a double. 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... | |
unsigned long | getPropertyValueAsUnsignedLong (std::string) |
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, std::string mailbox_prefix) | |
Constructor (daemon with a mailbox) More... | |
virtual | ~S4U_Daemon () |
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... | |
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 | resumeActor () |
Resume the daemon/actor. | |
void | setupOnExitFunction () |
Sets up the on_exit functionf for the actor. | |
void | startDaemon (bool daemonized, bool auto_restart) |
Start the daemon. More... | |
void | suspendActor () |
Suspend the daemon/actor. | |
Static Public Member Functions | |
static void | cleanupTrackedServices () |
Go through the tracked services and remove all entries with a refcount of 1! | |
static void | clearTrackedServices () |
Forget all tracked services. | |
static void | increaseNumCompletedServicesCount () |
Increase the completed service count. | |
Protected Member Functions | |
Service (std::string hostname, std::string process_name_prefix, std::string mailbox_name_prefix) | |
Constructor. More... | |
~Service () | |
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 (std::string, double) |
Set a message payload of the Service. More... | |
void | setMessagePayloads (std::map< std::string, double > default_messagepayload_values, std::map< std::string, double > 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 (does nothing if already dead) More... | |
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) | |
Static Protected Member Functions | |
static void | assertServiceIsUp (std::shared_ptr< Service > s) |
Assert for the service being up. More... | |
template<class T > | |
static std::shared_ptr< T > | getServiceByName (std::string name) |
Method to retrieve the shared_ptr to a service based on the service's name (not efficient) More... | |
Protected Attributes | |
std::map< std::string, double > | 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. | |
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) | |
State | state |
The service's state. | |
Additional Inherited Members | |
Public Types inherited from wrench::S4U_Daemon | |
enum | State { UP, DOWN, SUSPENDED } |
Daemon states. More... | |
Public Attributes inherited from wrench::S4U_Daemon | |
std::string | hostname |
The name of the host on which the daemon is running. | |
std::string | initial_mailbox_name |
The initial name of the daemon's mailbox. | |
LifeSaver * | life_saver = nullptr |
The daemon's life saver. | |
std::string | mailbox_name |
The current 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.
Constructor & Destructor Documentation
◆ Service()
|
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
◆ assertServiceIsUp() [1/2]
void wrench::Service::assertServiceIsUp | ( | ) |
Throws an exception if the service is not up.
- Exceptions
-
WorkflowExecutionException
◆ assertServiceIsUp() [2/2]
|
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
◆ getMessagePayloadValue()
double wrench::Service::getMessagePayloadValue | ( | 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
◆ 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
◆ getPropertyValueAsUnsignedLong()
unsigned long wrench::Service::getPropertyValueAsUnsignedLong | ( | std::string | 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
◆ getServiceByName()
|
inlinestaticprotected |
Method to retrieve the shared_ptr to a service based on the service's name (not efficient)
- Template Parameters
-
T the class of the service (the base class is Service)
- Parameters
-
name the service's name
- Returns
- a shared_ptr (or nullptr if not found)
◆ 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
-
WorkflowExecutionException
◆ serviceSanityCheck()
|
protected |
Check whether the service is properly configured and running.
- Exceptions
-
WorkflowExecutionException
◆ setMessagePayload()
|
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()
|
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()
|
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()
|
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()
|
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::EnergyMeterService, wrench::BandwidthMeterService, and wrench::DataMovementManager.
The documentation for this class was generated from the following files:
- Service.h
- Service.cpp