Detailed Description

Static methods working on the current actor (see s4u::Actor)

Functions
bool	isMaestro ()
	Returns true if run from the kernel mode, and false if run from a real actor. More...

void	sleep_for (double duration)
	Block the actor sleeping for that amount of seconds (may throws hostFailure) More...

void	sleep_until (double timeout)

template<class Rep , class Period >
void	sleep_for (std::chrono::duration< Rep, Period > duration)

template<class Duration >
void	sleep_until (const SimulationTimePoint< Duration > &timeout_time)

	XBT_ATTRIB_DEPRECATED_v320 ("Use sleep_for(): v3.20 will turn this warning into an error.") inline void sleep(double duration)

void	execute (double flop)
	Block the actor, computing the given amount of flops. More...

void *	XBT_ATTRIB_DEPRECATED_v320 ("Use Mailbox::get(): v3.20 will turn this warning into an error.") recv(MailboxPtr chan)
	Block the actor until it gets a message from the given mailbox. More...

CommPtr	XBT_ATTRIB_DEPRECATED_v320 ("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.") irecv(MailboxPtr chan

void	XBT_ATTRIB_DEPRECATED_v320 ("Use Mailbox::put(): v3.20 will turn this warning into an error.") send(MailboxPtr chan
	Block the actor until it delivers a message of the given simulated size to the given mailbox. More...

CommPtr	XBT_ATTRIB_DEPRECATED_v320 ("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") isend(MailboxPtr chan

aid_t	getPid ()
	Returns the actor ID of the current actor (same as pid). More...

aid_t	getPpid ()
	Returns the ancestor's actor ID of the current actor (same as ppid). More...

std::string	getName ()
	Returns the name of the current actor. More...

Host *	getHost ()
	Returns the name of the host on which the process is running. More...

void	suspend ()
	Suspend the actor. More...

void	resume ()
	Resume the actor. More...

bool	isSuspended ()

void	kill ()
	kill the actor. More...

void	onExit (int_f_pvoid_pvoid_t fun, void *data)
	Add a function to the list of "on_exit" functions. More...

void	migrate (Host *new_host)
	Migrate the actor to a new host. More...

void *	recv (MailboxPtr chan)

void *	recv (MailboxPtr chan, double timeout)

void	send (MailboxPtr chan, void *payload, double simulatedSize)

void	send (MailboxPtr chan, void *payload, double simulatedSize, double timeout)

CommPtr	isend (MailboxPtr chan, void *payload, double simulatedSize)

CommPtr	irecv (MailboxPtr chan, void **data)

Variables
void double	timeout

CommPtr void **	data

void void *	payload

void void double	simulatedSize

Function Documentation

◆ isMaestro()

bool simgrid::s4u::this_actor::isMaestro ( )

Returns true if run from the kernel mode, and false if run from a real actor.

Everything that is run out of any actor (simulation setup before the engine is run, computing the model evolutions as a result to the actors' action, etc) is run in kernel mode, just as in any operating systems.

In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro, because it is the one scheduling when the others should move or wait.

◆ sleep_for() [1/2]

void simgrid::s4u::this_actor::sleep_for ( double duration )

Block the actor sleeping for that amount of seconds (may throws hostFailure)

Examples:: examples/s4u/actor-daemon/s4u-actor-daemon.cpp, examples/s4u/actor-kill/s4u-actor-kill.cpp, examples/s4u/actor-migration/s4u-actor-migration.cpp, examples/s4u/actor-suspend/s4u-actor-suspend.cpp, and examples/s4u/mutex/s4u-mutex.cpp.

◆ sleep_until() [1/2]

void simgrid::s4u::this_actor::sleep_until ( double timeout )

◆ sleep_for() [2/2]

template<class Rep , class Period >

void simgrid::s4u::this_actor::sleep_for ( std::chrono::duration< Rep, Period > duration )

inline

◆ sleep_until() [2/2]

template<class Duration >

void simgrid::s4u::this_actor::sleep_until ( const SimulationTimePoint< Duration > & timeout_time )

inline

◆ XBT_ATTRIB_DEPRECATED_v320() [1/5]

simgrid::s4u::this_actor::XBT_ATTRIB_DEPRECATED_v320 ( "Use sleep_for(): v3.20 will turn this warning into an error." )

◆ execute()

void simgrid::s4u::this_actor::execute ( double flop )

Block the actor, computing the given amount of flops.

Examples:: examples/s4u/actions-comm/s4u-actions-comm.cpp, examples/s4u/actor-daemon/s4u-actor-daemon.cpp, examples/s4u/actor-kill/s4u-actor-kill.cpp, examples/s4u/actor-migration/s4u-actor-migration.cpp, examples/s4u/actor-suspend/s4u-actor-suspend.cpp, and examples/s4u/app-masterworker/s4u-app-masterworker.cpp.

◆ XBT_ATTRIB_DEPRECATED_v320() [2/5]

void * simgrid::s4u::this_actor::XBT_ATTRIB_DEPRECATED_v320 ( "Use Mailbox::get(): v3.20 will turn this warning into an error." )

Block the actor until it gets a message from the given mailbox.

See Comm for the full communication API (including non blocking communications).

◆ XBT_ATTRIB_DEPRECATED_v320() [3/5]

CommPtr simgrid::s4u::this_actor::XBT_ATTRIB_DEPRECATED_v320 ( "Use Mailbox::recv_async(): v3.20 will turn this warning into an error." )

◆ XBT_ATTRIB_DEPRECATED_v320() [4/5]

void simgrid::s4u::this_actor::XBT_ATTRIB_DEPRECATED_v320 ( "Use Mailbox::put(): v3.20 will turn this warning into an error." )

Block the actor until it delivers a message of the given simulated size to the given mailbox.

See Comm for the full communication API (including non blocking communications).

◆ XBT_ATTRIB_DEPRECATED_v320() [5/5]

CommPtr simgrid::s4u::this_actor::XBT_ATTRIB_DEPRECATED_v320 ( "Use Mailbox::put_async(): v3.20 will turn this warning into an error." )

◆ getPid()

aid_t simgrid::s4u::this_actor::getPid ( )

Returns the actor ID of the current actor (same as pid).

◆ getPpid()

aid_t simgrid::s4u::this_actor::getPpid ( )

Returns the ancestor's actor ID of the current actor (same as ppid).

◆ getName()

std::string simgrid::s4u::this_actor::getName ( )

Returns the name of the current actor.

Examples:: examples/s4u/actions-comm/s4u-actions-comm.cpp, examples/s4u/actions-storage/s4u-actions-storage.cpp, examples/s4u/app-pingpong/s4u-app-pingpong.cpp, and examples/s4u/app-token-ring/s4u-app-token-ring.cpp.

◆ getHost()

Host * simgrid::s4u::this_actor::getHost ( )

Returns the name of the host on which the process is running.

Examples:: examples/s4u/actor-migration/s4u-actor-migration.cpp, examples/s4u/actor-suspend/s4u-actor-suspend.cpp, and examples/s4u/app-pingpong/s4u-app-pingpong.cpp.

◆ suspend()

void simgrid::s4u::this_actor::suspend ( )

Suspend the actor.

Examples:: examples/s4u/actor-kill/s4u-actor-kill.cpp, examples/s4u/actor-migration/s4u-actor-migration.cpp, and examples/s4u/actor-suspend/s4u-actor-suspend.cpp.

◆ resume()

void simgrid::s4u::this_actor::resume ( )

Resume the actor.

◆ isSuspended()

bool simgrid::s4u::this_actor::isSuspended ( )

◆ kill()

void simgrid::s4u::this_actor::kill ( )

kill the actor.

Examples:: examples/s4u/actor-kill/s4u-actor-kill.cpp.

◆ onExit()

void simgrid::s4u::this_actor::onExit	(	int_f_pvoid_pvoid_t	fun,
		void *	data
	)

Add a function to the list of "on_exit" functions.

Examples:: examples/s4u/actor-kill/s4u-actor-kill.cpp.

◆ migrate()

void simgrid::s4u::this_actor::migrate ( Host * new_host )

Migrate the actor to a new host.

Examples:: examples/s4u/actor-migration/s4u-actor-migration.cpp.

◆ recv() [1/2]

void* simgrid::s4u::this_actor::recv ( MailboxPtr chan )

Examples:: examples/s4u/actions-comm/s4u-actions-comm.cpp.

◆ recv() [2/2]

void* simgrid::s4u::this_actor::recv	(	MailboxPtr	chan,
		double	timeout
	)

◆ send() [1/2]

void simgrid::s4u::this_actor::send	(	MailboxPtr	chan,
		void *	payload,
		double	simulatedSize
	)

Examples:: examples/s4u/actions-comm/s4u-actions-comm.cpp.

◆ send() [2/2]

void simgrid::s4u::this_actor::send	(	MailboxPtr	chan,
		void *	payload,
		double	simulatedSize,
		double	timeout
	)

◆ isend()

CommPtr simgrid::s4u::this_actor::isend	(	MailboxPtr	chan,
		void *	payload,
		double	simulatedSize
	)

◆ irecv()

CommPtr simgrid::s4u::this_actor::irecv	(	MailboxPtr	chan,
		void **	data
	)

Variable Documentation

◆ timeout

void void double double simgrid::s4u::this_actor::timeout

◆ data

CommPtr void** simgrid::s4u::this_actor::data

Examples:: examples/msg/io-storage/io-storage.c, and examples/msg/platform-properties/platform-properties.c.

◆ payload

CommPtr void * simgrid::s4u::this_actor::payload

Examples:: examples/s4u/actions-comm/s4u-actions-comm.cpp, and examples/s4u/app-pingpong/s4u-app-pingpong.cpp.

◆ simulatedSize

CommPtr void double simgrid::s4u::this_actor::simulatedSize