relay_system/
lib.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
//! Foundational system components for Relay's services.
//!
//! Relay's system is based on [`tokio`]. To use any of these components, ensure a tokio runtime is
//! available.
//!
//! # Services
//!
//! The basic building block in Relay are asynchronous [`Service`]s. Each service implements an
//! [`Interface`], which consists of one or many messages that can be sent to the service using its
//! [`Addr`]. See the docs of these types for more information on how to implement and use them.
//!
//! # Shutdown
//!
//! The static [`Controller`] service can listen for process signals and initiate a graceful
//! shutdown. Note that services must check a [`ShutdownHandle`] to receive these signals. See the
//! struct level documentation for more information.

#![warn(missing_docs)]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/getsentry/relay/master/artwork/relay-icon.png",
    html_favicon_url = "https://raw.githubusercontent.com/getsentry/relay/master/artwork/relay-icon.png"
)]
#![allow(clippy::derive_partial_eq_without_eq)]

mod controller;
mod runtime;
mod service;
mod statsd;

pub use self::controller::*;
pub use self::runtime::*;
pub use self::service::*;