Struct GrpcServerBuilder

Source

pub struct GrpcServerBuilder { /* private fields */ }

Available on crate feature router-grpc only.

Expand description

Builder for configuring gRPC servers

Provides a fluent API for setting up gRPC servers with various options including TLS, reflection, health checks, and graceful shutdown.

Implementations§

Source §

impl GrpcServerBuilder

Source

pub fn new() -> Self

Create a new gRPC server builder with default settings

Source

pub fn addr(self, addr: impl Into<SocketAddrInput>) -> Self

Set the address to bind to

§Examples

GrpcServer::builder()
    .addr("[::1]:50051")
    .addr("0.0.0.0:50051")
    .addr(SocketAddr::from(([127, 0, 0, 1], 50051)))

Source

pub fn port(self, port: u16) -> Self

Set the port (uses [::1] as host)

Source

pub fn tls(self, config: TlsConfig) -> Self

Enable TLS with the given configuration

Source

pub fn tls_from_env(self) -> Self

Enable TLS from environment variables

Reads from GRPC_TLS_CERT, GRPC_TLS_KEY, and optionally GRPC_TLS_CLIENT_CA

Source

pub fn reflection(self, file_descriptor_set: &'static [u8]) -> Self

Enable gRPC reflection with the given file descriptor set

The file descriptor set is typically generated by tonic-build and available as a const in your generated code.

§Example

// In your proto build output
pub const FILE_DESCRIPTOR_SET: &[u8] = include_bytes!("proto/descriptor.bin");

// In your server setup
GrpcServer::builder()
    .reflection(FILE_DESCRIPTOR_SET)

Source

pub fn health_check(self) -> Self

Enable gRPC health checking service

This adds the standard gRPC health checking protocol endpoints.

Source

pub fn graceful_shutdown(self, shutdown: GracefulShutdown) -> Self

Set the graceful shutdown handler

When a shutdown signal is received, the server will stop accepting new connections and wait for existing requests to complete.

Source

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

Set the shutdown timeout

How long to wait for existing requests to complete during shutdown. Default is 30 seconds.

Source

pub fn get_addr(&self) -> SocketAddr

Get the configured address

Source

pub fn has_tls(&self) -> bool

Check if TLS is configured

Source

pub fn has_reflection(&self) -> bool

Check if reflection is enabled

Source

pub fn has_health_check(&self) -> bool

Check if health check is enabled

Source

pub async fn serve_router(self, router: Router) -> Result<(), GrpcServerError>

Serve a gRPC router

This method consumes the builder and starts the gRPC server. The server will run until shutdown is signaled or an error occurs.

§Example

use tonic::transport::Server;

// Build your router with services
let router = Server::builder()
    .add_service(MyServiceServer::new(my_service))
    .add_service(OtherServiceServer::new(other_service));

// Use the GrpcServer builder for configuration
GrpcServer::builder()
    .addr("[::1]:50051")
    .graceful_shutdown(shutdown)
    .serve_router(router)
    .await?;

Source

pub fn server_builder(&self) -> Server

Build a tonic Server with reflection service

Returns a tonic::transport::Server builder. Call add_service on it to add your services, then pass the resulting router to serve_router.

Source

pub fn reflection_service( &self, ) -> Result<Option<ServerReflectionServer<impl ServerReflection>>, GrpcServerError>

Create a reflection service from the configured file descriptor set

Returns None if no file descriptor set was configured.

Source

pub fn create_health_reporter( &self, ) -> Option<(HealthReporter, impl Service<Request<Incoming>, Response = Response<Body>, Error = Infallible> + Clone + Send + 'static)>

Check if health check is enabled and return a health reporter

Use the returned function to create the health service. The health_reporter() function returns (HealthReporter, HealthService).

§Example

let builder = GrpcServer::builder().health_check();

if builder.has_health_check() {
    let (mut reporter, service) = tonic_health::server::health_reporter();
    // Add service to router
}

Trait Implementations§

Source §

impl Default for GrpcServerBuilder

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for GrpcServerBuilder

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> FutureExt for T

Source §

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

Source §

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

§

impl<T, U> Into for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §