Oi.Runtime.Session (oi v0.7.0)

Session separates the whole application into several spaces where contains different steps, independent symbionts and storages.

Summary

instances(oi)

resolve(oi_name)

stop(oi_name)

storage(oi_name)

Returns the per-session storage map if orchid_stratum is available.

tasks_tuple(oi)

Ensures a session is started and calls fun with session-scoped opts.

@spec ensure_started(
  binary(),
  keyword()
) :: :ignore | {:error, any()} | {:ok, pid()} | {:ok, pid(), any()}

@spec instances(Oi.name()) :: Oi.Runtime.Registry.key()

@spec instances_tuple(Oi.name()) :: Oi.Runtime.Registry.via_tuple()

@spec resolve(Oi.name()) :: {:error, :session_not_found} | {:ok, pid()}

@spec start(
  Oi.name(),
  keyword()
) :: :ignore | {:error, any()} | {:ok, pid()} | {:ok, pid(), any()}

@spec stop(Oi.name()) :: :ok | {:error, :session_not_found}

@spec storage(Oi.name()) :: map() | nil

Returns the per-session storage map if orchid_stratum is available.

The map can be merged into orchid_baggage:

%{meta_store: {EtsAdapter, ref}, blob_store: {EtsAdapter, ref}}

Returns nil when orchid_stratum is not loaded or the session was started without storage.

@spec tasks_tuple(Oi.name()) :: Oi.Runtime.Registry.via_tuple()

@spec with_session(Oi.name(), keyword(), (keyword() -> result)) :: result
when result: term()

Ensures a session is started and calls fun with session-scoped opts.

fun receives a keyword list suitable for merging into Oi.run/2 or Oi.execute/2:

The session is not stopped when fun returns — sessions are designed to be long-lived. Call stop/1 when done.

Session.with_session("tenant-1", fn session ->
  Oi.run(graph, Keyword.merge(session, data: %{greeter: %{name: "Alice"}}))
end)