Raxol.Core.Runtime.Plugins.LifecycleHelper.Behaviour behaviour (Raxol v2.0.1)

View Source

Behavior for plugin lifecycle management.

Summary

Callbacks

init_lifecycle(plugin_id, opts)

Initializes a plugin's lifecycle.

start_lifecycle(plugin_id, state)

Starts a plugin's lifecycle.

stop_lifecycle(plugin_id, state)

Stops a plugin's lifecycle.

terminate_lifecycle(plugin_id, state)

Terminates a plugin's lifecycle.

Callbacks

init_lifecycle(plugin_id, opts)

@callback init_lifecycle(plugin_id :: String.t(), opts :: keyword()) ::
  {:ok, term()} | {:error, term()}

Initializes a plugin's lifecycle.

start_lifecycle(plugin_id, state)

@callback start_lifecycle(plugin_id :: String.t(), state :: term()) ::
  {:ok, term()} | {:error, term()}

Starts a plugin's lifecycle.

stop_lifecycle(plugin_id, state)

@callback stop_lifecycle(plugin_id :: String.t(), state :: term()) ::
  {:ok, term()} | {:error, term()}

Stops a plugin's lifecycle.

terminate_lifecycle(plugin_id, state)

@callback terminate_lifecycle(plugin_id :: String.t(), state :: term()) :: :ok

Terminates a plugin's lifecycle.