more precise words

Author: d-led

CHANGELOG.md

@@ -13,14 +13,17 @@ and this project adheres to
 ### Added
 
 - VirtualTimeGenStateMachine with full `:gen_statem` support
-- `start_link/3`, `start/3`, `call/3`, `cast/2`, `stop/3` functions for VirtualTimeGenStateMachine
-- Compilation warnings for global virtual clock operations to prevent race conditions
+- `start_link/3`, `start/3`, `call/3`, `cast/2`, `stop/3` functions for
+  VirtualTimeGenStateMachine
+- Compilation warnings for global virtual clock operations to prevent race
+  conditions
 
 ### Changed
 
 - Optimized VirtualClock event scheduling by using asynchronous operations
 - Time backend is now internal and transparent to client code
-- VirtualTimeGenServer and VirtualTimeGenStateMachine functions now emit warnings when using global clock injection
+- VirtualTimeGenServer and VirtualTimeGenStateMachine functions now emit
+  warnings when using global clock injection
 - Removed complex wrapper module causing callback conflicts
 - Now uses native Erlang `:gen_statem` directly
 

README.md

@@ -4,7 +4,6 @@ Test time-based GenServers instantly. Simulate actor systems with virtual time.
 Model, simulate, analyze actor systems and generate boilerplate in various Actor
 Model implementations: in Java, Rust, Pony, Go and C++.
 
-
 [![Hex.pm](https://img.shields.io/hexpm/v/gen_server_virtual_time.svg)](https://hex.pm/packages/gen_server_virtual_time)
 [![Documentation](https://img.shields.io/badge/docs-hexdocs-blue.svg)](https://hexdocs.pm/gen_server_virtual_time)
 [![CI](https://github.com/d-led/gen_server_virtual_time/workflows/CI/badge.svg)](https://github.com/d-led/gen_server_virtual_time/actions)
@@ -22,7 +21,10 @@ Model implementations: in Java, Rust, Pony, Go and C++.
 elixir scripts/century_backup_demo.exs
 ```
 
-Run the century backup demo to see virtual time in action - simulate 100 years of daily backups (36,525 backups) in milliseconds. [Source](scripts/century_backup_demo.exs). [Sample run](https://github.com/d-led/gen_server_virtual_time/actions/workflows/century-backup-demo.yml).
+Run the century backup demo to see virtual time in action - simulate 100 years
+of daily backups (36,525 backups) in milliseconds.
+[Source](scripts/century_backup_demo.exs).
+[Sample run](https://github.com/d-led/gen_server_virtual_time/actions/workflows/century-backup-demo.yml).
 
 ## 🚀 Code Generators
 

lib/time_backend.ex

@@ -4,9 +4,11 @@ defmodule TimeBackend do
   """
 
   @callback send_after(pid(), term(), non_neg_integer()) :: reference()
+  # delay_ms: delay in milliseconds
   @callback send_immediately(pid(), term()) :: :ok
   @callback cancel_timer(reference()) :: non_neg_integer() | false
   @callback sleep(non_neg_integer()) :: :ok
+  # duration_ms: duration in milliseconds
 end
 
 defmodule RealTimeBackend do
@@ -16,8 +18,8 @@ defmodule RealTimeBackend do
   @behaviour TimeBackend
 
   @impl true
-  def send_after(dest, message, delay) do
-    Process.send_after(dest, message, delay)
+  def send_after(dest, message, delay_ms) do
+    Process.send_after(dest, message, delay_ms)
   end
 
   @impl true
@@ -32,8 +34,8 @@ defmodule RealTimeBackend do
   end
 
   @impl true
-  def sleep(duration) do
-    Process.sleep(duration)
+  def sleep(duration_ms) do
+    Process.sleep(duration_ms)
   end
 end
 
@@ -44,9 +46,9 @@ defmodule VirtualTimeBackend do
   @behaviour TimeBackend
 
   @impl true
-  def send_after(dest, message, delay) do
+  def send_after(dest, message, delay_ms) do
     clock = get_virtual_clock()
-    VirtualClock.send_after(clock, dest, message, delay)
+    VirtualClock.send_after(clock, dest, message, delay_ms)
   end
 
   @impl true
@@ -64,10 +66,10 @@ defmodule VirtualTimeBackend do
   end
 
   @impl true
-  def sleep(duration) do
+  def sleep(duration_ms) do
     # Schedule a wake-up message in virtual time and wait for it
     ref = make_ref()
-    send_after(self(), {:__vtgs_sleep_done__, ref}, duration)
+    send_after(self(), {:__vtgs_sleep_done__, ref}, duration_ms)
 
     receive do
       {:__vtgs_sleep_done__, ^ref} -> :ok