Struct afire::server_sent_events::ServerSentEventStream
source · pub struct ServerSentEventStream {
pub last_index: Option<u32>,
/* private fields */
}
Expand description
A server-sent event stream.
For more information and usage examples, visit the module level documentation.
Fields§
§last_index: Option<u32>
If the EventSource connection gets reset, the client will send the last received event id in the Last-Event-ID
header.
This will be available here, if applicable.
Implementations§
source§impl ServerSentEventStream
impl ServerSentEventStream
sourcepub fn send(&self, event_type: impl AsRef<str>, data: impl Display)
pub fn send(&self, event_type: impl AsRef<str>, data: impl Display)
Sends a new event with the given event type and data.
sourcepub fn send_id(&self, event_type: impl AsRef<str>, id: u32, data: impl Display)
pub fn send_id(&self, event_type: impl AsRef<str>, id: u32, data: impl Display)
Sends a new event with the given event type and id.
sourcepub fn send_event(&self, event: Event)
pub fn send_event(&self, event: Event)
Sends a new event with an Event struct.
sourcepub fn set_retry(&self, retry: u32)
pub fn set_retry(&self, retry: u32)
Sets the retry interval in milliseconds. Calling this will signal the client to try to reconnect after the given amount of milliseconds.
sourcepub fn close(&self)
pub fn close(&self)
Closes the SSE stream. This will leave the socket open, so a new SSEStream could be created. Note: The client will likely try to reconnect automatically after a few seconds.
sourcepub fn from_request(this: &Request) -> Result<Self>
pub fn from_request(this: &Request) -> Result<Self>
Creates a new SSE stream from the given request.
This is called automatically if you use the ServerSentEventsExt
trait’s .sse() method.