Module vibe.http.websockets
Implements WebSocket support and fallbacks for older browsers.
Example
void handleConn(scope WebSocket sock)
{
// simple echo server
while (sock.connected) {
auto msg = sock.receiveText();
sock.send(msg);
}
}
void startServer()
{
import vibe.http.router;
auto router = new URLRouter;
router.get("/ws", handleWebSockets(&handleConn));
// Start HTTP server using listenHTTP()...
}
Functions
| Name | Description |
closeReasonString(reason)
|
|
connectWebSocket(url, settings)
|
Establishes a WebSocket connection at the specified endpoint.
|
connectWebSocket(url, del, settings)
|
Scheduled for deprecation - use a @safe callback instead.
|
connectWebSocket(url, del, settings)
|
Scheduled for deprecation - use a nothrow callback instead.
|
connectWebSocketEx(url, request_modifier, settings)
|
Establishes a WebSocket connection at the specified endpoint.
|
handleWebSocket(on_handshake, req, res)
|
Establishes a web socket conection and passes it to the on_handshake delegate.
|
handleWebSocket(on_handshake, req, res)
|
Scheduled for deprecation - use a @safe callback instead.
|
handleWebSocket(on_handshake, req, res)
|
Scheduled for deprecation - use a nothrow callback instead.
|
handleWebSockets(on_handshake)
|
Returns a HTTP request handler that establishes web socket conections.
|
handleWebSockets(on_handshake)
|
Scheduled for deprecation - use a @safe callback instead.
|
handleWebSockets(on_handshake)
|
Scheduled for deprecation - use a nothrow callback instead.
|
Enums
| Name | Description |
FrameOpcode
|
The Opcode is 4 bits, as defined in Section 5.2
|
WebSocketCloseReason
|
Provides the reason that a websocket connection has closed.
|
