1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 329774 $ -->
<refentry xml:id="eventhttprequest.sendreplystart" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventHttpRequest::sendReplyStart</refname>
<refpurpose>Initiate a chunked reply</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type>
<methodname>EventHttpRequest::sendReplyStart</methodname>
<methodparam>
<type>int</type>
<parameter>code</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
Initiate a reply that uses
<literal>Transfer-Encoding</literal>
<literal>chunked</literal>
.
</para>
<para>
This allows the caller to stream the reply back to the client and is useful
when either not all of the reply data is immediately available or when
sending very large replies.
</para>
<para>
The caller needs to supply data chunks with
<methodname>EventHttpRequest::sendReplyChunk</methodname>
and complete the reply by calling
<methodname>EventHttpRequest::sendReplyEnd</methodname>
.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>code</parameter>
</term>
<listitem>
<para>
The HTTP response code to send.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>
A brief message to send with the response code.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EventHttpRequest::sendReplyChunk</methodname>
</member>
<member>
<methodname>EventHttpRequest::sendReplyEnd</methodname>
</member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
