1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>GetHeaderAll</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/http/Overview.html">http</a>::<a href="../../../nn/http/Connection/Overview.html">Connection</a>::GetHeaderAll</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> GetHeaderAll(
15     char * pHeaderBuf,
16     size_t bufSize,
17     size_t * pLengthCourier = NULL
18) const;
19<a href="../../../nn/Result/Overview.html">nn::Result</a> GetHeaderAll(
20     char * pHeaderBuf,
21     size_t bufSize,
22     const <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a> & timeout,
23     size_t * pLengthCourier = NULL
24) const;
25</pre>
26    </div>
27<h2>List of Overloaded Member Functions</h2>
28    <div class="section">
29      <table class="members">
30        <tr>
31          <td>
32<a href="./GetHeaderAll(0).html"><CODE>GetHeaderAll(char *, size_t, size_t *)</CODE> </a>
33          </td>
34<td>Gets the message header for the HTTP response that was received.</td>
35        </tr>
36        <tr>
37          <td>
38<a href="./GetHeaderAll(1).html"><CODE>GetHeaderAll(char *, size_t, const nn::fnd::TimeSpan &, size_t *)</CODE> </a>
39          </td>
40<td>This version of <a href="../../../nn/http/Connection/GetHeaderAll.html"><CODE>GetHeaderAll</CODE></a> has a timeout.</td>
41        </tr> </table>
42    </div>
43<h2>Description of <CODE>GetHeaderAll(char *, size_t, size_t *)</CODE></h2>
44<div class="section"><p>This function blocks until the header is completely received. See the description of <a href="../../../nn/http/Connection/GetHeaderField.html"><CODE>GetHeaderField</CODE></a> for more details about this specification.<br /><BR><B>Note:</B> If the <SPAN class="argument">pHeaderBuf</SPAN> size is smaller than the header size, as much data is stored in <SPAN class="argument">pHeaderBuf</SPAN> as will fit, and the header size is stored in <SPAN class="argument">pLengthCourier</SPAN>.<br /><BR><B>Note:</B> If <SPAN class="argument">pHeaderBuf</SPAN><CODE>==NULL</CODE> or <SPAN class="argument">bufSize</SPAN><CODE>==0</CODE>, and if <SPAN class="argument">pLengthCourier</SPAN><CODE>!=NULL</CODE>, the field length is stored in <SPAN class="argument">pLengthCourier</SPAN>. <BR><BR><B>Note:</B> Unlike the version of <CODE><a href="../../../nn/http/Connection/GetHeaderAll.html">GetHeaderAll</a></CODE> that includes a timeout, this function does not time out. In other words, control will not return from this function until processing has ended. In environments where communications are slow you can expect a long time to pass before processing ends and control returns from this function.<br /></p><!-- write here --></div>
45<h2>Description of <CODE>GetHeaderAll(char *, size_t, const nn::fnd::TimeSpan &, size_t *)</CODE></h2>
46<div class="section"><p>Other than the ability to specify a timeout, this version functions identically to <a href="../../../nn/http/Connection/GetHeaderAll.html"><CODE>GetHeaderAll</CODE></a>. For feature details, see the function reference for the version without a timeout. Returns <a href="../../../nn/http/ResultTimeout/Overview.html"><CODE>ResultTimeout</CODE></a> if no HTTP response header has been fully received within the timeout period. If <CODE>ResultTimeout</CODE> is returned, the connection is automatically canceled. (In other words, the function internally implements <a href="../../../nn/http/Connection/Cancel.html"><CODE>Cancel</CODE></a>.)<br /></p><!-- write here --></div>
47  <hr><p>CONFIDENTIAL</p></body>
48</html>
49