fiftyone.server.events

FiftyOne Server events

Copyright 2017-2022, Voxel51, Inc.

voxel51.com

Classes:

InitializedListener(is_app, …)
Listener(queue, subscription)

Functions:

add_event_listener(request, payload)	Add an event listener to the server
dispatch_event(subscription, event)	Dispatch an event to all listeners registed for the server process
dispatch_polling_event_listener(request, payload)	Polling event listener interface
get_state()	Get the current state description singleton on the server

class fiftyone.server.events.Listener(queue: asyncio.queues.Queue, subscription: str)

Bases: object

Attributes:

fiftyone.server.events.Listener.queue
fiftyone.server.events.Listener.subscription

queue: asyncio.Queue = None

subscription: str = None

async fiftyone.server.events.dispatch_event(subscription: Optional[str], event: Union[CaptureNotebookCell, CloseSession, DeactivateNotebookCell, ReactivateNotebookCell, RefreshApp, StateUpdate]) → None

Dispatch an event to all listeners registed for the server process

Parameters

• subscription – the calling subscription id

• event – the event

fiftyone.server.events.add_event_listener(request: starlette.requests.Request, payload: fiftyone.core.session.events.ListenPayload) → AsyncIterator

Add an event listener to the server

Parameters

• request – the event source request

• payload – the initialization payload

Returns

A server sent event source

async fiftyone.server.events.dispatch_polling_event_listener(request: starlette.requests.Request, payload: fiftyone.core.session.events.ListenPayload) → Dict

Polling event listener interface

Note

The polling event listener is a singleton, and is only a fallback for Google’s Colaboratory connections

Parameters

• request – the event source request

• payload – the initialization payload

Returns

A server sent event source

fiftyone.server.events.get_state() → fiftyone.core.state.StateDescription

Get the current state description singleton on the server

Returns

the fiftyone.core.state.StateDescription server singleton

class fiftyone.server.events.InitializedListener(is_app: bool, request_listeners: Set[Tuple[str, fiftyone.server.events.Listener]], state: fiftyone.core.state.StateDescription)

Bases: object

Attributes:

fiftyone.server.events.InitializedListener.is_app
fiftyone.server.events.InitializedListener.request_listeners
fiftyone.server.events.InitializedListener.state

is_app: bool = None

request_listeners: t.Set[t.Tuple[str, Listener]] = None

state: fos.StateDescription = None