Rename @stateful to @Resumable

Author: BenLauwens

README.md

@@ -75,7 +75,7 @@ run(sim, datetime+Month(3))
   ```
   - using a novel finite-statemachine approach:
   ```
-  @stateful function fibonnaci(sim::Simulation)
+  @resumable function fibonnaci(sim::Simulation)
     a = 0.0
     b = 1.0
     while true

src/SimJulia.jl

@@ -24,7 +24,7 @@ module SimJulia
   export nowDatetime
   export Process, @process
   export yield, interrupt
-  export FiniteStateMachine, @stateful, @yield
+  export FiniteStateMachine, @resumable, @yield
   export Coroutine, @coroutine
   export Container, Resource, Store
   export Put, Get, Request, Release, cancel, capacity, request, @request

src/finitestatemachines/macros.jl

@@ -6,7 +6,7 @@ abstract type FiniteStateMachine end
 
 iscoroutinedone(fsm::FiniteStateMachine) = fsm._state == 0xff
 
-macro stateful(expr::Expr)
+macro resumable(expr::Expr)
   expr.head != :function && error("Expression is not a function definition!")
   args = getArguments(expr)
   func_name = shift!(args)

test/benchmarks/coroutines_MM1.jl

@@ -1,21 +1,21 @@
 using SimJulia, Distributions, BenchmarkTools
 
-@stateful function exp_source(sim::Simulation, lambd::Float64, server::Resource, mu::Float64)
+@resumable function exp_source(sim::Simulation, lambd::Float64, server::Resource, mu::Float64)
   while true
     dt = rand(Exponential(1/lambd))
     @yield return Timeout(sim, dt)
     @coroutine customer2(sim, server, mu)
   end
 end
 
-@stateful function customer(sim::Simulation, server::Resource, mu::Float64)
+@resumable function customer(sim::Simulation, server::Resource, mu::Float64)
   @yield return Request(server)
   dt = rand(Exponential(1/mu))
   @yield return Timeout(sim, dt)
   @yield return Release(server)
 end
 
-@stateful function customer2(sim::Simulation, server::Resource, mu::Float64)
+@resumable function customer2(sim::Simulation, server::Resource, mu::Float64)
   @request server req begin
     dt = rand(Exponential(1/mu))
     @yield return Timeout(sim, dt)

test/benchmarks/coroutines_fibonnaci.jl

@@ -1,6 +1,6 @@
 using SimJulia, BenchmarkTools
 
-@stateful function fibonnaci(sim::Simulation)
+@resumable function fibonnaci(sim::Simulation)
   a = 0.0
   b = 1.0
   while true

test/containers.jl

@@ -1,6 +1,6 @@
 using SimJulia
 
-@stateful function client(sim::Simulation, res::Resource, i::Int, priority::Int)
+@resumable function client(sim::Simulation, res::Resource, i::Int, priority::Int)
   println("$(now(sim)), client $i is waiting")
   @yield return Request(res, priority=priority)
   println("$(now(sim)), client $i is being served")
@@ -9,7 +9,7 @@ using SimJulia
   @yield return Release(res)
 end
 
-@stateful function generate(sim::Simulation, res::Resource)
+@resumable function generate(sim::Simulation, res::Resource)
   i = 1
   while true
     @coroutine client(sim, res, i, 10-i)
@@ -24,7 +24,7 @@ res = Resource(sim, 2; level=1)
 @coroutine generate(sim, res)
 run(sim)
 
-@stateful function my_consumer(sim::Simulation, con::Container)
+@resumable function my_consumer(sim::Simulation, con::Container)
   i = 1
   while true
     amount = 3*rand()
@@ -45,7 +45,7 @@ run(sim)
   end
 end
 
-@stateful function my_producer(sim::Simulation, con::Container)
+@resumable function my_producer(sim::Simulation, con::Container)
   i = 1
   while true
     amount = 2*rand()
@@ -66,7 +66,7 @@ con = Container(sim, 10.0; level=5.0)
 @coroutine my_producer(sim, con)
 run(sim)
 
-@stateful function resource_user(sim::Simulation, res::Resource, i::Int)
+@resumable function resource_user(sim::Simulation, res::Resource, i::Int)
   @request res req begin
     println("Requested $i")
     val = @yield return req | Timeout(sim, rand())
@@ -80,7 +80,7 @@ run(sim)
   println("Released automatically $i")
 end
 
-@stateful function create_users(sim::Simulation)
+@resumable function create_users(sim::Simulation)
   res = Resource(sim)
   i = 1
   while true

test/coroutines.jl

@@ -1,6 +1,6 @@
 using SimJulia
 
-@stateful function fibonnaci(sim::Simulation)
+@resumable function fibonnaci(sim::Simulation)
   a = 0
   b = 1
   while true
@@ -10,24 +10,24 @@ using SimJulia
   end
 end
 
-@stateful function test_process(sim::Simulation, ev::AbstractEvent)
+@resumable function test_process(sim::Simulation, ev::AbstractEvent)
   @yield return ev
 end
 
-@stateful function test_process_exception(sim::Simulation, ev::AbstractEvent)
+@resumable function test_process_exception(sim::Simulation, ev::AbstractEvent)
   try
     value = @yield return ev
   catch
     println("$value has been thrown")
   end
 end
 
-@stateful function test_interrupter(sim::Simulation, proc::Coroutine)
+@resumable function test_interrupter(sim::Simulation, proc::Coroutine)
   @yield return Timeout(sim, 2)
   interrupt(proc)
 end
 
-@stateful function test_interrupted(sim::Simulation)
+@resumable function test_interrupted(sim::Simulation)
   try
     exc = @yield return Timeout(sim, 10)
   catch

test/stores.jl

@@ -4,7 +4,7 @@ struct StoreObject
   i :: Int
 end
 
-@stateful function my_consumer(sim::Simulation, sto::Store)
+@resumable function my_consumer(sim::Simulation, sto::Store)
   i = 1
   while true
     @yield return Timeout(sim, rand())
@@ -16,7 +16,7 @@ end
   end
 end
 
-@stateful function my_producer(sim::Simulation, sto::Store)
+@resumable function my_producer(sim::Simulation, sto::Store)
   i = 1
   while true
     println("$(now(sim)), producer is offering object $i")