diff options
Diffstat (limited to 'man/v1.2.4/nng_http_hijack.3http.html')
| -rw-r--r-- | man/v1.2.4/nng_http_hijack.3http.html | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/man/v1.2.4/nng_http_hijack.3http.html b/man/v1.2.4/nng_http_hijack.3http.html new file mode 100644 index 00000000..ca2e813c --- /dev/null +++ b/man/v1.2.4/nng_http_hijack.3http.html @@ -0,0 +1,153 @@ +--- +version: v1.2.4 +layout: refman +--- +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<meta http-equiv="X-UA-Compatible" content="IE=edge"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> +<meta name="generator" content="Asciidoctor 2.0.10"> +<title>nng_http_hijack(3http)</title> +<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> +<link rel="stylesheet" href="./asciidoctor.css"> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"> +</head> +<body class="manpage toc2 toc-left"> +<div id="header"> +<h1>nng_http_hijack(3http) Manual Page</h1> +<div id="toc" class="toc2"> +<div id="toctitle">Table of Contents</div> +<ul class="sectlevel1"> +<li><a href="#_synopsis">SYNOPSIS</a></li> +<li><a href="#_description">DESCRIPTION</a></li> +<li><a href="#_return_values">RETURN VALUES</a></li> +<li><a href="#_errors">ERRORS</a></li> +<li><a href="#_see_also">SEE ALSO</a></li> +</ul> +</div> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<p>nng_http_hijack - hijack HTTP server connection</p> +</div> +</div> +<div id="content"> +<div class="sect1"> +<h2 id="_synopsis">SYNOPSIS</h2> +<div class="sectionbody"> +<div class="listingblock"> +<div class="content"> +<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span><span class="tok-cp"></span> +<span class="tok-cp">#include</span> <span class="tok-cpf"><nng/supplemental/http/http.h></span><span class="tok-cp"></span> + +<span class="tok-kt">void</span> <span class="tok-nf">nng_http_hijack</span><span class="tok-p">(</span><span class="tok-n">nng_http_conn</span> <span class="tok-o">*</span><span class="tok-n">conn</span><span class="tok-p">);</span></code></pre> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_description">DESCRIPTION</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p> +The <code>nng_http_hijack()</code> function hijacks the connection <em>conn</em>, causing it +to be disassociated from the HTTP server where it was created.</p> +</div> +<div class="paragraph"> +<p>The purpose of this function is the creation of HTTP upgraders (such as +WebSocket), where the underlying HTTP connection will be taken over for +some other purpose, and should not be used any further by the server.</p> +</div> +<div class="paragraph"> +<p>This function is most useful when called from a handler function. +(See <a href="nng_http_handler_alloc.3http.html"><code>nng_http_handler_alloc()</code></a>.)</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +It is the responsibility of the caller to dispose of the underlying +connection when it is no longer needed. +Furthermore, the HTTP server will no longer send any responses to the +hijacked connection, so the caller should do that as well if appropriate. +(See <a href="nng_http_conn_write_res.3http.html"><code>nng_http_conn_write_res()</code></a>.) +</td> +</tr> +</table> +</div> +<div class="admonitionblock tip"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-tip" title="Tip"></i> +</td> +<td class="content"> +This function is intended to facilitate uses cases that involve changing +the protocol from HTTP, such as WebSocket. +Most applications will never need to use this function. +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>None.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="hdlist"> +<table> +<tr> +<td class="hdlist1"> +<code>NNG_ECLOSED</code> +</td> +<td class="hdlist2"> +<p>The connection was closed.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ENOMEM</code> +</td> +<td class="hdlist2"> +<p>Insufficient free memory exists.</p> +</td> +</tr> +<tr> +<td class="hdlist1"> +<code>NNG_ENOTSUP</code> +</td> +<td class="hdlist2"> +<p>HTTP not supported.</p> +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_see_also">SEE ALSO</h2> +<div class="sectionbody"> +<div class="paragraph text-left"> +<p><a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng_http_conn_write_res.3http.html">nng_http_conn_write_res(3http)</a>, +<a href="nng_http_handler_alloc.3http.html">nng_http_handler_alloc(3http)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> +</div> +<link rel="stylesheet" href="./pygments-default.css"> +</body> +</html>
\ No newline at end of file |
