deprecate ConcurrentSim.put in favor of Base.put!

Author: Krastanov

docs/src/examples/Latency.md

@@ -10,8 +10,7 @@ In this example we show how to separate the time delay between processes from th
 ```julia
 using ConcurrentSim
 using ResumableFunctions
-import  ConcurrentSim.put
-import Base.get
+import Base: put!, get
 ```
 
 ### Define Constants
@@ -46,15 +45,15 @@ The latency function is a generator which yields two events: first a `timeout` t
 ```julia
 @resumable function latency(env::Simulation, cable::Cable, value::String)
     @yield timeout(cable.env, cable.delay)
-    @yield put(cable.store, value)
+    @yield put!(cable.store, value)
     end;
 ```
 
-The `put` and `get` functions allow interaction with the cable (note that these are not `@resumable` because they need to return the result of the operation and not the operation itself).
+The `put!` and `get` functions allow interaction with the cable (note that these are not `@resumable` because they need to return the result of the operation and not the operation itself).
 
 
 ```julia
-function put(cable::Cable, value::String)
+function put!(cable::Cable, value::String)
     @process latency(cable.env, cable, value) # results in the scheduling of all events generated by latency
 end
 
@@ -71,7 +70,7 @@ The `sender` and `receiver` generators yield events to the simulator.
     while true
         @yield timeout(env, SEND_PERIOD)
         value = "sender sent this at $(now(env))"
-        put(cable, value)
+        put!(cable, value)
     end
 end
 

docs/src/examples/ross.md

@@ -47,7 +47,7 @@ const G = Exponential(MU)
         @yield request(repair_facility)
         @yield timeout(env, rand(rng, G))
         @yield release(repair_facility)
-        @yield put(spares, active_process(env))
+        @yield put!(spares, active_process(env))
     end
 end
 
@@ -58,7 +58,7 @@ end
     end
     for i in 1:S
         proc = @process machine(env, repair_facility, spares)
-        @yield put(spares, proc) 
+        @yield put!(spares, proc) 
     end
 end
 

src/ConcurrentSim.jl

@@ -7,9 +7,8 @@ module ConcurrentSim
   using Dates
   using ResumableFunctions
 
-  import Base.run, Base.isless, Base.show, Base.yield, Base.get
-  import Base.(&), Base.(|)
-  import Dates.now
+  import Base: run, isless, show, yield, get, put!, &, |
+  import Dates: now
 
   export AbstractEvent, Environment, value, state, environment
   export Event, succeed, fail, @callback, remove_callback
@@ -18,7 +17,7 @@ module ConcurrentSim
   export @resumable, @yield
   export AbstractProcess, Simulation, run, now, active_process, StopSimulation
   export Process, @process, interrupt
-  export Container, Resource, Store, put, get, request, release, cancel
+  export Container, Resource, Store, put!, get, request, release, cancel
   export nowDatetime
 
   include("base.jl")
@@ -30,4 +29,5 @@ module ConcurrentSim
   include("resources/containers.jl")
   include("resources/stores.jl")
   include("utils/time.jl")
+  include("deprecated.jl")
 end

src/deprecated.jl

@@ -0,0 +1 @@
+Base.@deprecate put(args...) put!(args...)

src/resources/containers.jl

@@ -22,15 +22,15 @@ end
 
 const Resource = Container{Int}
 
-function put(con::Container{N}, amount::N; priority::Int=0) where N<:Real
+function put!(con::Container{N}, amount::N; priority::Int=0) where N<:Real
   put_ev = Put(con.env)
   con.put_queue[put_ev] = ContainerKey(priority, con.seid+=one(UInt), amount)
   @callback trigger_get(put_ev, con)
   trigger_put(put_ev, con)
   put_ev
 end
 
-request(res::Resource; priority::Int=0) = put(res, 1; priority=priority)
+request(res::Resource; priority::Int=0) = put!(res, 1; priority=priority)
 
 function get(con::Container{N}, amount::N; priority::Int=0) where N<:Real
   get_ev = Get(con.env)

src/resources/stores.jl

@@ -24,7 +24,7 @@ mutable struct Store{T} <: AbstractResource
   end
 end
 
-function put(sto::Store{T}, item::T; priority::Int=0) where T
+function put!(sto::Store{T}, item::T; priority::Int=0) where T
   put_ev = Put(sto.env)
   sto.put_queue[put_ev] = StorePutKey{T}(priority, sto.seid+=one(UInt), item)
   @callback trigger_get(put_ev, sto)

test/test_resources_containers.jl

@@ -46,7 +46,7 @@ end
     amount = 2*rand()
     println("$(now(sim)), producer is offering $amount")
     @yield timeout(sim, 1.0*rand())
-    @yield put(con, amount)
+    @yield put!(con, amount)
     level = con.level
     println("$(now(sim)), producer is being served, level is ", level)
     delay = 5.0*rand()
@@ -59,3 +59,23 @@ con = Container(sim, 10.0; level=5.0)
 @process my_consumer(sim, con)
 @process my_producer(sim, con)
 run(sim)
+
+
+@resumable function my_producer_old_put(sim::Simulation, con::Container) # from before deprecating put
+  for i in 1:10
+    amount = 2*rand()
+    println("$(now(sim)), producer is offering $amount")
+    @yield timeout(sim, 1.0*rand())
+    @yield put(con, amount)
+    level = con.level
+    println("$(now(sim)), producer is being served, level is ", level)
+    delay = 5.0*rand()
+    @yield timeout(sim, delay)
+  end
+end
+
+sim = Simulation()
+con = Container(sim, 10.0; level=5.0)
+@process my_consumer(sim, con)
+@process my_producer_old_put(sim, con)
+run(sim)

test/test_resources_stores.jl

@@ -17,7 +17,7 @@ end
 @resumable function my_producer(sim::Simulation, sto::Store)
   for j in 1:10
     println("$(now(sim)), producer is offering object $j")
-    @yield put(sto, StoreObject(j))
+    @yield put!(sto, StoreObject(j))
     println("$(now(sim)), producer is being served")
     @yield timeout(sim, 2*rand())
   end