[−][src]Struct tonic::transport::server::Server

pub struct Server { /* fields omitted */ }

A default batteries included transport server.

This is a wrapper around [hyper::Server] and provides an easy builder pattern style builder [Server]. This builder exposes easy configuration parameters for providing a fully featured http2 based gRPC server. This should provide a very good out of the box http2 server for use with tonic but is also a reference implementation that should be a good starting point for anyone wanting to create a more complex and/or specific implementation.

Methods

`impl Server`[src]

`pub fn builder() -> Self`[src]

Create a new server builder that can configure a [Server].

`impl Server`[src]

`pub fn tls_config(self, tls_config: ServerTlsConfig) -> Self`[src]

Configure TLS for this server.

`pub fn concurrency_limit_per_connection(self, limit: usize) -> Self`[src]

Set the concurrency limit applied to on requests inbound per connection.

Example

builder.concurrency_limit_per_connection(32);

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`pub fn timeout(&mut self, timeout: Duration) -> &mut Self`[src]

Set a timeout on for all request handlers.

Example

builder.timeout(Duration::from_secs(30));

`pub fn initial_stream_window_size(self, sz: impl Into<Option<u32>>) -> Self`[src]

Sets the SETTINGS_INITIAL_WINDOW_SIZE option for HTTP2 stream-level flow control.

Default is 65,535

`pub fn initial_connection_window_size(self, sz: impl Into<Option<u32>>) -> Self`[src]

Sets the max connection-level flow control for HTTP2

Default is 65,535

`pub fn max_concurrent_streams(self, max: impl Into<Option<u32>>) -> Self`[src]

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is no limit (None).

`pub fn tcp_keepalive(self, tcp_keepalive: Option<Duration>) -> Self`[src]

Set whether TCP keepalive messages are enabled on accepted connections.

If None is specified, keepalive is disabled, otherwise the duration specified will be the time to remain idle before sending TCP keepalive probes.

Default is no keepalive (None)

`pub fn tcp_nodelay(self, enabled: bool) -> Self`[src]

Set the value of TCP_NODELAY option for accepted connections. Enabled by default.

`pub fn trace_fn<F>(self, f: F) -> Self where F: Fn(&HeaderMap) -> Span + Send + Sync + 'static,` [src]

Intercept inbound headers and add a [tracing::Span] to each response future.

`pub fn add_service<S>(&mut self, svc: S) -> Router<S, Unimplemented> where S: Service<Request<Body>, Response = Response<BoxBody>> + NamedService + Clone + Send + 'static, S::Future: Send + 'static, S::Error: Into<Box<dyn Error + Send + Sync>> + Send,` [src]

Create a router with the S typed service as the first service.

This will clone the Server builder and create a router that will route around different services.

Trait Implementations

`impl Clone for Server`[src]

`fn clone(&self) -> Server`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Server`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Default for Server`[src]

`fn default() -> Server`[src]

Auto Trait Implementations

`impl !RefUnwindSafe for Server`

`impl Send for Server`

`impl Sync for Server`

`impl Unpin for Server`

`impl !UnwindSafe for Server`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T> Instrument for T`[src]

ⓘImportant traits for Instrumented<T>
Important traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`
`fn instrument(self, span: Span) -> Instrumented<Self>`[src]

ⓘImportant traits for Instrumented<T>
Important traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`
`fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

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

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<V, T> VZip<V> for T where V: MultiLane<T>,` [src]

`fn vzip(self) -> V`[src]

`impl<T> WithSubscriber for T`[src]

ⓘImportant traits for WithDispatch<T>
Important traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`
`fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,` [src]

ⓘImportant traits for WithDispatch<T>
Important traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`
`fn with_current_subscriber(self) -> WithDispatch<Self>`[src]

[−][src]Struct tonic::transport::server::Server

Methods

impl Server[src]

pub fn builder() -> Self[src]

impl Server[src]

pub fn tls_config(self, tls_config: ServerTlsConfig) -> Self[src]

pub fn concurrency_limit_per_connection(self, limit: usize) -> Self[src]

Example

ⓘImportant traits for &'_ mut FImportant traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;pub fn timeout(&mut self, timeout: Duration) -> &mut Self[src]

Important traits for &'_ mut F

Example

pub fn initial_stream_window_size(self, sz: impl Into<Option<u32>>) -> Self[src]

pub fn initial_connection_window_size(self, sz: impl Into<Option<u32>>) -> Self[src]

pub fn max_concurrent_streams(self, max: impl Into<Option<u32>>) -> Self[src]

pub fn tcp_keepalive(self, tcp_keepalive: Option<Duration>) -> Self[src]

pub fn tcp_nodelay(self, enabled: bool) -> Self[src]

pub fn trace_fn<F>(self, f: F) -> Self where F: Fn(&HeaderMap) -> Span + Send + Sync + 'static, [src]

pub fn add_service<S>(&mut self, svc: S) -> Router<S, Unimplemented> where S: Service<Request<Body>, Response = Response<BoxBody>> + NamedService + Clone + Send + 'static, S::Future: Send + 'static, S::Error: Into<Box<dyn Error + Send + Sync>> + Send, [src]

Trait Implementations

impl Clone for Server[src]

fn clone(&self) -> Server[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Server[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl Default for Server[src]

fn default() -> Server[src]

Auto Trait Implementations

impl !RefUnwindSafe for Server

impl Send for Server

impl Sync for Server

impl Unpin for Server

impl !UnwindSafe for Server

Blanket Implementations

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

fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

ⓘImportant traits for &'_ mut FImportant traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;fn borrow(&self) -> &T[src]

Important traits for &'_ mut F

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

ⓘImportant traits for &'_ mut FImportant traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;fn borrow_mut(&mut self) -> &mut T[src]

Important traits for &'_ mut F

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T> Instrument for T[src]

ⓘImportant traits for Instrumented<T>Important traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;fn instrument(self, span: Span) -> Instrumented<Self>[src]

Important traits for Instrumented<T>

ⓘImportant traits for Instrumented<T>Important traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;fn in_current_span(self) -> Instrumented<Self>[src]

Important traits for Instrumented<T>

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>, [src]

fn vzip(self) -> V[src]

impl<T> WithSubscriber for T[src]

ⓘImportant traits for WithDispatch<T>Important traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>, [src]

Important traits for WithDispatch<T>

ⓘImportant traits for WithDispatch<T>Important traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;fn with_current_subscriber(self) -> WithDispatch<Self>[src]

Important traits for WithDispatch<T>

`impl Server`[src]

`pub fn builder() -> Self`[src]

`impl Server`[src]

`pub fn tls_config(self, tls_config: ServerTlsConfig) -> Self`[src]

`pub fn concurrency_limit_per_connection(self, limit: usize) -> Self`[src]

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`pub fn timeout(&mut self, timeout: Duration) -> &mut Self`[src]

`pub fn initial_stream_window_size(self, sz: impl Into<Option<u32>>) -> Self`[src]

`pub fn initial_connection_window_size(self, sz: impl Into<Option<u32>>) -> Self`[src]

`pub fn max_concurrent_streams(self, max: impl Into<Option<u32>>) -> Self`[src]

`pub fn tcp_keepalive(self, tcp_keepalive: Option<Duration>) -> Self`[src]

`pub fn tcp_nodelay(self, enabled: bool) -> Self`[src]

`pub fn trace_fn<F>(self, f: F) -> Self where F: Fn(&HeaderMap) -> Span + Send + Sync + 'static,` [src]

`pub fn add_service<S>(&mut self, svc: S) -> Router<S, Unimplemented> where S: Service<Request<Body>, Response = Response<BoxBody>> + NamedService + Clone + Send + 'static, S::Future: Send + 'static, S::Error: Into<Box<dyn Error + Send + Sync>> + Send,` [src]

`impl Clone for Server`[src]

`fn clone(&self) -> Server`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Server`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Default for Server`[src]

`fn default() -> Server`[src]

`impl !RefUnwindSafe for Server`

`impl Send for Server`

`impl Sync for Server`

`impl Unpin for Server`

`impl !UnwindSafe for Server`

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T> Instrument for T`[src]

ⓘImportant traits for Instrumented<T>
Important traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`
`fn instrument(self, span: Span) -> Instrumented<Self>`[src]

ⓘImportant traits for Instrumented<T>
Important traits for Instrumented<T>
`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`
`fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

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

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

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

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

`impl<V, T> VZip<V> for T where V: MultiLane<T>,` [src]

`fn vzip(self) -> V`[src]

`impl<T> WithSubscriber for T`[src]

ⓘImportant traits for WithDispatch<T>
Important traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`
`fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,` [src]

ⓘImportant traits for WithDispatch<T>
Important traits for WithDispatch<T>
`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`
`fn with_current_subscriber(self) -> WithDispatch<Self>`[src]