Skip to main content

ServerConfig

slim_config::server

Struct ServerConfig 

Source 
pub struct ServerConfig {
Show 14 fields
    pub endpoint: String,
    pub tls_setting: TlsServerConfig,
    pub http2_only: bool,
    pub max_frame_size: Option<u32>,
    pub max_concurrent_streams: Option<u32>,
    pub max_header_list_size: Option<u32>,
    pub read_buffer_size: Option<usize>,
    pub write_buffer_size: Option<usize>,
    pub keepalive: KeepaliveServerParameters,
    pub auth: AuthenticationConfig,
    pub metadata: Option<MetadataMap>,
    pub require_header_mac: bool,
    pub negotiation_timeout_secs: u64,
    pub link_hmac_poll_interval_ms: u64,

}

Fields§

§endpoint: String

Endpoint is the address to listen on.

The transport protocol is inferred from the endpoint scheme:

  • ws://, wss:// → WebSocket (TLS when wss)
  • http://, https://, unix://, bare host:port → gRPC
§tls_setting: TlsServerConfig

Configures the protocol to use TLS.

§http2_only: bool

Use HTTP 2 only.

§max_frame_size: Option<u32>

Maximum size (in MiB) of messages accepted by the server.

§max_concurrent_streams: Option<u32>

MaxConcurrentStreams sets the limit on the number of concurrent streams to each ServerTransport.

§max_header_list_size: Option<u32>

Max header list size

§read_buffer_size: Option<usize>

ReadBufferSize for gRPC server.

§write_buffer_size: Option<usize>

WriteBufferSize for gRPC server.

§keepalive: KeepaliveServerParameters

Keepalive anchor for all the settings related to keepalive.

§auth: AuthenticationConfig

Auth for this receiver.

§metadata: Option<MetadataMap>

Arbitrary user-provided metadata.

§require_header_mac: bool

Flag to enforce header integrity validation By default it is true

§negotiation_timeout_secs: u64

Timeout (in seconds) for link negotiation to complete. By default it is 5 seconds.

§link_hmac_poll_interval_ms: u64

Polling interval (in milliseconds) to wait between HMAC existence checks. By default it is 5 milliseconds.

Implementations§

Source§

impl ServerConfig

Source

pub async fn to_server_future<S>( &self, svc: &[S], ) -> Result<ServerFuture, ConfigError>
where S: Service<Request<Body>, Response = Response<Body>, Error = Infallible> + NamedService + Clone + Send + 'static + Sync, S::Future: Send + 'static,

Build the gRPC server future that drives the underlying tonic server.

Returns ConfigError::GrpcServerUnsupportedTransport when invoked on a config whose transport != Grpc.

Source

pub async fn to_server_future_with_routes( &self, routes: Routes, ) -> Result<ServerFuture, ConfigError>

Routes-based variant of Self::to_server_future. This is the canonical entry point — the slice-based overload is kept as a thin compat wrapper used by the gRPC-only run_grpc_server API.

Source

pub async fn run_grpc_server<S>( &self, svc: &[S], drain_rx: Watch, ) -> Result<CancellationToken, ConfigError>
where S: Service<Request<Body>, Response = Response<Body>, Error = Infallible> + NamedService + Clone + Send + 'static + Sync, S::Future: Send + 'static,

Spawn the gRPC server and return a CancellationToken that can be used to stop it. The server is also driven by the supplied drain watch for cooperative shutdown.

Generic over a slice of tonic services for backwards compatibility; the unified entry point is Self::run_server (uses Routes via the crate::ServerHandler trait).

Source

pub async fn run_grpc_server_with_routes( &self, routes: Routes, drain_rx: Watch, ) -> Result<CancellationToken, ConfigError>

Routes-based variant of Self::run_grpc_server. Used internally by Self::run_server.

Source§

impl ServerConfig

Source

pub fn with_endpoint(endpoint: &str) -> Self

Source

pub fn with_tls_settings(self, tls_setting: TLSSetting) -> Self

Source

pub fn with_http2_only(self, http2_only: bool) -> Self

Source

pub fn with_max_frame_size(self, max_frame_size: Option<u32>) -> Self

Source

pub fn with_max_concurrent_streams( self, max_concurrent_streams: Option<u32>, ) -> Self

Source

pub fn with_max_header_list_size( self, max_header_list_size: Option<u32>, ) -> Self

Source

pub fn with_read_buffer_size(self, read_buffer_size: Option<usize>) -> Self

Source

pub fn with_write_buffer_size(self, write_buffer_size: Option<usize>) -> Self

Source

pub fn with_keepalive(self, keepalive: KeepaliveServerParameters) -> Self

Source

pub fn with_auth(self, auth: AuthenticationConfig) -> Self

Source

pub async fn run_server<H: ServerHandler>( &self, watch: Watch, handler: Arc<H>, ) -> Result<CancellationToken, ConfigError>

Transport-agnostic server entry point. Dispatches on self.transport and calls into the matching transport-specific run helper, requesting the appropriate adapter from handler. Returns ConfigError::HandlerMissingGrpcSupport / ConfigError::HandlerMissingWebSocketSupport when the handler does not implement the method for the configured transport.

Source

pub fn resolved_transport(&self) -> TransportProtocol

Resolve the transport protocol for this configuration by inspecting the endpoint URI scheme. See TransportProtocol::from_endpoint.

Source§

impl ServerConfig

Source

pub async fn run_websocket_server( &self, drain_rx: Watch, on_accepted: OnAcceptedWebSocket, ) -> Result<CancellationToken, ConfigError>

Trait Implementations§

Source§

impl Clone for ServerConfig

Source§

fn clone(&self) -> ServerConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Configuration for ServerConfig

Source§

type Error = ConfigError

Source§

fn validate(&self) -> Result<(), Self::Error>

Validate the component configuration
Source§

impl Debug for ServerConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ServerConfig

Default values for ServerConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for ServerConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ServerConfig

Display implementation for ServerConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl JsonSchema for ServerConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for ServerConfig

Source§

fn eq(&self, other: &ServerConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ServerConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ServerConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
Source§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
Source§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
Source§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
Source§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
Source§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
Source§

impl<T> AsDebug for T
where T: Debug,

Source§

fn as_debug(&self) -> &dyn Debug

Returns self as a &dyn Debug trait object.
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

Source§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

Source§

fn coerce_box_to(self: Box<X>) -> Box<T>

Source§

fn coerce_ref_to(&self) -> &T

Source§

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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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
Source§

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

Source§

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§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> TryIntoValue for T
where T: Serialize,

Source§

type Error = SerializationError

Source§

fn try_into_value(self) -> Result<Value, <T as TryIntoValue>::Error>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more