tonic/server/mod.rs
1/*
2 *
3 * Copyright 2025 gRPC authors.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 *
23 */
24
25//! Generic server implementation.
26//!
27//! This module contains the low level components to build a gRPC server. It
28//! provides a codec agnostic gRPC server handler.
29//!
30//! The items in this module are generally designed to be used by some codegen
31//! tool that will provide the user some custom way to implement the server that
32//! will implement the proper gRPC service. Thusly, they are a bit hard to use
33//! by hand.
34
35mod grpc;
36mod service;
37
38pub use self::grpc::Grpc;
39pub use self::service::{
40 ClientStreamingService, ServerStreamingService, StreamingService, UnaryService,
41};
42
43/// A trait to provide a static reference to the service's
44/// name. This is used for routing service's within the router.
45pub trait NamedService {
46 /// The `Service-Name` as described [here].
47 ///
48 /// [here]: https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests
49 const NAME: &'static str;
50}