OxL Reference

method SseWriter.comment

A comment line (keep-alive for proxies); ignored by clients.

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("/e", (req: Request) => Reply.sse((w: SseWriter) => {
    w.comment("keep-alive")?
    w.send("real")?
  }))
  scope {
    spawn stop.serve(router)
    let s = SseStream.open("{base}/e")?
    defer s.close()
    match s.next(5s)? {
      ev? => print(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
real
pub(api) fn comment(text: str) -> () | NetError  net

Since. 1.0.0-beta

Parameters

NameType
textstr

Returns

()

Errors

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

Effects

net

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

See also