Document handle_info/2 (#317)

elixir-ecto · Nov 12, 2024 · 4776530 · 4776530
1 parent 625b89f
commit 4776530
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/lib/db_connection.ex b/lib/db_connection.ex
@@ -362,6 +362,15 @@ defmodule DBConnection do
   """
   @callback disconnect(err :: Exception.t(), state :: any) :: :ok
 
+  @doc """
+  Optional callback for handling messages received by the connection.
+
+  Returns `{:disconnect, exception}` to close the connection or `:ok` to continue.
+  """
+  @callback handle_info(message :: any, state :: any) :: {:disconnect, Exception.t()} | :ok
+
+  @optional_callbacks handle_info: 2
+
   @connection_module_key :connection_module
 
   @doc """