SimGrid  3.18
Versatile Simulation of Distributed Systems
simgrid::s4u::Exec Class Reference

#include <Exec.hpp>

Inheritance diagram for simgrid::s4u::Exec:
simgrid::s4u::Activity

Public Member Functions

 ~Exec ()=default
 
Activitystart () override
 Starts a previously created activity. More...
 
Activitywait () override
 Tests whether the given activity is terminated yet. More...
 
Activitywait (double timeout) override
 Blocks until the activity is terminated, or until the timeout is elapsed Raises: timeout exception. More...
 
bool test ()
 
ExecPtr setPriority (double priority)
 
ExecPtr setHost (Host *host)
 
HostgetHost ()
 
double getRemains () override
 Get the remaining amount of work that this Activity entails. More...
 
double getRemainingRatio ()
 
- Public Member Functions inherited from simgrid::s4u::Activity
 Activity (Activity const &)=delete
 
Activityoperator= (Activity const &)=delete
 
e_s4u_activity_state_t getState ()
 Cancel that activity. More...
 
ActivitysetRemains (double remains)
 Set the [remaining] amount of work that this Activity will entail. More...
 
ActivitysetUserData (void *data)
 Put some user data onto the Activity. More...
 
voidgetUserData ()
 Retrieve the user data of the Activity. More...
 

Friends

void intrusive_ptr_release (simgrid::s4u::Exec *e)
 
void intrusive_ptr_add_ref (simgrid::s4u::Exec *e)
 
ExecPtr this_actor::exec_init (double flops_amount)
 

Additional Inherited Members

- Protected Member Functions inherited from simgrid::s4u::Activity
 Activity ()=default
 
virtual ~Activity ()=default
 

Constructor & Destructor Documentation

◆ ~Exec()

simgrid::s4u::Exec::~Exec ( )
default

Member Function Documentation

◆ start()

Activity * simgrid::s4u::Exec::start ( )
overridevirtual

Starts a previously created activity.

This function is optional: you can call wait() even if you didn't call start()

Implements simgrid::s4u::Activity.

◆ wait() [1/2]

Activity * simgrid::s4u::Exec::wait ( )
overridevirtual

Tests whether the given activity is terminated yet.

This is a pure function. Blocks until the activity is terminated

Implements simgrid::s4u::Activity.

◆ wait() [2/2]

Activity * simgrid::s4u::Exec::wait ( double  timeout)
overridevirtual

Blocks until the activity is terminated, or until the timeout is elapsed Raises: timeout exception.

Implements simgrid::s4u::Activity.

◆ test()

bool simgrid::s4u::Exec::test ( )

◆ setPriority()

ExecPtr simgrid::s4u::Exec::setPriority ( double  priority)

◆ setHost()

ExecPtr simgrid::s4u::Exec::setHost ( Host host)

◆ getHost()

Host* simgrid::s4u::Exec::getHost ( )
inline

◆ getRemains()

double simgrid::s4u::Exec::getRemains ( )
overridevirtual

Get the remaining amount of work that this Activity entails.

When it's 0, it's done.

Reimplemented from simgrid::s4u::Activity.

◆ getRemainingRatio()

double simgrid::s4u::Exec::getRemainingRatio ( )

Friends And Related Function Documentation

◆ intrusive_ptr_release

void intrusive_ptr_release ( simgrid::s4u::Exec e)
friend

◆ intrusive_ptr_add_ref

void intrusive_ptr_add_ref ( simgrid::s4u::Exec e)
friend

◆ this_actor::exec_init

ExecPtr this_actor::exec_init ( double  flops_amount)
friend

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