File: getconnection.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (85 lines) | stat: -rw-r--r-- 2,459 bytes parent folder | download
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventhttprequest.getconnection" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>EventHttpRequest::getConnection</refname>
  <refpurpose>Returns EventHttpConnection object</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier>
   <type>EventHttpConnection</type>
   <methodname>EventHttpRequest::closeConnection</methodname>
   <void />
  </methodsynopsis>
  <para>
   Returns
   <classname>EventHttpConnection</classname>
   object which represents HTTP connection associated with the request.
  </para>
  <warning>
   <para>
    Libevent API allows HTTP request objects to be not bound to any HTTP
    connection. Therefore we can&apos;t unambiguously associate
    <classname>EventHttpRequest</classname>
    with
    <classname>EventHttpConnection</classname>
    . Thus, we construct
    <classname>EventHttpConnection</classname>
    object on-the-fly. Having no information about the event base, DNS base
    and connection-close callback, we just leave these fields unset.
   </para>
  </warning>
  <para>
   <methodname>EventHttpRequest::getConnection</methodname>
   method is usually useful when we need to set up a callback on connection
   close. See
   <methodname>EventHttpConnection::setCloseCallback</methodname>
   .
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns
   <classname>EventHttpConnection</classname>
   object.
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member>
    <methodname>EventHttpConnection::setCloseCallback</methodname>
   </member>
   <member>
    <methodname>EventHttpRequest::getBufferEvent</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
-->