File: EventHttpConnection.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (87 lines) | stat: -rw-r--r-- 4,416 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="EventHttpConnection" namespace="" name="EventHttpConnection">
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs EventHttpConnection object"/>
      <return type="void"/>
    </docblock>
    <parameter name="base" optional="false" byreference="false" type="object" class="EventBase"/>
    <parameter name="dns_base" optional="false" byreference="false" type="object" class="EventDnsBase"/>
    <parameter name="address" optional="false" byreference="false" type="string"/>
    <parameter name="port" optional="false" byreference="false" type="int"/>
    <parameter name="ctx" optional="true" byreference="false" type="object" class="EventSslContext"/>
  </constructor>
  <method name="getBase" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns event base associated with the connection"/>
      <return type="EventBase"/>
    </docblock>
  </method>
  <method name="getPeer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the remote address and port associated with the connection"/>
      <return type="void"/>
    </docblock>
    <parameter name="address" optional="false" byreference="false" type="string"/>
    <parameter name="port" optional="false" byreference="false" type="int"/>
  </method>
  <method name="makeRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Makes an HTTP request over the specified connection"/>
      <return type="bool"/>
    </docblock>
    <parameter name="req" optional="false" byreference="false" type="object" class="EventHttpRequest"/>
    <parameter name="type" optional="false" byreference="false" type="int"/>
    <parameter name="uri" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setCloseCallback" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set callback for connection close"/>
      <return type="void"/>
    </docblock>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
    <parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="setLocalAddress" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the IP address from which HTTP connections are made"/>
      <return type="void"/>
    </docblock>
    <parameter name="address" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setLocalPort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the local port from which connections are made"/>
      <return type="void"/>
    </docblock>
    <parameter name="port" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setMaxBodySize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets maximum body size for the connection"/>
      <return type="void"/>
    </docblock>
    <parameter name="max_size" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setMaxHeadersSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets maximum header size"/>
      <return type="void"/>
    </docblock>
    <parameter name="max_size" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setRetries" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the retry limit for the connection"/>
      <return type="void"/>
    </docblock>
    <parameter name="retries" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setTimeout" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the timeout for the connection"/>
      <return type="void"/>
    </docblock>
    <parameter name="timeout" optional="false" byreference="false" type="int"/>
  </method>
</class>