jina.serve.runtimes.gateway package

Subpackages

• jina.serve.runtimes.gateway.composite package
  • Submodules
    • jina.serve.runtimes.gateway.composite.gateway module
      • CompositeGateway
  • Module contents
    • CompositeGateway
      • CompositeGateway.setup_server()
      • CompositeGateway.shutdown()
      • CompositeGateway.run_server()
      • CompositeGateway.host
      • CompositeGateway.is_valid_jaml()
      • CompositeGateway.load_config()
      • CompositeGateway.port
      • CompositeGateway.ports
      • CompositeGateway.protocols
      • CompositeGateway.save_config()
• jina.serve.runtimes.gateway.graph package
  • Submodules
    • jina.serve.runtimes.gateway.graph.topology_graph module
      • TopologyGraph
  • Module contents
• jina.serve.runtimes.gateway.grpc package
  • Submodules
    • jina.serve.runtimes.gateway.grpc.gateway module
      • GRPCGateway
  • Module contents
    • GRPCGateway
      • GRPCGateway.setup_server()
      • GRPCGateway.shutdown()
      • GRPCGateway.run_server()
      • GRPCGateway.dry_run()
      • GRPCGateway.stream()
      • GRPCGateway.process_single_data()
      • GRPCGateway.Call()
      • GRPCGateway.host
      • GRPCGateway.is_valid_jaml()
      • GRPCGateway.load_config()
      • GRPCGateway.port
      • GRPCGateway.ports
      • GRPCGateway.protocols
      • GRPCGateway.save_config()
• jina.serve.runtimes.gateway.http package
  • Submodules
    • jina.serve.runtimes.gateway.http.app module
      • get_fastapi_app()
    • jina.serve.runtimes.gateway.http.fastapi module
      • FastAPIBaseGateway
    • jina.serve.runtimes.gateway.http.gateway module
      • HTTPGateway
    • jina.serve.runtimes.gateway.http.models module
      • CustomConfig
      • protobuf_to_pydantic_model()
      • JinaHealthModel
      • JinaInfoModel
      • JinaRequestModel
      • JinaResponseModel
      • JinaEndpointRequestModel
  • Module contents
    • HTTPGateway
      • HTTPGateway.app
      • HTTPGateway.host
      • HTTPGateway.is_valid_jaml()
      • HTTPGateway.load_config()
      • HTTPGateway.port
      • HTTPGateway.ports
      • HTTPGateway.protocols
      • HTTPGateway.run_server()
      • HTTPGateway.save_config()
      • HTTPGateway.setup_server()
      • HTTPGateway.shutdown()
• jina.serve.runtimes.gateway.websocket package
  • Submodules
    • jina.serve.runtimes.gateway.websocket.app module
      • get_fastapi_app()
    • jina.serve.runtimes.gateway.websocket.gateway module
      • WebSocketGateway
  • Module contents
    • WebSocketGateway
      • WebSocketGateway.setup_server()
      • WebSocketGateway.shutdown()
      • WebSocketGateway.run_server()
      • WebSocketGateway.host
      • WebSocketGateway.is_valid_jaml()
      • WebSocketGateway.load_config()
      • WebSocketGateway.port
      • WebSocketGateway.ports
      • WebSocketGateway.protocols
      • WebSocketGateway.save_config()

Submodules

• jina.serve.runtimes.gateway.request_handling module
  • GatewayRequestHandler
    • GatewayRequestHandler.handle_request()
    • GatewayRequestHandler.handle_result()

Module contents

class jina.serve.runtimes.gateway.GatewayRuntime(args, cancel_event=None, **kwargs)

Bases: AsyncNewLoopRuntime

The Gateway Runtime that starts a gateway pod. The GatewayRuntime is associated with a Gateway class that inherits BaseGateway. While the Gateway class takes care of server and application logic and serving gRPC/HTTP/Websocket API, The GatewayRuntime is responsible of instantiating the right Gateway class, injecting right parameters to it and running/terminating the Gateway object.

async async_setup()

The async method setup the runtime.

Setup the uvicorn server.

async async_teardown()

Shutdown the server.

async async_cancel()

Stop the server.

async async_run_forever()

Running method of the server.

static is_ready(ctrl_address, protocol='grpc', timeout=1.0, **kwargs)

Check if status is ready.

Parameters:

• ctrl_address (str) – the address where the control request needs to be sent

• protocol (Optional[str]) – protocol of the gateway runtime

• timeout (float) – timeout of grpc call in seconds

• kwargs – extra keyword arguments

Return type:

bool

Returns:

True if status is ready else False.

classmethod wait_for_ready_or_shutdown(timeout, ready_or_shutdown_event, ctrl_address, protocol='grpc', **kwargs)

Check if the runtime has successfully started

Parameters:

• timeout (Optional[float]) – The time to wait before readiness or failure is determined

• ctrl_address (str) – the address where the control message needs to be sent

• ready_or_shutdown_event (Union[Event, Event]) – the multiprocessing event to detect if the process failed or is ready

• protocol (Optional[str]) – protocol of the gateway runtime

• kwargs – extra keyword arguments

Returns:

True if is ready or it needs to be shutdown

aio_tracing_client_interceptors()

Create a gRPC client aio channel interceptor. :rtype: Optional[Sequence[ClientInterceptor]] :returns: An invocation-side list of aio interceptor objects.

aio_tracing_server_interceptors()

Create a gRPC aio server interceptor. :rtype: Optional[Sequence[ServerInterceptor]] :returns: A service-side aio interceptor object.

async cancel_warmup_task()

Cancel warmup task if exists and is not completed. Cancellation is required if the Flow is being terminated before the task is successful or hasn’t reached the max timeout.

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.

tracing_client_interceptor()

Return type:

Optional[OpenTelemetryClientInterceptor]

Returns:

a gRPC client interceptor with the global tracing provider.