Nous.PubSub (nous v0.13.3)

View Source

Thin PubSub abstraction for Nous.

Wraps Phoenix.PubSub with graceful fallback when it's not available. Provides application-level configuration so users don't need to pass pubsub: MyApp.PubSub to every AgentServer.

Configuration

# In config/config.exs
config :nous, pubsub: MyApp.PubSub

Usage

# Subscribe (no-op if PubSub unavailable)
Nous.PubSub.subscribe(MyApp.PubSub, "agent:session_123")

# Broadcast (no-op if PubSub unavailable)
Nous.PubSub.broadcast(MyApp.PubSub, "agent:session_123", {:agent_delta, "Hello"})

# Use configured PubSub
pubsub = Nous.PubSub.configured_pubsub()

Summary

Functions

agent_topic(session_id)

Build an agent topic for the given session ID.

approval_topic(session_id)

Build an approval topic for the given session ID.

available?()

Checks if PubSub is available (Phoenix.PubSub loaded and a module configured).

available?(arg1)

Checks if PubSub is available for the given module.

broadcast(pubsub, topic, message)

Broadcast a message on a topic.

configured_pubsub()

Returns the application-configured PubSub module.

research_topic(session_id)

Build a research topic for the given session ID.

subscribe(pubsub, topic)

Subscribe the calling process to a topic.

Functions

agent_topic(session_id)

@spec agent_topic(String.t()) :: String.t()

Build an agent topic for the given session ID.

iex> Nous.PubSub.agent_topic("abc123")
"nous:agent:abc123"

approval_topic(session_id)

@spec approval_topic(String.t()) :: String.t()

Build an approval topic for the given session ID.

iex> Nous.PubSub.approval_topic("abc123")
"nous:approval:abc123"

available?()

@spec available?() :: boolean()

Checks if PubSub is available (Phoenix.PubSub loaded and a module configured).

available?(arg1)

@spec available?(module() | nil) :: boolean()

Checks if PubSub is available for the given module.

Returns true if Phoenix.PubSub is loaded and pubsub is not nil.

broadcast(pubsub, topic, message)

@spec broadcast(module() | nil, String.t() | nil, term()) :: :ok | {:error, term()}

Broadcast a message on a topic.

No-op if PubSub is unavailable.

configured_pubsub()

@spec configured_pubsub() :: module() | nil

Returns the application-configured PubSub module.

Reads from Application.get_env(:nous, :pubsub). Returns nil if not configured.

research_topic(session_id)

@spec research_topic(String.t()) :: String.t()

Build a research topic for the given session ID.

iex> Nous.PubSub.research_topic("abc123")
"nous:research:abc123"

subscribe(pubsub, topic)

@spec subscribe(module() | nil, String.t()) :: :ok | {:error, term()}

Subscribe the calling process to a topic.

No-op if PubSub is unavailable.