Crate steady_state

Steady State Core - Easy Performant Async

Steady State is a high performance, easy to use, actor based framework for building concurrent applications in Rust. Guarantee your SLA with telemetry, alerts and Prometheus. Build low latency high volume solutions.

Re-exports

• pub use graph_testing::GraphTestResult;
• pub use monitor::LocalMonitor;
• pub use channel_builder::Rate;
• pub use channel_builder::Filled;
• pub use channel_builder::LazySteadyRx;
• pub use channel_builder::LazySteadyTx;
• pub use actor_builder::MCPU;
• pub use actor_builder::Work;
• pub use actor_builder::Percentile;
• pub use actor_builder::ActorTeam;
• pub use steady_rx::Rx;
• pub use steady_tx::Tx;
• pub use steady_rx::SteadyRxBundleTrait;
• pub use steady_tx::SteadyTxBundleTrait;
• pub use steady_rx::RxBundleTrait;
• pub use steady_tx::TxBundleTrait;
• pub use commander::SteadyCommander;
• pub use install::serviced::*;

Modules

• actor_builder
  module for all actor features The actor_builder module provides structures and functions to create, configure, and manage actors within a system. This module includes the ActorBuilder for building actors, ActorTeam for managing groups of actors, and various utility functions and types to support actor creation and telemetry monitoring.
• channel_builder
  module for all channel features
• commander
  module for all commands for channels used by actors
• graph_testing
  module for testing full graphs of actors This module provides utilities for testing graphs in the SteadyState project.
• install
  Installation modules for setting up various deployment methods.
• monitor
  module for all monitor features
• steady_rx
  module for all rx channel features
• steady_tx
  module for all tx channel features
• util
  util module for various utility functions.
• yield_now
  module to yield in our actor This module provides a simple future that yields once before completing.

Macros

• await_for_all
  This macro waits for all the provided futures to complete. It returns a boolean indicating if all futures returned true.
• await_for_all_or_proceed_upon
  This macro waits for either the first future to complete, or all of the rest to complete. It returns a boolean indicating if all futures (or the rest of the futures if the first completes) returned true.
• await_for_any
  This macro waits for any of the provided futures to complete. It returns a boolean indicating if any one of the futures returned true.
• into_monitor
  Macro takes a SteadyContext and a list of Rx and Tx channels and returns a LocalMonitor. The Monitor is the only way to produce metrics for telemetry and prometheus. The macro is used to ensure specifically which channels are monitored.

Structs

• ActorIdentity
  Represents the identity of an actor.
• ActorName
  Represents the name of an actor with its unique and optional usize suffix
• Graph
  Manages the execution of actors in the graph.
• GraphBuilder
  all the preliminary setup for the graph
• GraphLiveliness
  Manages the liveliness state of the graph and handles the shutdown voting process.
• ShutdownVote
  Represents a vote for shutdown by an actor.
• StdDev
  Represents a standard deviation value.
• SteadyContext
  Context for managing actor state and interactions within the Steady framework.

Enums

• AlertColor
  Represents the color of an alert in the Steady State framework.
• GraphLivelinessState
  Represents the state of graph liveliness in the Steady State framework.
• ProactorConfig
  Configuration options for the proactor.
• SendSaturation
  Represents the behavior of the system when the channel is saturated (i.e., full).
• Trigger
  Represents a trigger condition for a metric in the Steady State framework.

Traits

• ComputeMetric
  Represents a Metric suitable for actors which perform computations.
• DataMetric
  Represents a Metric suitable for channels which transfer data.
• LazySteadyRxBundleClone
  Type alias for an array of thread-safe receivers (Rx) with a fixed size (GIRTH), wrapped in an Arc.
• LazySteadyTxBundleClone
  Type alias for an array of thread-safe receivers (Rx) with a fixed size (GIRTH), wrapped in an Arc. This one is special because its clone will lazy create teh channels.
• Metric
  Base Trait for all metrics for use on Telemetry and Prometheus.

Functions

• init_logging
  Creates a bundle of thread-safe receivers (Rx) with a fixed size (GIRTH), wrapped in an Arc.
• new_state
  Create new SteadyState struct for holding state of actors across panics restarts. Should only be called in main when creating the actors
• spawn_blocking
  Runs blocking code on a thread pool.
• spawn_local
  Spawns a task onto the local executor.
• steady_rx_bundle
  Creates a bundle of thread-safe transmitters (Tx) with a fixed size (GIRTH), wrapped in an Arc.
• steady_state
  Lock for use the SteadyState struct which holds state of an actor across panics restarts.
• steady_tx_bundle
  Creates a bundle of thread-safe transmitters (Tx) with a fixed size (GIRTH), wrapped in an Arc.

Type Aliases

• LazySteadyRxBundle
  Type alias for an array of thread-safe receivers (Rx) with a fixed size (GIRTH), wrapped in an Arc.
• LazySteadyTxBundle
  Type alias for an array of thread-safe transmitters (Tx) with a fixed size (GIRTH), wrapped in an Arc.
• RxBundle
  Type alias for a vector of MutexGuard references to receivers (Rx).
• SteadyRx
  Type alias for a thread-safe receiver (Rx) wrapped in an Arc and Mutex.
• SteadyRxBundle
  Type alias for an array of thread-safe receivers (Rx) with a fixed size (GIRTH), wrapped in an Arc.
• SteadyState
  Type alias for a thread-safe steady state (S) wrapped in an Arc and Mutex.
• SteadyTx
  Type alias for a thread-safe transmitter (Tx) wrapped in an Arc and Mutex.
• SteadyTxBundle
  Type alias for an array of thread-safe transmitters (Tx) with a fixed size (GIRTH), wrapped in an Arc.
• TxBundle
  Type alias for a vector of MutexGuard references to transmitters (Tx).