diff options
author | joe <joe@61a7d7f5-40b7-0310-9c16-bb0ea8cb1845> | 2005-09-14 20:47:45 +0000 |
---|---|---|
committer | joe <joe@61a7d7f5-40b7-0310-9c16-bb0ea8cb1845> | 2005-09-14 20:47:45 +0000 |
commit | decf05925cfeaf9f90c9ce68f419040d8608539f (patch) | |
tree | eb9f111e598185a1f61144a1088ab050d8648bb2 /doc | |
parent | 4e3e93facc0cd273d7ea4a5a5cc43ae715f6e5b6 (diff) | |
download | neon-decf05925cfeaf9f90c9ce68f419040d8608539f.tar.gz |
* doc/ref/reqopts.xml: Document ne_set_request_expect100.
* doc/ref/opts.xml: Remove ne_set_expect100 documentation.
* doc/manual.xml: Pull in reqopts.xml.
git-svn-id: http://svn.webdav.org/repos/projects/neon/trunk@696 61a7d7f5-40b7-0310-9c16-bb0ea8cb1845
Diffstat (limited to 'doc')
-rw-r--r-- | doc/manual.xml | 2 | ||||
-rw-r--r-- | doc/ref/opts.xml | 17 | ||||
-rw-r--r-- | doc/ref/reqopts.xml | 60 |
3 files changed, 62 insertions, 17 deletions
diff --git a/doc/manual.xml b/doc/manual.xml index f665abd..f78de1b 100644 --- a/doc/manual.xml +++ b/doc/manual.xml @@ -52,6 +52,7 @@ <!ENTITY refssltrust SYSTEM "ref/ssltrust.xml"> <!ENTITY refreq SYSTEM "ref/req.xml"> <!ENTITY refreqhdr SYSTEM "ref/reqhdr.xml"> +<!ENTITY refreqopts SYSTEM "ref/reqopts.xml"> <!ENTITY refstatus SYSTEM "ref/status.xml"> <!ENTITY refgetst SYSTEM "ref/getst.xml"> <!ENTITY refreqbody SYSTEM "ref/reqbody.xml"> @@ -157,6 +158,7 @@ ignoring the WebDAV support if desired.</para> &refreq; <!-- ne_request_create --> &refsess; <!-- ne_session_create --> &refopts; <!-- ne_set_useragent --> + &refreqopts; <!-- ne_set_useragent --> &refreqbody; <!-- ne_set_request_body_buffer --> &refauth; <!-- ne_set_server_auth --> &refshave; <!-- ne_shave --> diff --git a/doc/ref/opts.xml b/doc/ref/opts.xml index 2664085..d288063 100644 --- a/doc/ref/opts.xml +++ b/doc/ref/opts.xml @@ -79,23 +79,6 @@ timeout interval, call <function>ne_set_read_timeout</function> giving the desired number of seconds as the <parameter>timeout</parameter> parameter.</para> - <para>An extension introduced in the HTTP/1.1 specification -was the use of the <literal>Expect: 100-continue</literal> header. -This header allows an HTTP client to be informed of the expected -response status before the request message body is sent: a useful -optimisation for situations where a large message body is to be sent. -The <function>ne_set_expect100</function> function can be used to -enable this feature by passing the <parameter>flag</parameter> -parameter as any non-zero integer.</para> - -<warning><para>Unfortunately, if this header is sent to a server which -is not fully compliant with the HTTP/1.1 specification, a deadlock -occurs resulting in a temporarily "hung" connection. neon will -recover gracefully from this situation, but only after a 15 second -timeout. It is highly recommended that this option is not enabled -unless it is known that the server in use correctly implements -<literal>Expect: 100-continue</literal> support.</para></warning> - <para>The scheme used to initially create the session will be returned by <function>ne_get_scheme</function>.</para> diff --git a/doc/ref/reqopts.xml b/doc/ref/reqopts.xml new file mode 100644 index 0000000..b4a6272 --- /dev/null +++ b/doc/ref/reqopts.xml @@ -0,0 +1,60 @@ +<refentry id="refreqopts"> + + <refmeta> + <refentrytitle>ne_set_request_expect100</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname id="ne_set_request_expect100">ne_set_request_expect100</refname> + <refpurpose>function to enable Expect: 100-continue support</refpurpose> + </refnamediv> + + <refsynopsisdiv> + + <funcsynopsis> + + <funcsynopsisinfo>#include <ne_request.h></funcsynopsisinfo> + + <funcprototype> + <funcdef>void <function>ne_set_request_expect100</function></funcdef> + <paramdef>ne_session *<parameter>session</parameter></paramdef> + <paramdef>int <parameter>flag</parameter></paramdef> + </funcprototype> + + </funcsynopsis> + + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>An extension introduced in the HTTP/1.1 specification was + the use of the <literal>Expect: 100-continue</literal> header. + This header allows an HTTP client to be informed of the expected + response status before the request message body is sent: a useful + optimisation for situations where a large message body is to be + sent. The <function>ne_set_request_expect100</function> function + can be used to enable this feature by passing the + <parameter>flag</parameter> parameter as any non-zero + integer.</para> + + <warning><para>Unfortunately, if this header is sent to a server + which is not fully compliant with the HTTP/1.1 specification, a + deadlock occurs resulting in a temporarily "hung" connection. + neon will recover gracefully from this situation, but only after a + 15 second timeout. It is highly recommended that this option is + not enabled unless it is known that the server in use correctly + implements <literal>Expect: 100-continue</literal> + support.</para></warning> + + </refsect1> + + <refsect1> + <title>See also</title> + + <para><xref linkend="ne_request_create"/>.</para> + + </refsect1> + +</refentry> |