Skip to main content

open_net/api/ws/
mod.rs

1//! WebSocket session API and owned value types.
2mod application_heartbeat;
3mod identity;
4pub use crate::subscription::SubscriptionId;
5pub use application_heartbeat::{
6    ApplicationHeartbeatConfig, ApplicationHeartbeatFailureAction, ApplicationHeartbeatHandle,
7    ApplicationHeartbeatMatcher, ApplicationHeartbeatSnapshot, ApplicationHeartbeatState,
8};
9pub use identity::{AttemptId, ClientId, ConnectionId, CycleId, OperationId, SessionId};
10mod close;
11mod incoming;
12mod message;
13mod request;
14mod request_id;
15mod response;
16mod value_limits;
17pub use close::{CloseFrame, IoEndKind, PeerClose};
18pub(crate) use incoming::IncomingOrigin;
19pub use incoming::{IncomingMessage, IncomingPayload};
20pub use message::Message;
21pub use request::Request;
22pub use request_id::RequestId;
23pub use response::Response;
24
25mod config;
26pub use config::{
27    DispatchLimits, FrameConfig, HeartbeatConfig, HeartbeatRetryConfig, QueueLimit, QueueLimits,
28    RequestLimits, TcpConfig, TcpKeepaliveConfig, WebSocketClientConfig,
29};
30
31mod reconnect;
32pub use reconnect::{BackoffConfig, ReconnectPolicy};
33
34mod receive_options;
35pub use receive_options::{EventOptions, ReceiveOptions, ReceiveOverflow, TaskEventOptions};
36
37mod handshake_diagnostic;
38pub use handshake_diagnostic::{
39    HandshakeBodyCaptureState, HandshakeDiagnostic, HandshakeDiagnosticKind,
40    HandshakeDiagnosticOptions,
41};
42
43mod handshake;
44pub(crate) use handshake::validate_headers;
45pub use handshake::{HandshakeAttempt, HandshakeHeaders, HandshakeProvider};
46pub(crate) use value_limits::validate_metadata;
47
48mod connection;
49pub(crate) use connection::MAX_CONNECTION_EVENT_BYTES;
50pub use connection::{
51    ConnectionEnd, ConnectionEvent, ConnectionEventKind, ConnectionInfo, ConnectionSnapshot,
52    ConnectionState, JournalOptions, RetryDecision, SessionEnd, TerminationReason,
53};
54
55/// Receiver for retained connection lifecycle events.
56pub type ConnectionJournal = crate::subscription::EventReceiver<ConnectionEvent>;
57/// Receiver for live connection lifecycle events.
58pub type ConnectionEvents = crate::subscription::EventReceiver<ConnectionEvent>;
59
60pub(crate) mod cancellation;
61pub use cancellation::{CancellationGroup, CancellationGuard};
62
63mod operation;
64pub use operation::{
65    DeliveryEvidence, OperationPhase, OperationSnapshot, TaskSuccess, TerminationOutcome,
66    WriteOutcome,
67};
68
69mod options;
70pub(crate) mod retry;
71pub use options::{
72    DisconnectedPolicy, MessageLane, Priority, RequestOptions, ResponseTimeoutOrigin, SendOptions,
73};
74pub use retry::{
75    WsReplaySafety, WsRequestRetryContext, WsRequestRetryOn, WsRequestRetryPolicy,
76    WsRequestRetryPolicyBuilder, WsSendRetryContext, WsSendRetryOn, WsSendRetryPolicy,
77    WsSendRetryPolicyBuilder, WsTimeoutPhase,
78};
79
80mod task;
81pub use task::{TaskEndCause, TaskEvent, TaskEvents, TaskSource};
82
83pub(crate) mod request_control;
84pub use request_control::{RequestHandle, RequestRegistration, RequestSnapshot};
85mod routing;
86pub use routing::{
87    ResolveOutcome, ResponseProtocol, ResponseResolver, ResponseRoute, ResponseRouting,
88};
89mod connect_options;
90pub use connect_options::{ConnectOptions, InitialMessages};
91
92/// Receiver for incoming WebSocket messages.
93pub type MessageReceiver = crate::subscription::EventReceiver<IncomingMessage>;
94
95mod dispatch;
96mod send;
97pub use send::{MessageBuilder, MessageReceipt, PreparedMessage, Sender};
98mod request_operation;
99pub use request_operation::{
100    RequestAttemptContext, WsRequestOperationBuilder, WsRequestOperationHandle,
101    WsRequestOperationOptions, WsRequestOperationReceipt,
102};
103mod request_client;
104pub use request_client::{PreparedRequest, RequestBuilder, RequestClient, RequestReceipt};
105mod client;
106pub use client::WebSocketClient;
107mod session;
108pub use session::Session;
109
110#[cfg(test)]
111mod debug_privacy_tests;