diff options
author | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2018-06-13 09:54:12 +0200 |
commit | 92b54aacc0de5446dd5497c39897b0bbff72e626 (patch) | |
tree | c3a98cfec636d1271f5804e5c19b35b208bba00d /docs/en/gun/1.0/manual/gun.head/index.html | |
parent | 8b5c3dc972b99f174750123c9e4abc96259c34a9 (diff) | |
download | ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.gz ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.tar.bz2 ninenines.eu-92b54aacc0de5446dd5497c39897b0bbff72e626.zip |
Rebuild using Asciideck
Diffstat (limited to 'docs/en/gun/1.0/manual/gun.head/index.html')
-rw-r--r-- | docs/en/gun/1.0/manual/gun.head/index.html | 157 |
1 files changed, 46 insertions, 111 deletions
diff --git a/docs/en/gun/1.0/manual/gun.head/index.html b/docs/en/gun/1.0/manual/gun.head/index.html index 8afd0163..1341d833 100644 --- a/docs/en/gun/1.0/manual/gun.head/index.html +++ b/docs/en/gun/1.0/manual/gun.head/index.html @@ -62,138 +62,73 @@ <h1 class="lined-header"><span>gun:head(3)</span></h1> -<div class="sect1"> <h2 id="_name">Name</h2> -<div class="sectionbody"> -<div class="paragraph"><p>gun:head - Get headers of a resource representation</p></div> -</div> -</div> -<div class="sect1"> +<p>gun:head - Get headers of a resource representation</p> <h2 id="_description">Description</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, [], #{})<span style="color: #990000">.</span> - -<span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>) - <span style="color: #990000">-></span> <span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, #{}) - -<span style="font-weight: bold"><span style="color: #000000">head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #009900">Path</span>, <span style="color: #009900">Headers</span>, <span style="color: #009900">ReqOpts</span>) - <span style="color: #990000">-></span> <span style="color: #009900">StreamRef</span> - -<span style="color: #009900">ConnPid</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">pid</span></span>() -<span style="color: #009900">Path</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>() -<span style="color: #009900">Headers</span> <span style="color: #990000">::</span> [{<span style="font-weight: bold"><span style="color: #000080">binary</span></span>(), <span style="font-weight: bold"><span style="color: #000000">iodata</span></span>()}] -<span style="color: #009900">ReqOpts</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000000">gun:req_opts</span></span>() -<span style="color: #009900">StreamRef</span> <span style="color: #990000">::</span> <span style="font-weight: bold"><span style="color: #000080">reference</span></span>()</tt></pre></div></div> -<div class="paragraph"><p>Get headers of a resource representation.</p></div> -<div class="paragraph"><p>This function performs the same operation as -<a href="../gun.get">gun:get(3)</a>, except the server will not -send the resource representation, only the response’s status -code and headers.</p></div> -<div class="paragraph"><p>While servers are supposed to send the same headers as for -a GET request, they sometimes will not. For example the -<code>content-length</code> header may be dropped from the response.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt><b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>) + <font color="#990000">-></font> <b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, [], #{})<font color="#990000">.</font> + +<b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>) + <font color="#990000">-></font> <b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, #{}) + +<b><font color="#000000">head</font></b>(<font color="#009900">ConnPid</font>, <font color="#009900">Path</font>, <font color="#009900">Headers</font>, <font color="#009900">ReqOpts</font>) + <font color="#990000">-></font> <font color="#009900">StreamRef</font> + +<font color="#009900">ConnPid</font> <font color="#990000">::</font> <b><font color="#000080">pid</font></b>() +<font color="#009900">Path</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>() +<font color="#009900">Headers</font> <font color="#990000">::</font> [{<b><font color="#000080">binary</font></b>(), <b><font color="#000000">iodata</font></b>()}] +<font color="#009900">ReqOpts</font> <font color="#990000">::</font> <b><font color="#000000">gun:req_opts</font></b>() +<font color="#009900">StreamRef</font> <font color="#990000">::</font> <b><font color="#000080">reference</font></b>()</tt></pre> +</div></div> +<p>Get headers of a resource representation.</p> +<p>This function performs the same operation as <a href="../gun.get">gun:get(3)</a>, except the server will not send the resource representation, only the response's status code and headers.</p> +<p>While servers are supposed to send the same headers as for a GET request, they sometimes will not. For example the <code>content-length</code> header may be dropped from the response.</p> <h2 id="_arguments">Arguments</h2> -<div class="sectionbody"> -<div class="dlist"><dl> -<dt class="hdlist1"> -ConnPid -</dt> -<dd> -<p> -The pid of the Gun connection process. -</p> +<dl><dt>ConnPid</dt> +<dd><p>The pid of the Gun connection process.</p> </dd> -<dt class="hdlist1"> -Path -</dt> -<dd> -<p> -Path to the resource. -</p> +<dt>Path</dt> +<dd><p>Path to the resource.</p> </dd> -<dt class="hdlist1"> -Headers -</dt> -<dd> -<p> -Additional request headers. -</p> +<dt>Headers</dt> +<dd><p>Additional request headers.</p> </dd> -<dt class="hdlist1"> -ReqOpts -</dt> -<dd> -<p> -Request options. -</p> +<dt>ReqOpts</dt> +<dd><p>Request options.</p> </dd> -</dl></div> -</div> -</div> -<div class="sect1"> +</dl> <h2 id="_return_value">Return value</h2> -<div class="sectionbody"> -<div class="paragraph"><p>A reference that identifies the newly created stream is -returned. It is this reference that must be passed in -subsequent calls and will be received in messages related -to this new stream.</p></div> -</div> -</div> -<div class="sect1"> +<p>A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.</p> <h2 id="_changelog">Changelog</h2> -<div class="sectionbody"> -<div class="ulist"><ul> -<li> -<p> -<strong>1.0</strong>: Function introduced. -</p> +<ul><li><strong>1.0</strong>: Function introduced. </li> -</ul></div> -</div> -</div> -<div class="sect1"> +</ul> <h2 id="_examples">Examples</h2> -<div class="sectionbody"> -<div class="listingblock"> -<div class="title">Get headers of a resource representation</div> -<div class="content"><!-- Generator: GNU source-highlight +<div class="listingblock"><div class="title">Get headers of a resource representation</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>, [ - {<span style="color: #990000"><<</span><span style="color: #FF0000">"accept"</span><span style="color: #990000">>></span>, <span style="color: #990000"><<</span><span style="color: #FF0000">"text/html;q=1.0, application/xml;q=0.1"</span><span style="color: #990000">>></span>} -])<span style="color: #990000">.</span></tt></pre></div></div> -<div class="listingblock"> -<div class="title">Get headers of a resource representation with request options</div> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [ + {<font color="#990000"><<</font><font color="#FF0000">"accept"</font><font color="#990000">>></font>, <font color="#990000"><<</font><font color="#FF0000">"text/html;q=1.0, application/xml;q=0.1"</font><font color="#990000">>></font>} +])<font color="#990000">.</font></tt></pre> +</div></div> +<div class="listingblock"><div class="title">Get headers of a resource representation with request options</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt><span style="color: #009900">StreamRef</span> <span style="color: #990000">=</span> <span style="font-weight: bold"><span style="color: #000000">gun:head</span></span>(<span style="color: #009900">ConnPid</span>, <span style="color: #FF0000">"/articles"</span>, [], #{ - <span style="color: #0000FF">reply_to</span> <span style="color: #990000">=></span> <span style="color: #009900">ReplyToPid</span> -})<span style="color: #990000">.</span></tt></pre></div></div> -</div> -</div> -<div class="sect1"> +<pre><tt><font color="#009900">StreamRef</font> <font color="#990000">=</font> <b><font color="#000000">gun:head</font></b>(<font color="#009900">ConnPid</font>, <font color="#FF0000">"/articles"</font>, [], #{ + <font color="#0000FF">reply_to</font> <font color="#990000">=></font> <font color="#009900">ReplyToPid</font> +})<font color="#990000">.</font></tt></pre> +</div></div> <h2 id="_see_also">See also</h2> -<div class="sectionbody"> -<div class="paragraph"><p><a href="../gun">gun(3)</a>, -<a href="../gun.get">gun:head(3)</a>, -<a href="../gun.await">gun:await(3)</a>, -<a href="../gun_push">gun_push(3)</a>, -<a href="../gun_inform">gun_inform(3)</a>, -<a href="../gun_response">gun_response(3)</a></p></div> -</div> -</div> +<p><a href="../gun">gun(3)</a>, <a href="../gun.get">gun:head(3)</a>, <a href="../gun.await">gun:await(3)</a>, <a href="../gun_push">gun_push(3)</a>, <a href="../gun_inform">gun_inform(3)</a>, <a href="../gun_response">gun_response(3)</a></p> + |