Skip to content

Document PushHandleInner purpose #250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leynos merged 3 commits into from
Aug 3, 2025
Merged

Document PushHandleInner purpose #250

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f1ada1
Document PushHandleInner purpose
leynos Aug 3, 2025
f858746
Document PushHandleInner fields
leynos Aug 3, 2025
d5e22ef
Fix formatting
leynos Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/push.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,15 @@ impl std::fmt::Display for PushConfigError {

impl std::error::Error for PushConfigError {}

/// Shared state for [`PushHandle`].
///
/// Holds the high- and low-priority channels alongside an optional rate
/// limiter and dead-letter queue sender used when pushes are discarded.
///
/// - `high_prio_tx` – channel for frames that must be sent before any low-priority traffic.
/// - `low_prio_tx` – channel for best-effort frames.
/// - `limiter` – optional rate-limiter enforcing global push throughput.
/// - `dlq_tx` – optional dead-letter queue for discarded frames.
pub(crate) struct PushHandleInner<F> {
high_prio_tx: mpsc::Sender<F>,
low_prio_tx: mpsc::Sender<F>,
Expand Down
Loading