website/docs/ddoc/websockets/handy_http_websockets.frame...

36 lines
4.8 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>WebSocketFrame (handy_http_websockets.frame.WebSocketFrame)</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>WebSocketFrame</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_websockets.html">handy_http_websockets</a> <a class="breadcrumb" href="handy_http_websockets.frame.html">frame</a> </div><div><div class="documentation-comment synopsis"><div><p>Internal intermediary structure used to hold the results of parsing a
websocket frame.</p></div></div></div><div class="annotated-prototype"><div class="aggregate-prototype"><div class="attributes"></div><span class="builtin-type">struct</span> WebSocketFrame {<div class="aggregate-member"><a href="handy_http_websockets.frame.WebSocketFrame.finalFragment.html"><div class="attributes"></div><tt class="highlighted"><span class="type">bool</span></tt> <span class="name">finalFragment</span>;</a></div><div class="aggregate-member"><a href="handy_http_websockets.frame.WebSocketFrame.opcode.html"><div class="attributes"></div><tt class="highlighted"><span class="hid">WebSocketFrameOpcode</span></tt> <span class="name">opcode</span>;</a></div><div class="aggregate-member"><a href="handy_http_websockets.frame.WebSocketFrame.payload.html"><div class="attributes"></div><tt class="highlighted"><span class="type">ubyte</span>[]</tt> <span class="name">payload</span>;</a></div>}</div></div><h2 id="members"><a class="header-anchor" href="#members">Members</a></h2><h3 class="member-list-header hide-from-toc" id="variable"><a class="header-anchor" href="#variable">Variables</a></h3><dl class="member-list native"><dt><a href="handy_http_websockets.frame.WebSocketFrame.finalFragment.html">finalFragment</a><div class="simplified-prototype" style="max-width: 20ch;"><tt class="highlighted"><span class="type">bool</span></tt> <span class="name">finalFragment</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_websockets.frame.WebSocketFrame.opcode.html">opcode</a><div class="simplified-prototype" style="max-width: 30ch;"><tt class="highlighted"><span class="hid">WebSocketFrameOpcode</span></tt> <span class="name">opcode</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_websockets.frame.WebSocketFrame.payload.html">payload</a><div class="simplified-prototype" style="max-width: 17ch;"><tt class="highlighted"><span class="type">ubyte</span>[]</tt> <span class="name">payload</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd></dl><div></div></div>
<div id="page-nav"><a class="parent" href="handy_http_websockets.html">handy_http_websockets</a> <a class="parent" href="handy_http_websockets.frame.html">frame</a>
<span class="type-separator">enums</span><ul><li><a class="enum" href="handy_http_websockets.frame.WebSocketCloseStatusCode.html">WebSocketCloseStatusCode</a></li><li><a class="enum" href="handy_http_websockets.frame.WebSocketFrameOpcode.html">WebSocketFrameOpcode</a></li></ul><span class="type-separator">functions</span><ul><li><a class="function" href="handy_http_websockets.frame.receiveWebSocketFrame.html">receiveWebSocketFrame</a></li><li><a class="function" href="handy_http_websockets.frame.sendWebSocketBinaryFrame.html">sendWebSocketBinaryFrame</a></li><li><a class="function" href="handy_http_websockets.frame.sendWebSocketCloseFrame.html">sendWebSocketCloseFrame</a></li><li><a class="function" href="handy_http_websockets.frame.sendWebSocketFrame.html">sendWebSocketFrame</a></li><li><a class="function" href="handy_http_websockets.frame.sendWebSocketPingFrame.html">sendWebSocketPingFrame</a></li><li><a class="function" href="handy_http_websockets.frame.sendWebSocketPongFrame.html">sendWebSocketPongFrame</a></li><li><a class="function" href="handy_http_websockets.frame.sendWebSocketTextFrame.html">sendWebSocketTextFrame</a></li></ul><span class="type-separator">structs</span><ul><li><a class="struct current" href="handy_http_websockets.frame.WebSocketFrame.html">WebSocketFrame</a></li></ul></div>
</div>
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
</body>
</html>