View Source Octopus (octopus v0.5.1)

Top-level module Octopus interface.

Link to this section Summary

Link to this section Functions

Link to this function

call(service_name, function_name, args)

View Source
@spec call(String.t(), String.t(), map()) :: {:ok, map()} | {:error, any()}
@spec define(String.t()) :: {:ok, String.t()} | {:error, any()}
@spec define(map()) :: {:ok, String.t()} | {:error, any()}
Link to this function

definition(service_name)

View Source
@spec definition(String.t()) :: {:ok, map()} | {:error, any()}
Link to this function

delete(service_name, args \\ %{})

View Source
@spec delete(String.t(), map()) :: :ok | {:error, any()}
Link to this function

restart(service_name, args \\ %{})

View Source
@spec restart(String.t(), map()) :: {:ok, map()} | {:error, any()}
@spec services() :: [String.t()]
Link to this function

start(service_name, args \\ %{})

View Source
@spec start(String.t(), map()) :: {:ok, map()} | {:error, any()}
@spec state(String.t()) :: {:ok, map()} | {:error, any()}
@spec status(String.t()) :: :undefined | :not_ready | :ready
Link to this function

stop(service_name, args \\ %{})

View Source
@spec stop(String.t(), map()) :: :ok | {:error, any()}