1 /* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_S4U_ACTOR_HPP
7 #define SIMGRID_S4U_ACTOR_HPP
10 #include <simgrid/simix.h>
11 #include <simgrid/s4u/forward.hpp>
16 /** @brief Simulation Agent
18 * An actor may be defined as a code executing in a location (host).
20 * All actors should be started from the XML deployment file (using the @link{s4u::Engine::loadDeployment()}),
21 * even if you can also start new actors directly.
22 * Separating the deployment in the XML from the logic in the code is a good habit as it makes your simulation easier
23 * to adapt to new settings.
25 * The code that you define for a given actor should be placed in the main method that is virtual.
26 * For example, a Worker actor should be declared as follows:
29 * #include "s4u/actor.hpp"
33 * printf("Hello s4u");
38 * new Actor("worker", host, Worker());
42 XBT_PUBLIC_CLASS Actor {
43 Actor(smx_process_t smx_proc);
45 Actor(const char* name, s4u::Host *host, double killTime, std::function<int()> code);
46 Actor(const char* name, s4u::Host *host, std::function<int()> code)
47 : Actor(name, host, -1, std::move(code)) {};
49 Actor(const char* name, s4u::Host *host, C code)
50 : Actor(name, host, -1, std::function<int()>(std::move(code))) {}
53 /** Retrieves the actor that have the given PID (or NULL if not existing) */
54 //static Actor *byPid(int pid); not implemented
56 /** Retrieves the name of that actor */
57 const char* getName();
58 /** Retrieves the host on which that actor is running */
60 /** Retrieves the PID of that actor */
63 /** If set to true, the actor will automatically restart when its host reboots */
64 void setAutoRestart(bool autorestart);
65 /** Sets the time at which that actor should be killed */
66 void setKillTime(double time);
67 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
70 /** Ask the actor to die.
72 * It will only notice your request when doing a simcall next time (a communication or similar).
73 * SimGrid sometimes have issues when you kill actors that are currently communicating and such. We are working on it to fix the issues.
77 // Static methods on all actors:
79 /** Ask kindly to all actors to die. Only the issuer will survive. */
80 static void killAll();
82 // Static methods working on the current actor:
84 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
85 static void sleep(double duration);
87 /** Block the actor, computing the given amount of flops */
88 static e_smx_state_t execute(double flop);
90 /** Block the actor until it gets a message from the given mailbox.
92 * See \ref Comm for the full communication API (including non blocking communications).
94 static void *recv(Mailbox &chan);
96 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
98 * See \ref Comm for the full communication API (including non blocking communications).
100 static void send(Mailbox &chan, void*payload, size_t simulatedSize);
103 smx_process_t getInferior() {return pimpl_;}
105 smx_process_t pimpl_ = nullptr;
108 }} // namespace simgrid::s4u
110 #endif /* SIMGRID_S4U_ACTOR_HPP */
114 public final class Actor {
116 public Actor(String name, Host host, double killTime, Runnable code);