35 lines
4.9 KiB
HTML
35 lines
4.9 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>receiveWebSocketFrame (handy_http_websockets.frame.receiveWebSocketFrame)</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>receiveWebSocketFrame</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>Receives a websocket frame from a byte input stream.</p></div></div></div><div class="annotated-prototype"><div class="function-prototype"><div class="attributes"></div><div class="return-type"><a class="name" data-ident="WebSocketFrame" href="handy_http_websockets.frame.WebSocketFrame.html" title="handy_http_websockets.frame.WebSocketFrame">WebSocketFrame</a></div><div class="function-name">receiveWebSocketFrame</div><div class="template-parameters" data-count="1">(<div class="parameters-list toplevel"><div class="template-parameter-item parameter-item"> <span><span class="name" data-ident="S">S</span></span></div></div>)</div><div class="runtime-parameters" data-count="1"><div class="parameters-list toplevel"><span class="paren">(</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="name" data-ident="S">S</span></span></span> <span class="parameter-name name" data-ident="stream"><a href="#param-stream">stream</a></span></div><span class="paren">)</span></div></div><div class="template-constraint"> <a class="lang-feature" href="http://dpldocs.info/template-constraints">if</a> (<div class="template-constraint-expression"><span class="name" data-ident="isByteInputStream">isByteInputStream</span>!<span class="name" data-ident="S">S</span></div>)</div><div class="function-contracts"></div></div></div><div><h2 id="parameters"><a class="header-anchor" href="#parameters">Parameters</a></h2><dl class="parameter-descriptions"><dt id="param-stream"><a class="parameter-name" data-ident="stream" href="#param-stream">stream</a> <span class="parameter-type"><span class="name" data-ident="S">S</span></span></dt><dd><div class="documentation-comment"><div><p>The stream to receive from.</p></div></div></dd></dl><h2 id="returns"><a class="header-anchor" href="#returns">Return Value</a></h2><div><div class="return-type-holder">Type: <span class="return-type"><a class="xref" href="handy_http_websockets.frame.WebSocketFrame.html" title="handy_http_websockets.frame.WebSocketFrame"><span class="name" data-ident="WebSocketFrame">WebSocketFrame</span></a></span></div><div class="documentation-comment returns-description"><div><p>The frame that was received.</p></div></div></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 current" 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" 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> |