Either aliases GenServer.Proxy (this module) and requires the alias or imports GenServer.Proxy. In the latter case, you could instead simply import GenServer.Proxy.

Examples

use GenServer.Proxy, alias: Proxy

use GenServer.Proxy

import GenServer.Proxy

Makes a synchronous call to the GenServer registered via server_id. Will wait a bit if the GenServer is not yet registered on restarts.

The given module (or by default <caller's_module>.GenServerProxy) should implement the 2 callbacks of GenServer.Proxy (this module).

Examples

iex> defmodule Game.Engine.GenServerProxy do
iex>   @behaviour GenServer.Proxy
iex>
iex>   @impl GenServer.Proxy
iex>   def server_name(game_name) do
iex>     {:global, game_name}
iex>   end
iex>
iex>   @impl GenServer.Proxy
iex>   def server_unregistered(game_name) do
iex>     :ok = IO.puts("Game '#{game_name}' not started.")
iex>   end
iex> end
iex>
iex> defmodule Game.Server do
iex>   use GenServer
iex>
iex>   @impl GenServer
iex>   def init(init_arg), do: {:ok, init_arg}
iex>
iex>   @impl GenServer
iex>   def handle_call(:summary, _from, state), do: {:reply, state, state}
iex> end
iex>
iex> defmodule Game.Engine do
iex>   use GenServer.Proxy
iex>
iex>   alias __MODULE__.GenServerProxy
iex>
iex>   id = "Tic-Tac-Toe"
iex>   name = GenServerProxy.server_name(id)
iex>   {:ok, _pid} = GenServer.start_link(Game.Server, "XOX", name: name)
iex>
iex>   def summary(id), do: call(id, :summary)
iex> end
iex>
iex> Game.Engine.summary("Tic-Tac-Toe")
"XOX"

Sends an async request to the GenServer registered via server_id. No need to wait for the GenServer to be registered as this is async.

The given module (or by default <caller's_module>.GenServerProxy) should implement the 2 callbacks of GenServer.Proxy (this module).

Synchronously stops the GenServer registered via server_id. Will wait a bit if the GenServer is not yet registered on restarts.

The given module (or by default <caller's_module>.GenServerProxy) should implement the 2 callbacks of GenServer.Proxy (this module).