ExUtcp.Transports.TcpUdp.ConnectionBehaviour behaviour (ex_utcp v0.3.2)

Copy Markdown View Source

Behaviour for TCP/UDP connections to enable mocking in tests.

Summary

Callbacks

call_tool(conn, tool_name, args, timeout)

@callback call_tool(
  conn :: pid(),
  tool_name :: String.t(),
  args :: map(),
  timeout :: integer()
) ::
  {:ok, any()} | {:error, term()}

call_tool_stream(conn, tool_name, args, timeout)

@callback call_tool_stream(
  conn :: pid(),
  tool_name :: String.t(),
  args :: map(),
  timeout :: integer()
) :: {:ok, Enumerable.t()} | {:error, term()}

close(conn)

@callback close(conn :: pid()) :: :ok | {:error, term()}

get_last_used(conn)

@callback get_last_used(conn :: pid()) :: integer()

start_link(provider)

@callback start_link(provider :: map()) :: {:ok, pid()} | {:error, term()}

update_last_used(conn)

@callback update_last_used(conn :: pid()) :: :ok