Struct XdsServerBuilder 

pub struct XdsServerBuilder { /* private fields */ }

Builder for creating an XdsServer.

Example

use xds_server::XdsServerBuilder;
use xds_cache::ShardedCache;
use std::sync::Arc;
use std::time::Duration;

let cache = Arc::new(ShardedCache::new());
let _server = XdsServerBuilder::new()
    .cache(cache)
    .enable_sotw()
    .enable_delta()
    .enable_health_check()
    .enable_metrics()
    .graceful_shutdown(Duration::from_secs(30))
    .max_concurrent_streams(200)
    .build()?;

Implementations

impl XdsServerBuilder

pub fn new() -> Self

Create a new server builder.

pub fn cache(self, cache: Arc<ShardedCache>) -> Self

Set the cache to use.

This is required.

pub fn registry(self, registry: Arc<ResourceRegistry>) -> Self

Set the resource registry.

If not set, a default registry will be created.

pub fn enable_sotw(self) -> Self

Enable State-of-the-World protocol (enabled by default).

pub fn disable_sotw(self) -> Self

Disable State-of-the-World protocol.

pub fn enable_delta(self) -> Self

Enable Delta xDS protocol.

pub fn disable_delta(self) -> Self

Disable Delta xDS protocol.

pub fn max_concurrent_streams(self, max: u32) -> Self

Set maximum concurrent streams per connection.

pub fn keepalive_interval(self, interval: Duration) -> Self

Set keepalive interval.

pub fn keepalive_timeout(self, timeout: Duration) -> Self

Set keepalive timeout.

pub fn max_request_size(self, size: usize) -> Self

Set maximum request size in bytes.

pub fn enable_compression(self) -> Self

Enable gzip compression for responses.

pub fn compression(self, config: CompressionConfig) -> Self

Set custom compression configuration.

pub fn enable_health_check(self) -> Self

Enable gRPC health checking (enabled by default).

pub fn disable_health_check(self) -> Self

Disable gRPC health checking.

pub fn enable_metrics(self) -> Self

Enable Prometheus metrics (enabled by default).

pub fn disable_metrics(self) -> Self

Disable Prometheus metrics.

pub fn enable_connection_tracking(self) -> Self

Enable connection tracking (enabled by default).

pub fn disable_connection_tracking(self) -> Self

Disable connection tracking.

pub fn graceful_shutdown(self, grace_period: Duration) -> Self

Set the graceful shutdown grace period.

During shutdown, the server will:

1. Stop accepting new connections
2. Mark health as not serving
3. Wait for existing connections to drain (up to grace period)
4. Force close remaining connections

pub fn connection_limits(self, limits: ConnectionLimits) -> Self

Set connection limits.

Controls maximum total connections and per-IP limits.

pub fn max_connections(self, max: u64) -> Self

Set maximum total connections.

pub fn max_connections_per_ip(self, max: u64) -> Self

Set maximum connections per IP address.

pub fn tls_config(self, config: ServerTlsConfig) -> Self

Available on crate feature tls only.

Configure TLS (and optionally mTLS) for the gRPC server.

Pass a tonic::transport::ServerTlsConfig populated with the server identity (identity()) and, for mTLS, the client CA (client_ca_root() / client_auth_optional()).

Example

use tonic::transport::{Identity, ServerTlsConfig};

let cert = std::fs::read("server.pem")?;
let key = std::fs::read("server.key")?;
let tls = ServerTlsConfig::new().identity(Identity::from_pem(cert, key));

let _server = XdsServerBuilder::new()
    .cache(cache)
    .tls_config(tls)
    .build()?;

Available only when the tls feature is enabled.

pub fn build(self) -> XdsResult<XdsServer>

Build the server.

Errors

Returns an error if:

• No cache was provided
• Neither SotW nor Delta is enabled

Trait Implementations

impl Debug for XdsServerBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for XdsServerBuilder

fn default() -> Self

Returns the “default value” for a type.