Index

Modules: ws.

API symbols

Binary:

• ws: Opcode.Binary

Close:

• ws: Opcode.Close

close:

• ws: proc close(ws: WebSocket)

Closed:

• ws: ReadyState.Closed

Closing:

• ws: ReadyState.Closing

Connecting:

• ws: ReadyState.Connecting

Cont:

• ws: Opcode.Cont

decodeBase16:

• ws: proc decodeBase16(str: string): string

encodeBase16:

• ws: proc encodeBase16(str: string): string

handshake:

• ws: proc handshake(ws: WebSocket; headers: HttpHeaders): owned(Future[void])

hangup:

• ws: proc hangup(ws: WebSocket)

newWebSocket:

• ws: proc newWebSocket(req: Request; protocol: string = ""): Future[WebSocket]
• ws: proc newWebSocket(url: string; protocols: seq[string] = @[]): Future[WebSocket]
• ws: proc newWebSocket(url: string; protocol: string): Future[WebSocket]

Opcode:

• ws: enum Opcode

Open:

• ws: ReadyState.Open

Ping:

• ws: Opcode.Ping

ping:

• ws: proc ping(ws: WebSocket; data = ""): owned(Future[void])

Pong:

• ws: Opcode.Pong

ReadyState:

• ws: enum ReadyState

receiveBinaryPacket:

• ws: proc receiveBinaryPacket(ws: WebSocket): Future[seq[byte]]

receivePacket:

• ws: proc receivePacket(ws: WebSocket): Future[(Opcode, string)]

receiveStrPacket:

• ws: proc receiveStrPacket(ws: WebSocket): Future[string]

send:

• ws: proc send(ws: WebSocket; text: string; opcode = Opcode.Text): Future[void]

setupPings:

• ws: proc setupPings(ws: WebSocket; seconds: float)

Text:

• ws: Opcode.Text

toSeq:

• ws: proc toSeq(hv: HttpHeaderValues): seq[string]

WebSocket:

• ws: type WebSocket

WebSocketClosedError:

• ws: object WebSocketClosedError

WebSocketCreationError:

• ws: object WebSocketCreationError

WebSocketError:

• ws: object WebSocketError

WebSocketFailedUpgradeError:

• ws: object WebSocketFailedUpgradeError

WebSocketHandshakeError:

• ws: object WebSocketHandshakeError

WebSocketPacketTypeError:

• ws: object WebSocketPacketTypeError

WebSocketProtocolMismatchError:

• ws: object WebSocketProtocolMismatchError