Struct SseSubscriber 

pub struct SseSubscriber { /* private fields */ }

SSE subscriber for OpenCode events.

Implementations

impl SseSubscriber

pub fn new( base_url: String, directory: Option<String>, last_event_id: Arc<RwLock<Option<String>>>, ) -> Self

Create a new SSE subscriber.

pub async fn subscribe_session( &self, session_id: &str, opts: SseOptions, ) -> Result<SseSubscription>

Subscribe to events, optionally filtered by session ID.

OpenCode’s /event endpoint streams all events for the configured directory. If session_id is provided, events will be filtered client-side to only include events for that session.

Errors

Returns an error if the subscription cannot be created.

pub async fn subscribe(&self, opts: SseOptions) -> Result<SseSubscription>

Subscribe to all events for the configured directory.

This uses the /event endpoint which streams all events for the directory specified via the x-opencode-directory header.

Errors

Returns an error if the subscription cannot be created.

pub async fn subscribe_typed(&self, opts: SseOptions) -> Result<SseSubscription>

Subscribe to all events for the configured directory as typed Event values.

This is equivalent to Self::subscribe, but explicitly named to distinguish it from Self::subscribe_raw.

pub async fn subscribe_global( &self, opts: SseOptions, ) -> Result<SseSubscription>

Subscribe to global events (all directories).

This uses the /global/event endpoint which streams events from all OpenCode instances across all directories. Events are wrapped in a GlobalEventEnvelope with directory context.

Errors

Returns an error if the subscription cannot be created.

pub async fn subscribe_typed_global( &self, opts: SseOptions, ) -> Result<SseSubscription>

Subscribe to global events as typed Event values (all directories).

pub async fn subscribe_raw( &self, opts: SseOptions, ) -> Result<RawSseSubscription>

Subscribe to raw JSON SSE frames from the configured directory’s /event stream.

This is intended for debugging and parity verification.

pub async fn session_event_router( &self, opts: SessionEventRouterOptions, ) -> Result<SessionEventRouter>

Create a session event router with one upstream /event subscription.

Trait Implementations

impl Clone for SseSubscriber

fn clone(&self) -> SseSubscriber

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.