jina.serve.runtimes.gateway.websocket package#
Submodules#
Module contents#
- class jina.serve.runtimes.gateway.websocket.WebSocketGatewayRuntime(args, cancel_event=None, **kwargs)[source]#
Bases:
GatewayRuntime
Runtime for Websocket interface.
- static activate(**kwargs)#
Activate the runtime, does not apply to these runtimes
- Parameters:
kwargs – extra keyword arguments
- static is_ready(ctrl_address, **kwargs)#
Check if status is ready.
- Parameters:
ctrl_address (
str
) – the address where the control request needs to be sentkwargs – extra keyword arguments
- Return type:
bool
- Returns:
True if status is ready else False.
- run_forever()#
Running method to block the main thread.
Run the event loop until a Future is done.
- teardown()#
Call async_teardown() and stop and close the event loop.
- static wait_for_ready_or_shutdown(timeout, ready_or_shutdown_event, ctrl_address, **kwargs)#
Check if the runtime has successfully started
- Parameters:
timeout (
Optional
[float
]) – The time to wait before readiness or failure is determinedctrl_address (
str
) – the address where the control message needs to be sentready_or_shutdown_event (
Union
[Event
,Event
]) – the multiprocessing event to detect if the process failed or is readykwargs – extra keyword arguments
- Returns:
True if is ready or it needs to be shutdown