Module sse 

Server-Sent Events (SSE) responses.

Example

use axum::{
    Router,
    routing::get,
    response::sse::{Event, KeepAlive, Sse},
};
use std::{time::Duration, convert::Infallible};
use tokio_stream::StreamExt as _ ;
use futures_util::stream::{self, Stream};

let app = Router::new().route("/sse", get(sse_handler));

async fn sse_handler() -> Sse<impl Stream<Item = Result<Event, Infallible>>> {
    // A `Stream` that repeats an event every second
    let stream = stream::repeat_with(|| Event::default().data("hi!"))
        .map(Ok)
        .throttle(Duration::from_secs(1));

    Sse::new(stream).keep_alive(KeepAlive::default())
}

Structs

Event

Server-sent event

EventDataWriter

Expose Event as a std::fmt::Write such that any form of data can be written as data safely.

KeepAlive

Configure the interval between keep-alive messages, the content of each message, and the associated stream.

KeepAliveStream

A wrapper around a stream that produces keep-alive events

Sse

An SSE response