Struct apollo_router::RouterHttpServer

pub struct RouterHttpServer { /* private fields */ }

The entry point for running the Router’s HTTP server.

Examples

use apollo_router::RouterHttpServer;
use apollo_router::Configuration;

async {
    let configuration = serde_yaml::from_str::<Configuration>("Config").unwrap();
    let schema = "schema";
    RouterHttpServer::builder()
            .configuration(configuration)
            .schema(schema)
            .start()
            .await;
};

Shutdown via handle.

use apollo_router::RouterHttpServer;
use apollo_router::Configuration;

async {
    let configuration = serde_yaml::from_str::<Configuration>("Config").unwrap();
    let schema = "schema";
    let mut server = RouterHttpServer::builder()
            .configuration(configuration)
            .schema(schema)
            .start();
    // …
    server.shutdown().await
};

Implementations

impl RouterHttpServer

pub async fn listen_address(&self) -> Option<ListenAddr>

Returns the listen address when the router is ready to receive GraphQL requests.

This can be useful when the server.listen configuration specifies TCP port 0, which instructs the operating system to pick an available port number.

Note: if configuration is dynamic, the listen address can change over time.

pub async fn extra_listen_adresses(&self) -> Vec<ListenAddr>

Returns the extra listen addresses the router can receive requests to.

Combine it with listen_address to have an exhaustive list of all addresses used by the router. Note: if configuration is dynamic, the listen address can change over time.

pub async fn shutdown(&mut self) -> Result<(), ApolloRouterError>

Trigger and wait for graceful shutdown

impl RouterHttpServer

pub fn builder(
) -> __RouterHttpServerBuilder<(__Required<SchemaSource>, __Optional<Option<ConfigurationSource>>, __Optional<Option<EntitlementSource>>, __Optional<Option<ShutdownSource>>)>

Returns a builder to start an HTTP server in a separate Tokio task.

Builder methods:

• .schema(impl Into<SchemaSource>) Required. Specifies where to find the supergraph schema definition. Some sources support hot-reloading.

• .configuration(impl Into<ConfigurationSource>) Optional. Specifies where to find the router configuration. If not provided, the default configuration as with an empty YAML file.

• .entitlement(impl Into<EntitlementSource>) Optional. Specifies where to find the router entitlement which controls if commercial features are enabled or not. If not provided then commercial features will not be enabled.

• .shutdown(impl Into<ShutdownSource>) Optional. Specifies when the server should gracefully shut down. If not provided, the default is ShutdownSource::CtrlC.

• .start() Finishes the builder, starts an HTTP server in a separate Tokio task, and returns a RouterHttpServer handle.

The server handle can be used in multiple ways. As a Future, it resolves to Result<(), ApolloRouterError> either when the server has finished gracefully shutting down or when it encounters a fatal error that prevents it from starting.

If the handle is dropped before being awaited as a future, a graceful shutdown is triggered. In order to wait until shutdown finishes, use the shutdown method instead.

Trait Implementations

impl Drop for RouterHttpServer

fn drop(&mut self)

Executes the destructor for this type.

impl Future for RouterHttpServer

type Output = Result<(), ApolloRouterError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.