mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
919c8a7992
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329774 c90b9560-bf6c-de11-be94-00142212c4b1
104 lines
2.6 KiB
XML
104 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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
|
|
-->
|