Struct StreamParams 

pub struct StreamParams<M, F> {
    pub sub: SubscriptionId,
    pub method: &'static str,
    pub limiter: Arc<BrokerLimiter>,
    pub tokens: Arc<TokenManager>,
    pub open: Arc<dyn Fn() -> Pin<Box<dyn Future<Output = Result<Streaming<M>, Status>> + Send>> + Send + Sync>,
    pub open_timeout: Duration,
    pub wrap: Arc<dyn Fn(StreamEvent<M>) -> F + Send + Sync>,
    pub tx: Sender<F>,
    pub first: Option<Sender<Result<(), FinamError>>>,
}

Everything spawn_stream needs. M is the message type of the stream, F the frame type the connector wants.

Fields

sub: SubscriptionId

The subscription this stream serves. Only used for logging here.

method: &'static str

Limiter key of the open call (SubscribeOrders, …).

limiter: Arc<BrokerLimiter>

Rate limiter. A refused open waits for the time the limiter gives and tries again.

tokens: Arc<TokenManager>

Token manager. The supervisor asks it for a renewal after UNAUTHENTICATED.

open: Arc<dyn Fn() -> Pin<Box<dyn Future<Output = Result<Streaming<M>, Status>> + Send>> + Send + Sync>

How to open the stream.

open_timeout: Duration

How long one open attempt may take before it counts as a failure.

wrap: Arc<dyn Fn(StreamEvent<M>) -> F + Send + Sync>

Turns a StreamEvent into the connector’s frame.

tx: Sender<F>

Where the frames go. When the receiver is gone, the supervisor ends.

first: Option<Sender<Result<(), FinamError>>>

Receives the outcome of the FIRST open attempt, once. Used by subscribe_* to return a refusal.