ready for v0.2.0

cardo-org · Dec 3, 2023 · bc608ba · bc608ba · attdona · Dec 3, 2023
1 parent df3260c
commit bc608ba
Show file tree

Hide file tree

Showing 21 changed files with 128 additions and 73 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,22 @@
+# Change Log
+
+## 0.2.0 (3 December, 2023)
+
+- Renamed functions:
+  - is_shutdown=>isshutdown
+  - is_request=>isrequest
+  - if_restart=>ifrestart
+
+- Add `handler` keyword arg to supervise. `handler` value is a callback function for handling process lifecycles events. Currently manages events are task exceptions and `ProcessFatal`.
+
+- Removed `supervisor_shutdown` in case of a `ProcessFatal` exception. This implies that the other processes continue to run despite the process that thrown `ProcessFatal` will never restart.
+
+- Log a warn message when starting a process task throws a MethodError exception.
+
+- New function `isprocstarted`: check if process task is running.
+
+- @isshutdown macro.
+
+## 0.1.0 (November 13, 2023)
+
+- Initial release.
diff --git a/README.md b/README.md
@@ -102,12 +102,12 @@ In the above example the `printer` function is the supervised task function of t
 
 Applications messages sent to the task and the `Shutdown` control message are received from the `td.inbox` Channel.
 
-To check for a termination request use the method `is_shutdown`:
+To check for a termination request use the method `isshutdown`:
 
 ```julia
 function mytask(td)
     for msg in td.inbox
-        if is_shutdown(msg)
+        if isshutdown(msg)
             break
         end
         # process application messages
@@ -127,7 +127,7 @@ function mytask(td)
 end
 ```
 
-If the task is only interested in checking for shutdown request then the method `is_shutdown(td)` suffice, but in this case remember that other messages in the process inbox are silently discarded.
+If the task is only interested in checking for shutdown request then the method `isshutdown(td)` suffice, but in this case remember that other messages in the process inbox are silently discarded.
 
 `simple-process.jl`:
 
@@ -142,7 +142,7 @@ function worker(td; steps=15, check_interrupt_every=Inf)
             @info "[$(td.id)]: doing $i ..."
             sleep(0.5)
             if i % check_interrupt_every == 0
-                if is_shutdown(td)
+                if isshutdown(td)
                     return
                 end
             end
@@ -174,7 +174,7 @@ To send application messages the standard Channel api may be used or the utiliti
 
 * `cast(td, "path.to.target", message)`: send a message to the node with full name `path.to.target`.
 * `call(td, "path.to.target", request)`: send a request to and wait for a response.
-* `is_request(message)`: check if `message` is a request.
+* `isrequest(message)`: check if `message` is a request.
 * `reply(message, response)`: send the `response` to the `call` method that issued the `message` request .
 
 The following example shows the mechanics of inter-task communication.
@@ -196,11 +196,11 @@ end
 function db_service(td)
     @info "[$td] starting"
     for msg in td.inbox
-        if is_shutdown(msg)
+        if isshutdown(msg)
             break
         elseif isa(msg, CounterMsg)
             @info "[$td] got message: $msg"
-        elseif is_request(msg)
+        elseif isrequest(msg)
             if isa(msg.request, ControllerMsg)
                 reply(msg, :on)
             end
@@ -218,7 +218,7 @@ function app_counter(td)
 
     while true
         sleep(2)
-        if is_shutdown(td)
+        if isshutdown(td)
             break
         end
         # send a data message to db_service process
@@ -236,7 +236,7 @@ function app_controller(td)
 
     while true
         sleep(2)
-        if is_shutdown(td)
+        if isshutdown(td)
             break
         end
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -32,7 +32,7 @@ end
 function level_1_task(td)
     @info "starting $td"
     for msg in td.inbox
-        if is_shutdown(msg)
+        if isshutdown(msg)
             break
         elseif isa(msg, AppData)
             @info "$td recv: $msg"
@@ -46,7 +46,7 @@ function level_2_task(td)
     n = 0
     while true
         sleep(0.5)
-        if is_shutdown(td)
+        if isshutdown(td)
             break
         end
         # send a data message to process named level_1_task
@@ -78,27 +78,27 @@ A [Process](@ref) is a supervised task that is started/stopped in a deterministi
 
 A process task function has a mandatory first argument that is a task descriptor `td` value that:
 
-* check if a shutdown request is pending with `is_shutdown`;
+* check if a shutdown request is pending with `isshutdown`;
 * receive messages from the `inbox` Channel;
 
 ```julia
 function level_2_task(td)
     while true
         # do something ...
-        if is_shutdown(td)
+        if isshutdown(td)
             break
         end
     end
 end
 ```
 
-If the task function is designed to receive messages the argument of `is_shutdown` MUST BE the message and not the `task` object:
+If the task function is designed to receive messages the argument of `isshutdown` MUST BE the message and not the `task` object:
 
 ```julia
 function level_1_task(td)
     for msg in td.inbox
         # check if it is a shutdown request 
-        if is_shutdown(msg)
+        if isshutdown(msg)
             break
         elseif isa(msg, AppMessage)
             # do something with the application message
@@ -147,7 +147,7 @@ function consumer(td)
         msg = take!(td.inbox)
 
         # Check if msg is the shutdown control message ...
-        !is_shutdown(msg) || break
+        !isshutdown(msg) || break
 
         println(msg)
         if msg == 5
@@ -169,7 +169,7 @@ function producer(td)
         cast("consumer", count)
 
         # check if was requested a shutdown (for example by SIGINT signal)
-        !is_shutdown(td) || break
+        !isshutdown(td) || break
 
         count += 1
     end

diff --git a/docs/src/messages.md b/docs/src/messages.md
@@ -61,7 +61,7 @@ using Visor
 
 function server(self)
     for msg in self.inbox
-        is_shutdown(msg) && break
+        isshutdown(msg) && break
         put!(msg.inbox, msg.request*2)
     end
 end

diff --git a/examples/call.jl b/examples/call.jl
@@ -2,7 +2,7 @@ using Visor
 
 function server(task)
     for msg in task.inbox
-        is_shutdown(msg) && break
+        isshutdown(msg) && break
         put!(msg.inbox, msg.request * 2)
     end
     println("server done")

diff --git a/examples/introduction.jl b/examples/introduction.jl
@@ -12,11 +12,11 @@ function db_service(td)
     @info "[$td] starting"
     try
         for msg in td.inbox
-            if is_shutdown(msg)
+            if isshutdown(msg)
                 break
             elseif isa(msg, CounterMsg)
                 @info "[$td] got message: $msg"
-            elseif is_request(msg)
+            elseif isrequest(msg)
                 if isa(msg.request, ControllerMsg)
                     reply(msg, :on)
                 end
@@ -33,7 +33,7 @@ function app_counter(td)
     n = 0
     while true
         sleep(2)
-        if is_shutdown(td)
+        if isshutdown(td)
             break
         end
         # send a data message to process named db_service
@@ -47,7 +47,7 @@ function app_controller(td)
     @info "[$td] starting"
     while true
         sleep(2)
-        if is_shutdown(td)
+        if isshutdown(td)
             break
         end
         response = call("db_service", ControllerMsg("select status from ..."))

diff --git a/examples/multiples.jl b/examples/multiples.jl
@@ -13,7 +13,7 @@ function worker(self; steps=15, check_interrupt_every=Inf)
             sleep(0.5)
             if i % check_interrupt_every == 0
                 @info "[$(self.id)]: checkpoint for shutdown request"
-                if Visor.is_shutdown(self)
+                if Visor.isshutdown(self)
                     return nothing
                 end
             end

diff --git a/examples/producer_consumer.jl b/examples/producer_consumer.jl
@@ -11,7 +11,7 @@ function consumer(self)
         msg = take!(self.inbox)
 
         # Check if msg is the shutdown control message ...
-        !is_shutdown(msg) || break
+        !isshutdown(msg) || break
 
         println(msg)
         if msg == 5
@@ -32,7 +32,7 @@ function producer(self)
         cast("consumer", count)
 
         # check if was requested a shutdown (for example by SIGINT signal)
-        !is_shutdown(self) || break
+        !isshutdown(self) || break
 
         count += 1
     end

diff --git a/examples/publisher_tcp.jl b/examples/publisher_tcp.jl
@@ -28,7 +28,7 @@ function publisher(self)
         msg = fetch(self.inbox)
 
         # Check if msg is the shutdown control message ...
-        !is_shutdown(msg) || break
+        !isshutdown(msg) || break
 
         # otherwise send the data
         if isopen(sock)
@@ -47,7 +47,7 @@ function producer(self)
         cast("publisher", count)
 
         # check if was requested a shutdown (for example by SIGINT signal)
-        !is_shutdown(self) || break
+        !isshutdown(self) || break
 
         count += 1
     end

diff --git a/examples/simple_interruptable.jl b/examples/simple_interruptable.jl
@@ -9,7 +9,7 @@ function worker(self, steps=15, check_interrupt_every=Inf)
         sleep(1)
         if i % check_interrupt_every == 0
             @info "[$(self.id)]: checkpoint for shutdown request"
-            if Visor.is_shutdown(self)
+            if Visor.isshutdown(self)
                 return nothing
             end
         end

diff --git a/examples/stop_process.jl b/examples/stop_process.jl
@@ -18,7 +18,7 @@ using Visor
 function fair_task(self)
     while true
         println("[$(self.id)] checkpoint ...")
-        if is_shutdown(self)
+        if isshutdown(self)
             println("[$(self.id)] cleanup and resources deallocation")
             break
         end