OxL Reference

method WebSocket.close

Sends a close frame, waits (at most timeout) for the peer's, and releases the connection.

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("/ws", (req: Request) => Reply.websocket((ws: WebSocket) => {
    var open = true
    while open {
      let m = ws.recv()?
      if m.kind == WsKind.Text {
        ws.sendText("echo:{m.text}")?
      } else if m.kind == WsKind.Binary {
        ws.sendBinary(m.payload)?
      } else if m.kind == WsKind.Close {
        open = false
      }
    }
  }))
  scope {
    spawn stop.serve(router)
    let ws = WebSocket.connect("ws://127.0.0.1:{srv.port()}/ws")?
    ws.close(1000, "bye")?
    print("closed")
    stop.shutdown()
    ()
  }?
}

fn main() io, net, time {
  match run() {
    NetError _ => print("net error")
    DecodeError _ => print("decode error")
    Panicked _ => print("panicked")
    _ => {}
  }
}
Output
closed
pub(api) move fn close(code: i64 = 1000, reason: str = "", timeout: Duration = 2s) -> () | NetError  net

Since. 1.0.0-beta

Parameters

NameType
codei64 = 1000
reasonstr = ""
timeoutDuration = 2s

Returns

()

Errors

  • NetError
  • `NetError` when the connection broke before the closing handshake finished.

Effects

net

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

See also