OxL Reference

method SseStream.open

Opens url with Accept: text/event-stream. A status other than 200 is not an error: check status.

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", [], SseConfig{ timeout: 5s })?
    defer s.close()
    print("{s.status} {s.headers.len() > 0}")
    stop.shutdown()
    ()
  }?
}

fn main() io, net, time {
  match run() {
    NetError _ => print("net error")
    DecodeError _ => print("decode error")
    Panicked _ => print("panicked")
    _ => {}
  }
}
Output
200 true
pub(api) static fn open(url: str, headers: List<Header> = [], cfg: SseConfig = SseConfig{}) -> SseStream | NetError  net

Since. 1.0.0-beta

Parameters

NameType
urlstr
headersList<Header> = []
cfgSseConfig = SseConfig{}

Returns

SseStream

Errors

  • NetError
  • `NetError` as for `Client.send`; a status other than 200 is not an error: check `status`.

Effects

net

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

See also