module documentation

FiftyOne Server events listening.

Copyright 2017-2025, Voxel51, Inc.

Async Function add_event_listener Add an event listener to the server
Async Function disconnect Disconnect a listener
async def add_event_listener(request: Request, payload: ListenPayload) -> t.AsyncIterator: (source)

Add an event listener to the server

Parameters
request:Requestthe event source request
payload:ListenPayloadthe initialization payload
Returns
t.AsyncIteratorA server sent event source
async def disconnect(is_app: bool, listeners: set[tuple[str, Listener]]): (source)

Disconnect a listener

Parameters
is_app:boolwhether is an app listener
listeners:set[tuple[str, Listener]]events the listener has subscribed to
Returns
A closed session event or None