OxL Reference

method SseWriter.event

Sends one event: text (a multi-line text becomes several data: lines), an optional event name, id and reconnection delay retry (milliseconds).

Example:

oxl✓ checked in CI
use std.http { Server, ServerConfig, ServerHandle, Router, Request, Reply, Client, Header, HttpConfig, Response, WebSocket, WsConfig, WsKind, WsMessage, SseWriter, SseStream, SseConfig, SseEvent, BodyWriter, Http2, Http2Handle, ResponseStream, chunks }

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.event("first", id: "1")?
    w.event("second", name: "update", id: "2", retry: 1500)?
  }))
  scope {
    spawn stop.serve(router)
    let s = SseStream.open("{base}/events")?
    defer s.close()
    let a = s.next(5s)?
    let b = s.next(5s)?
    match b {
      ev? => print("{ev.name} id={ev.id} retry={ev.retry} {ev.text}")
      none => print("end")
    }
    stop.shutdown()
    ()
  }?
}

fn main() io, net, time {
  match run() {
    NetError _ => print("net error")
    DecodeError _ => print("decode error")
    Panicked _ => print("panicked")
    _ => {}
  }
}
Output
update id=2 retry=1500 second
pub(api) fn event(text: str, name: str? = none, id: str? = none, retry: i64? = none) -> () | NetError  net

Since. 1.0.0-beta

Parameters

NameType
textstr
namestr? = none
idstr? = none
retryi64? = none

Returns

()

Errors

  • NetError
  • `NetError` when the client has gone away.

Effects

net

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

See also