41 lines
6.6 KiB
HTML
41 lines
6.6 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>handy_http_websockets.frame (handy_http_websockets.frame)</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">
|
|
<h1>handy_http_websockets.frame</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_websockets.html">handy_http_websockets</a> </div><div><div class="documentation-comment synopsis"><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></div></div><div class="annotated-prototype"></div><h2 id="members"><a class="header-anchor" href="#members">Members</a></h2><h3 class="member-list-header hide-from-toc" id="enum"><a class="header-anchor" href="#enum">Enums</a></h3><dl class="member-list native"><dt><a href="handy_http_websockets.frame.WebSocketCloseStatusCode.html">WebSocketCloseStatusCode</a><div class="simplified-prototype" style="max-width: 31ch;"><span class="builtin-type">enum</span> <span class="name">WebSocketCloseStatusCode</span></div></dt><dd><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></dd><dt><a href="handy_http_websockets.frame.WebSocketFrameOpcode.html">WebSocketFrameOpcode</a><div class="simplified-prototype" style="max-width: 27ch;"><span class="builtin-type">enum</span> <span class="name">WebSocketFrameOpcode</span></div></dt><dd><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></dd></dl><h3 class="member-list-header hide-from-toc" id="function"><a class="header-anchor" href="#function">Functions</a></h3><dl class="member-list native"><dt><a href="handy_http_websockets.frame.receiveWebSocketFrame.html">receiveWebSocketFrame</a><div class="simplified-prototype" style="max-width: 50ch;"><tt class="highlighted"><span class="hid">WebSocketFrame</span></tt> <span class="name">receiveWebSocketFrame</span>(S stream)</div></dt><dd><div><p>Receives a websocket frame from a byte input stream.</p></div></dd><dt><a href="handy_http_websockets.frame.sendWebSocketBinaryFrame.html">sendWebSocketBinaryFrame</a><div class="simplified-prototype" style="max-width: 59ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">sendWebSocketBinaryFrame</span>(S stream, ubyte[] bytes)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_websockets.frame.sendWebSocketCloseFrame.html">sendWebSocketCloseFrame</a><div class="simplified-prototype" style="max-width: 93ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">sendWebSocketCloseFrame</span>(S stream, WebSocketCloseStatusCode code, string message)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_websockets.frame.sendWebSocketFrame.html">sendWebSocketFrame</a><div class="simplified-prototype" style="max-width: 60ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">sendWebSocketFrame</span>(S stream, WebSocketFrame frame)</div></dt><dd><div><p>Sends a websocket frame to a byte output stream.</p></div></dd><dt><a href="handy_http_websockets.frame.sendWebSocketPingFrame.html">sendWebSocketPingFrame</a><div class="simplified-prototype" style="max-width: 59ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">sendWebSocketPingFrame</span>(S stream, ubyte[] payload)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_websockets.frame.sendWebSocketPongFrame.html">sendWebSocketPongFrame</a><div class="simplified-prototype" style="max-width: 63ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">sendWebSocketPongFrame</span>(S stream, ubyte[] pingPayload)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_websockets.frame.sendWebSocketTextFrame.html">sendWebSocketTextFrame</a><div class="simplified-prototype" style="max-width: 55ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">sendWebSocketTextFrame</span>(S stream, string text)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd></dl><h3 class="member-list-header hide-from-toc" id="struct"><a class="header-anchor" href="#struct">Structs</a></h3><dl class="member-list native"><dt><a href="handy_http_websockets.frame.WebSocketFrame.html">WebSocketFrame</a><div class="simplified-prototype" style="max-width: 23ch;"><span class="builtin-type">struct</span> <span class="name">WebSocketFrame</span></div></dt><dd><div><p>Internal intermediary structure used to hold the results of parsing a
|
|
websocket frame.</p></div></dd></dl><div></div></div>
|
|
<div id="page-nav"><a class="parent" href="handy_http_websockets.html">handy_http_websockets</a>
|
|
<span class="type-separator">modules</span><ul><li><a class="module" href="handy_http_websockets.components.html">components</a></li><li><a class="module" href="handy_http_websockets.connection.html">connection</a></li><li><a class="module current" href="handy_http_websockets.frame.html">frame</a></li><li><a class="module" href="handy_http_websockets.handler.html">handler</a></li></ul></div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
</body>
|
|
</html> |