Module fire_http_api::stream

Available on crate feature feature only.

Stream protocol based on websocket

// the client want's to start a sender stream
Client > kind: SenderRequest action: "MyAction" data: request
// the server acknowledge the request / or sends a SenderClose
Server > kind: SenderRequest action: "MyAction" data: null
// the client can now start to send messages
Client > kind: SenderMessage action: "MyAction" data: message
// either the client or the server can send a SenderClose
// which will indicate that the stream should be terminated
Server > kind: SenderClose action: "MyAction" data: null|error

Re-exports

pub use server::StreamServer;

pub use error::StreamError;

pub use streamer::Streamer;

Modules

error

message

The names are in the perspective of the client

server

streamer

util

Enums

StreamKind

Note

Traits

Stream

The struct of the stream itself is like a request to start the stream