type
WebSocket
WebSocket is used for both client and server web socket messaging. Current implementation only supports basic non-fragmented text or binary messages.
methods
close |
Close the web socket |
---|---|
isClosed |
Return true if this socket has been closed |
openClient |
Open a client connection. |
openServer |
Upgrade a server request to a WebSocket. |
receive |
Receive a message which is returned as either a Str or Buf. |
send |
Send a message which must be either a Str of Buf. |
socketOptions |
Access to socket options for this request. |
Slot Details
close
isClosed
openClient
openServer
src
static WebSocket openServer(WebReq req, WebRes res)
Upgrade a server request to a WebSocket. Raise IOErr is there is any problems during the handshake in which case the calling WebMod should return a 400 response.
Callers should set the Sec-WebSocket-Protocol response header before calling this method. However, if not set then this call will set it to the request header value for Sec-WebSocket-Protocol (if available).
Note: once this method completes, the socket is now owned by the WebSocket instance and not the web server (wisp); it must be explicitly closed to prevent a file handle leak.
receive
send
socketOptions
src
@Deprecated { msg=... }
SocketOptions socketOptions()
Access to socket options for this request.