91 lines
32 KiB
HTML
91 lines
32 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Documentation</title>
|
|
<meta charset="utf-8" />
|
|
<meta content="width=device-width, initial-scale=1" name="viewport" />
|
|
<link href="style.css" rel="stylesheet" />
|
|
<script src="script.js" type="text/javascript"></script>
|
|
|
|
|
|
<link href="search-results.html" rel="prefetch" />
|
|
</head>
|
|
<body>
|
|
<div id="page-header">
|
|
<div id="logotype">
|
|
<span>Documentation</span>
|
|
<nav>
|
|
<a href="http://dlang.org/">Dlang.org</a>
|
|
</nav>
|
|
</div>
|
|
|
|
<form action="search-docs.html" id="search">
|
|
<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
<div id="page-body">
|
|
<div id="page-content">
|
|
</div>
|
|
<div id="page-nav">
|
|
</div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
|
|
<script type="text/xml" id="search-index-container">
|
|
<adrdox>
|
|
<listing>
|
|
<decl id="1" type="module"><name>handy_http_websockets.connection</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.connection.html</link><decl id="2" type="class"><name>WebSocketConnection</name><desc><div><p>All the data that represents a WebSocket connection tracked by the
|
|
<tt class="inline-code">WebSocketHandler</tt>.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.html</link><decl id="3" type="variable"><name>id</name><desc><div><p>The internal id assigned to this connection.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.id.html</link></decl><decl id="4" type="variable"><name>inputStream</name><desc><div><p>Stream for reading from the client.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.inputStream.html</link></decl><decl id="5" type="variable"><name>outputStream</name><desc><div><p>Stream for writing to the client.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.outputStream.html</link></decl><decl id="6" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.connection.WebSocketConnection.this.html</link></decl><decl id="7" type="function"><name>getMessageHandler</name><desc><div><p>Gets the message handler that handles events for this connection.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.getMessageHandler.html</link></decl><decl id="8" type="function"><name>getRequestHandler</name><desc><div><p>Gets the <tt class="inline-code">WebSocketRequestHandler</tt> that owns this connection. Use this
|
|
to interact with the set of connections managed by that handler.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.getRequestHandler.html</link></decl><decl id="9" type="function"><name>sendTextMessage</name><desc><div><p>Sends a text message to the connected client.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.sendTextMessage.html</link></decl><decl id="10" type="function"><name>sendBinaryMessage</name><desc><div><p>Sends a binary message to the connected client.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.sendBinaryMessage.html</link></decl><decl id="11" type="function"><name>sendCloseMessage</name><desc><div><p>Sends a close message to the client, indicating that we'll be closing
|
|
the connection.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.sendCloseMessage.html</link></decl><decl id="12" type="function"><name>close</name><desc><div><p>Closes this connection, if it's alive, sending a websocket close message.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.close.html</link></decl></decl></decl><decl id="13" type="module"><name>handy_http_websockets.handler</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.handler.html</link><decl id="14" type="class"><name>WebSocketRequestHandler</name><desc><div><p>An HTTP request handler implementation that's used as the entrypoint for
|
|
clients that want to establish a websocket connection. It will verify the
|
|
websocket request, and if successful, send back a SWITCHING_PROTOCOLS
|
|
response, and register a new websocket connection.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.html</link><decl id="15" type="constructor"><name>this</name><desc><div><p>Constructs a request handler that will use the given message handler to
|
|
deal with events from any websocket connections that are established.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.this.html</link></decl><decl id="16" type="function"><name>handle</name><desc><div><p>Handles an incoming HTTP request and tries to establish a websocket
|
|
connection by first verifying the request, then sending a switching-
|
|
protocols response, and finally registering the new connection with the
|
|
websocket manager.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.handle.html</link></decl><decl id="17" type="function"><name>connectionCount</name><desc><div><p>Gets the number of active connections.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.connectionCount.html</link></decl><decl id="18" type="function"><name>addConnection</name><desc><div><p>Adds a connection to the manager and starts listening for messages.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.addConnection.html</link></decl><decl id="19" type="function"><name>removeConnection</name><desc><div><p>Removes a websocket connection from the manager and closes it. This is
|
|
called automatically if the client sends a CLOSE frame, but you can also
|
|
call it yourself.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.removeConnection.html</link></decl><decl id="20" type="function"><name>broadcast</name><desc><div><p>Broadcasts a message to all connected clients.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.broadcast.1.html</link></decl><decl id="21" type="function"><name>broadcast</name><desc><div><p>Broadcasts a binary message to all connected clients.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.broadcast.2.html</link></decl></decl></decl><decl id="22" type="module"><name>handy_http_websockets</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.html</link><decl id="23" type="module"><name>handy_http_websockets.connection</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.connection.html</link><decl id="24" type="class"><name>WebSocketConnection</name><desc><div><p>All the data that represents a WebSocket connection tracked by the
|
|
<tt class="inline-code">WebSocketHandler</tt>.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.html</link><decl id="25" type="variable"><name>id</name><desc><div><p>The internal id assigned to this connection.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.id.html</link></decl><decl id="26" type="variable"><name>inputStream</name><desc><div><p>Stream for reading from the client.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.inputStream.html</link></decl><decl id="27" type="variable"><name>outputStream</name><desc><div><p>Stream for writing to the client.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.outputStream.html</link></decl><decl id="28" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.connection.WebSocketConnection.this.html</link></decl><decl id="29" type="function"><name>getMessageHandler</name><desc><div><p>Gets the message handler that handles events for this connection.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.getMessageHandler.html</link></decl><decl id="30" type="function"><name>getRequestHandler</name><desc><div><p>Gets the <tt class="inline-code">WebSocketRequestHandler</tt> that owns this connection. Use this
|
|
to interact with the set of connections managed by that handler.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.getRequestHandler.html</link></decl><decl id="31" type="function"><name>sendTextMessage</name><desc><div><p>Sends a text message to the connected client.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.sendTextMessage.html</link></decl><decl id="32" type="function"><name>sendBinaryMessage</name><desc><div><p>Sends a binary message to the connected client.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.sendBinaryMessage.html</link></decl><decl id="33" type="function"><name>sendCloseMessage</name><desc><div><p>Sends a close message to the client, indicating that we'll be closing
|
|
the connection.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.sendCloseMessage.html</link></decl><decl id="34" type="function"><name>close</name><desc><div><p>Closes this connection, if it's alive, sending a websocket close message.</p></div></desc><link>handy_http_websockets.connection.WebSocketConnection.close.html</link></decl></decl></decl><decl id="35" type="module"><name>handy_http_websockets.handler</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.handler.html</link><decl id="36" type="class"><name>WebSocketRequestHandler</name><desc><div><p>An HTTP request handler implementation that's used as the entrypoint for
|
|
clients that want to establish a websocket connection. It will verify the
|
|
websocket request, and if successful, send back a SWITCHING_PROTOCOLS
|
|
response, and register a new websocket connection.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.html</link><decl id="37" type="constructor"><name>this</name><desc><div><p>Constructs a request handler that will use the given message handler to
|
|
deal with events from any websocket connections that are established.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.this.html</link></decl><decl id="38" type="function"><name>handle</name><desc><div><p>Handles an incoming HTTP request and tries to establish a websocket
|
|
connection by first verifying the request, then sending a switching-
|
|
protocols response, and finally registering the new connection with the
|
|
websocket manager.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.handle.html</link></decl><decl id="39" type="function"><name>connectionCount</name><desc><div><p>Gets the number of active connections.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.connectionCount.html</link></decl><decl id="40" type="function"><name>addConnection</name><desc><div><p>Adds a connection to the manager and starts listening for messages.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.addConnection.html</link></decl><decl id="41" type="function"><name>removeConnection</name><desc><div><p>Removes a websocket connection from the manager and closes it. This is
|
|
called automatically if the client sends a CLOSE frame, but you can also
|
|
call it yourself.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.removeConnection.html</link></decl><decl id="42" type="function"><name>broadcast</name><desc><div><p>Broadcasts a message to all connected clients.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.broadcast.1.html</link></decl><decl id="43" type="function"><name>broadcast</name><desc><div><p>Broadcasts a binary message to all connected clients.</p></div></desc><link>handy_http_websockets.handler.WebSocketRequestHandler.broadcast.2.html</link></decl></decl></decl><decl id="44" type="module"><name>handy_http_websockets.components</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.html</link><decl id="45" type="class"><name>WebSocketException</name><desc><div><p>An exception that's thrown if an unexpected situation arises while dealing
|
|
with a websocket connection.</p></div></desc><link>handy_http_websockets.components.WebSocketException.html</link><decl id="46" type="mixin"><name>__anonymous</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketException.__anonymous.html</link></decl></decl><decl id="47" type="struct"><name>WebSocketTextMessage</name><desc><div><p>A text-based websocket message.</p></div></desc><link>handy_http_websockets.components.WebSocketTextMessage.html</link><decl id="48" type="variable"><name>conn</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketTextMessage.conn.html</link></decl><decl id="49" type="variable"><name>payload</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketTextMessage.payload.html</link></decl></decl><decl id="50" type="struct"><name>WebSocketBinaryMessage</name><desc><div><p>A binary websocket message.</p></div></desc><link>handy_http_websockets.components.WebSocketBinaryMessage.html</link><decl id="51" type="variable"><name>conn</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketBinaryMessage.conn.html</link></decl><decl id="52" type="variable"><name>payload</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketBinaryMessage.payload.html</link></decl></decl><decl id="53" type="struct"><name>WebSocketCloseMessage</name><desc><div><p>A &quot;close&quot; control websocket message indicating the client is closing the
|
|
connection.</p></div></desc><link>handy_http_websockets.components.WebSocketCloseMessage.html</link><decl id="54" type="variable"><name>conn</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketCloseMessage.conn.html</link></decl><decl id="55" type="variable"><name>statusCode</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketCloseMessage.statusCode.html</link></decl><decl id="56" type="variable"><name>message</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketCloseMessage.message.html</link></decl></decl><decl id="57" type="class"><name>WebSocketMessageHandler</name><desc><div><p>An abstract class that you should extend to define logic for handling
|
|
websocket messages and events. Create a new class that inherits from this
|
|
one, and overrides any &quot;on...&quot; methods that you'd like.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.html</link><decl id="58" type="function"><name>onConnectionEstablished</name><desc><div><p>Called when a new websocket connection is established.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onConnectionEstablished.html</link></decl><decl id="59" type="function"><name>onTextMessage</name><desc><div><p>Called when a text message is received.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onTextMessage.html</link></decl><decl id="60" type="function"><name>onBinaryMessage</name><desc><div><p>Called when a binary message is received.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onBinaryMessage.html</link></decl><decl id="61" type="function"><name>onCloseMessage</name><desc><div><p>Called when a CLOSE message is received. Note that this is called before
|
|
the socket is necessarily guaranteed to be closed.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onCloseMessage.html</link></decl><decl id="62" type="function"><name>onConnectionClosed</name><desc><div><p>Called when a websocket connection is closed.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onConnectionClosed.html</link></decl></decl></decl><decl id="63" type="module"><name>handy_http_websockets.frame</name><desc><div><p>Defines low-level structs and functions for dealing with WebSocket data
|
|
frame protocol. Usually, you won't need to use these functions and structs
|
|
directly, since abstractions are provided by the websocket connection and
|
|
message structs.</p></div></desc><link>handy_http_websockets.frame.html</link><decl id="64" type="enum"><name>WebSocketFrameOpcode</name><desc><div><p>An enumeration of valid opcodes for websocket data frames.
|
|
<a href="https://datatracker.ietf.org/doc/html/rfc6455#section-5.2">https://datatracker.ietf.org/doc/html/rfc6455#section-5.2</a></p></div></desc><link>handy_http_websockets.frame.WebSocketFrameOpcode.html</link></decl><decl id="65" type="enum"><name>WebSocketCloseStatusCode</name><desc><div><p>An enumeration of possible closing status codes for websocket connections,
|
|
as per <a href="https://datatracker.ietf.org/doc/html/rfc6455#section-7.4">https://datatracker.ietf.org/doc/html/rfc6455#section-7.4</a></p></div></desc><link>handy_http_websockets.frame.WebSocketCloseStatusCode.html</link></decl><decl id="66" type="struct"><name>WebSocketFrame</name><desc><div><p>Internal intermediary structure used to hold the results of parsing a
|
|
websocket frame.</p></div></desc><link>handy_http_websockets.frame.WebSocketFrame.html</link><decl id="67" type="variable"><name>finalFragment</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.frame.WebSocketFrame.finalFragment.html</link></decl><decl id="68" type="variable"><name>opcode</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.frame.WebSocketFrame.opcode.html</link></decl><decl id="69" type="variable"><name>payload</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.frame.WebSocketFrame.payload.html</link></decl></decl><decl id="70" type="function"><name>sendWebSocketTextFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketTextFrame.html</link></decl><decl id="71" type="function"><name>sendWebSocketBinaryFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketBinaryFrame.html</link></decl><decl id="72" type="function"><name>sendWebSocketCloseFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketCloseFrame.html</link></decl><decl id="73" type="function"><name>sendWebSocketPingFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketPingFrame.html</link></decl><decl id="74" type="function"><name>sendWebSocketPongFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketPongFrame.html</link></decl><decl id="75" type="function"><name>sendWebSocketFrame</name><desc><div><p>Sends a websocket frame to a byte output stream.</p></div></desc><link>handy_http_websockets.frame.sendWebSocketFrame.html</link></decl><decl id="76" type="function"><name>receiveWebSocketFrame</name><desc><div><p>Receives a websocket frame from a byte input stream.</p></div></desc><link>handy_http_websockets.frame.receiveWebSocketFrame.html</link></decl></decl></decl><decl id="77" type="module"><name>handy_http_websockets.components</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.html</link><decl id="78" type="class"><name>WebSocketException</name><desc><div><p>An exception that's thrown if an unexpected situation arises while dealing
|
|
with a websocket connection.</p></div></desc><link>handy_http_websockets.components.WebSocketException.html</link><decl id="79" type="mixin"><name>__anonymous</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketException.__anonymous.html</link></decl></decl><decl id="80" type="struct"><name>WebSocketTextMessage</name><desc><div><p>A text-based websocket message.</p></div></desc><link>handy_http_websockets.components.WebSocketTextMessage.html</link><decl id="81" type="variable"><name>conn</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketTextMessage.conn.html</link></decl><decl id="82" type="variable"><name>payload</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketTextMessage.payload.html</link></decl></decl><decl id="83" type="struct"><name>WebSocketBinaryMessage</name><desc><div><p>A binary websocket message.</p></div></desc><link>handy_http_websockets.components.WebSocketBinaryMessage.html</link><decl id="84" type="variable"><name>conn</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketBinaryMessage.conn.html</link></decl><decl id="85" type="variable"><name>payload</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketBinaryMessage.payload.html</link></decl></decl><decl id="86" type="struct"><name>WebSocketCloseMessage</name><desc><div><p>A &quot;close&quot; control websocket message indicating the client is closing the
|
|
connection.</p></div></desc><link>handy_http_websockets.components.WebSocketCloseMessage.html</link><decl id="87" type="variable"><name>conn</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketCloseMessage.conn.html</link></decl><decl id="88" type="variable"><name>statusCode</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketCloseMessage.statusCode.html</link></decl><decl id="89" type="variable"><name>message</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.components.WebSocketCloseMessage.message.html</link></decl></decl><decl id="90" type="class"><name>WebSocketMessageHandler</name><desc><div><p>An abstract class that you should extend to define logic for handling
|
|
websocket messages and events. Create a new class that inherits from this
|
|
one, and overrides any &quot;on...&quot; methods that you'd like.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.html</link><decl id="91" type="function"><name>onConnectionEstablished</name><desc><div><p>Called when a new websocket connection is established.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onConnectionEstablished.html</link></decl><decl id="92" type="function"><name>onTextMessage</name><desc><div><p>Called when a text message is received.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onTextMessage.html</link></decl><decl id="93" type="function"><name>onBinaryMessage</name><desc><div><p>Called when a binary message is received.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onBinaryMessage.html</link></decl><decl id="94" type="function"><name>onCloseMessage</name><desc><div><p>Called when a CLOSE message is received. Note that this is called before
|
|
the socket is necessarily guaranteed to be closed.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onCloseMessage.html</link></decl><decl id="95" type="function"><name>onConnectionClosed</name><desc><div><p>Called when a websocket connection is closed.</p></div></desc><link>handy_http_websockets.components.WebSocketMessageHandler.onConnectionClosed.html</link></decl></decl></decl><decl id="96" type="module"><name>handy_http_websockets.frame</name><desc><div><p>Defines low-level structs and functions for dealing with WebSocket data
|
|
frame protocol. Usually, you won't need to use these functions and structs
|
|
directly, since abstractions are provided by the websocket connection and
|
|
message structs.</p></div></desc><link>handy_http_websockets.frame.html</link><decl id="97" type="enum"><name>WebSocketFrameOpcode</name><desc><div><p>An enumeration of valid opcodes for websocket data frames.
|
|
<a href="https://datatracker.ietf.org/doc/html/rfc6455#section-5.2">https://datatracker.ietf.org/doc/html/rfc6455#section-5.2</a></p></div></desc><link>handy_http_websockets.frame.WebSocketFrameOpcode.html</link></decl><decl id="98" type="enum"><name>WebSocketCloseStatusCode</name><desc><div><p>An enumeration of possible closing status codes for websocket connections,
|
|
as per <a href="https://datatracker.ietf.org/doc/html/rfc6455#section-7.4">https://datatracker.ietf.org/doc/html/rfc6455#section-7.4</a></p></div></desc><link>handy_http_websockets.frame.WebSocketCloseStatusCode.html</link></decl><decl id="99" type="struct"><name>WebSocketFrame</name><desc><div><p>Internal intermediary structure used to hold the results of parsing a
|
|
websocket frame.</p></div></desc><link>handy_http_websockets.frame.WebSocketFrame.html</link><decl id="100" type="variable"><name>finalFragment</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.frame.WebSocketFrame.finalFragment.html</link></decl><decl id="101" type="variable"><name>opcode</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.frame.WebSocketFrame.opcode.html</link></decl><decl id="102" type="variable"><name>payload</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_websockets.frame.WebSocketFrame.payload.html</link></decl></decl><decl id="103" type="function"><name>sendWebSocketTextFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketTextFrame.html</link></decl><decl id="104" type="function"><name>sendWebSocketBinaryFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketBinaryFrame.html</link></decl><decl id="105" type="function"><name>sendWebSocketCloseFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketCloseFrame.html</link></decl><decl id="106" type="function"><name>sendWebSocketPingFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketPingFrame.html</link></decl><decl id="107" type="function"><name>sendWebSocketPongFrame</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_websockets.frame.sendWebSocketPongFrame.html</link></decl><decl id="108" type="function"><name>sendWebSocketFrame</name><desc><div><p>Sends a websocket frame to a byte output stream.</p></div></desc><link>handy_http_websockets.frame.sendWebSocketFrame.html</link></decl><decl id="109" type="function"><name>receiveWebSocketFrame</name><desc><div><p>Receives a websocket frame from a byte input stream.</p></div></desc><link>handy_http_websockets.frame.receiveWebSocketFrame.html</link></decl></decl></listing>
|
|
<index>
|
|
</index>
|
|
</adrdox>
|
|
</script>
|
|
<script src="search-docs.js"></script>
|
|
</body></html>
|