OxL Reference

method Reply.sse

A server-sent events stream (text/event-stream); producer sends events until it returns or the client leaves.

Example:

oxl✓ checked in CI
use std.http { Server, ServerConfig, ServerHandle, Router, Request, Reply, Client, Header, HttpConfig, Response, Middleware, Next, withMiddleware, requireHeader, logRequests, timing, WebSocket, WsConfig, SseWriter, BodyWriter, chunks }

fn body(req: Request) -> str {
  match req.text() {
    str t => t
    DecodeError _ => ""
  }
}

fn run() -> () | NetError | DecodeError | Panicked  net, io, time {
  let srv = Server.bind(ServerConfig{ port: 0, followNode: false })?
  defer srv.close()
  let stop = srv.handle()
  let base = "http://127.0.0.1:{srv.port()}"
  let router = Router.new().get("/events", (req: Request) => Reply.sse((w: SseWriter) => {
    w.send("hello")?
    w.event("bye", name: "last", id: "2")?
  }))
  scope {
    spawn stop.serve(router)
    let r = Client.get("{base}/events")?
    print(r.header("content-type") ?? "-")
    print((r.text()?).replace("\n", "|"))
    stop.shutdown()
    ()
  }?
}

fn main() io, net, time {
  match run() {
    NetError _ => print("net error")
    DecodeError _ => print("decode error")
    Panicked _ => print("panicked")
    _ => {}
  }
}
Output
text/event-stream
data: hello||event: last|id: 2|data: bye||
pub(api) static fn sse(producer: fn(SseWriter) -> () | NetError net, io, time escaping) -> Reply

Since. 1.0.0-beta

Parameters

NameType
producerfn(SseWriter) -> () | NetError net, io, time escaping

Returns

Reply

Effects

none declared (pure unless the body says otherwise)

Defined in: std/http/http.oxl:2854

See also