website/docs/ddoc/transport/handy_http_transport.http1....

35 lines
5.5 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>readHttpRequest (handy_http_transport.http1.transport.readHttpRequest)</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>readHttpRequest</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_transport.html">handy_http_transport</a> <a class="breadcrumb" href="handy_http_transport.http1.html">http1</a> <a class="breadcrumb" href="handy_http_transport.http1.transport.html">transport</a> </div><div><div class="documentation-comment synopsis"><div><p>Parses an HTTP/1.1 request 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="HttpRequestParseResult" href="handy_http_transport.http1.transport.HttpRequestParseResult.html" title="handy_http_transport.http1.transport.HttpRequestParseResult">HttpRequestParseResult</a></div><div class="function-name">readHttpRequest</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="2"><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="inputStream"><a href="#param-inputStream">inputStream</a></span></div><span class="comma">,</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="storage-class">in</span> <span class="name" data-ident="ClientAddress">ClientAddress</span></span></span> <span class="parameter-name name" data-ident="addr"><a href="#param-addr">addr</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-inputStream"><a class="parameter-name" data-ident="inputStream" href="#param-inputStream">inputStream</a> <span class="parameter-type"><span class="name" data-ident="S">S</span></span></dt><dd><div class="documentation-comment"><div><p>The byte input stream to read from.</p></div></div></dd><dt id="param-addr"><a class="parameter-name" data-ident="addr" href="#param-addr">addr</a> <span class="parameter-type"><span class="name" data-ident="ClientAddress">ClientAddress</span></span></dt><dd><div class="documentation-comment"><div><p>The client address, used in constructed the http request struct.</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_transport.http1.transport.HttpRequestParseResult.html" title="handy_http_transport.http1.transport.HttpRequestParseResult"><span class="name" data-ident="HttpRequestParseResult">HttpRequestParseResult</span></a></span></div><div class="documentation-comment returns-description"><div><p>Either the request which was parsed, or a stream error.</p></div></div></div></div></div>
<div id="page-nav"><a class="parent" href="handy_http_transport.html">handy_http_transport</a> <a class="parent" href="handy_http_transport.http1.html">http1</a> <a class="parent" href="handy_http_transport.http1.transport.html">transport</a>
<span class="type-separator">aliases</span><ul><li><a class="alias" href="handy_http_transport.http1.transport.HttpRequestParseResult.html">HttpRequestParseResult</a></li></ul><span class="type-separator">classes</span><ul><li><a class="class" href="handy_http_transport.http1.transport.Http1Transport.html">Http1Transport</a></li></ul><span class="type-separator">functions</span><ul><li><a class="function" href="handy_http_transport.http1.transport.getAddress.html">getAddress</a></li><li><a class="function" href="handy_http_transport.http1.transport.handleClient.html">handleClient</a></li><li><a class="function" href="handy_http_transport.http1.transport.parseHeaders.html">parseHeaders</a></li><li><a class="function current" href="handy_http_transport.http1.transport.readHttpRequest.html">readHttpRequest</a></li><li><a class="function" href="handy_http_transport.http1.transport.testHttp1Transport.html">testHttp1Transport</a></li></ul></div>
</div>
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
</body>
</html>