WRENCH  1.11
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Member Functions | List of all members
wrench::ActionExecutionService Class Reference

An action execution service that: More...

#include <ActionExecutionService.h>

Inheritance diagram for wrench::ActionExecutionService:
wrench::Service wrench::S4U_Daemon

Public Member Functions

 ActionExecutionService (const std::string &hostname, std::map< std::string, std::tuple< unsigned long, double >> compute_resources, std::shared_ptr< Service > parent_service, WRENCH_PROPERTY_COLLECTION_TYPE property_list={}, WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE messagepayload_list={})
 Constructor. More...
 
 ~ActionExecutionService ()
 Destructor.
 
bool actionCanRun (std::shared_ptr< Action > action)
 Helper method that determines whether a submitted action (with service-specific arguments) can run given available resources. More...
 
std::map< std::string, std::tuple< unsigned long, double > > & getComputeResources ()
 Get a (reference to) the compute resources of this service. More...
 
std::shared_ptr< ServicegetParentService () const
 Get the parent compute service (could be nullptr if stand-alone) More...
 
std::map< std::string, double > getResourceInformation (const std::string &key)
 Return resource information. More...
 
bool IsThereAtLeastOneHostWithAvailableResources (unsigned long num_cores, double ram)
 Determine whether there is at least one host with (currently) available resources. More...
 
void setParentService (std::shared_ptr< Service > parent)
 Set parent service. More...
 
void submitAction (const std::shared_ptr< Action > &action)
 Submit an action to the action execution service service. More...
 
void terminateAction (std::shared_ptr< Action > action, ComputeService::TerminationCause termination_cause)
 Synchronously terminate an action. More...
 
- Public Member Functions inherited from wrench::Service
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...
 
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...
 
SimulationgetSimulation ()
 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...
 
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.
 

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
 
- Protected Member Functions inherited from wrench::Service
 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 inherited from wrench::Service
static void assertServiceIsUp (std::shared_ptr< Service > s)
 Assert for the service being up. More...
 
- Protected Attributes inherited from wrench::Service
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)
 
Simulationsimulation
 a pointer to the simulation object
 
State state
 The service's state.
 

Detailed Description

An action execution service that:

Constructor & Destructor Documentation

◆ ActionExecutionService()

wrench::ActionExecutionService::ActionExecutionService ( const std::string &  hostname,
std::map< std::string, std::tuple< unsigned long, double >>  compute_resources,
std::shared_ptr< Service parent_service,
WRENCH_PROPERTY_COLLECTION_TYPE  property_list = {},
WRENCH_MESSAGE_PAYLOADCOLLECTION_TYPE  messagepayload_list = {} 
)

Constructor.

Parameters
hostnamethe name of the host on which the service should be started
compute_resourcesa map of <num_cores, memory> tuples, indexed by hostname, which represents the compute resources available to this service.
parent_servicethe parent compute service (nullptr if not known at this time)
property_lista property list ({} means "use all defaults")
messagepayload_lista message payload list ({} means "use all defaults")

Member Function Documentation

◆ actionCanRun()

bool wrench::ActionExecutionService::actionCanRun ( std::shared_ptr< Action action)

Helper method that determines whether a submitted action (with service-specific arguments) can run given available resources.

Parameters
actionthe action
Returns
true if the action can run

◆ getComputeResources()

std::map< std::string, std::tuple< unsigned long, double > > & wrench::ActionExecutionService::getComputeResources ( )

Get a (reference to) the compute resources of this service.

Returns
the compute resources

◆ getParentService()

std::shared_ptr< Service > wrench::ActionExecutionService::getParentService ( ) const

Get the parent compute service (could be nullptr if stand-alone)

Returns
a compute service

◆ getResourceInformation()

std::map< std::string, double > wrench::ActionExecutionService::getResourceInformation ( const std::string &  key)

Return resource information.

Parameters
answer_mailboxthe mailbox to which the description message should be sent
Returns
resource information

◆ IsThereAtLeastOneHostWithAvailableResources()

bool wrench::ActionExecutionService::IsThereAtLeastOneHostWithAvailableResources ( unsigned long  num_cores,
double  ram 
)

Determine whether there is at least one host with (currently) available resources.

Parameters
num_coresthe desired number of cores
ramthe desired RAM
Returns
true or false

◆ setParentService()

void wrench::ActionExecutionService::setParentService ( std::shared_ptr< Service parent)

Set parent service.

Parameters
parentthe parent service

◆ submitAction()

void wrench::ActionExecutionService::submitAction ( const std::shared_ptr< Action > &  action)

Submit an action to the action execution service service.

Parameters
actionan action

◆ terminateAction()

void wrench::ActionExecutionService::terminateAction ( std::shared_ptr< Action action,
ComputeService::TerminationCause  termination_cause 
)

Synchronously terminate an action.

Parameters
actionan action
termination_causetermination cause
Exceptions
ExecutionException
std::runtime_error

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