File: Swoole_Http_Client.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 (139 lines) | stat: -rw-r--r-- 6,574 bytes parent folder | download | duplicates (2)
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Swoole\Http\Client" namespace="Swoole\Http" name="Client">
  <member name="errCode" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="sock" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <method name="addFile" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Add a file to the post form."/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="type" optional="true" byreference="false" type="string"/>
    <parameter name="filename" optional="true" byreference="false" type="string"/>
    <parameter name="offset" optional="true" byreference="false" type="string"/>
  </method>
  <method name="close" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Close the http connection."/>
      <return type="void"/>
    </docblock>
  </method>
  <destructor name="__destruct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Destruct the HTTP client."/>
      <return type="void"/>
    </docblock>
  </destructor>
  <method name="download" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Download a file from the remote server."/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
    <parameter name="file" optional="false" byreference="false" type="string"/>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
    <parameter name="offset" optional="true" byreference="false" type="object" class="integer"/>
  </method>
  <method name="execute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send the HTTP request after setting the parameters."/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
    <parameter name="callback" optional="false" byreference="false" type="string"/>
  </method>
  <method name="get" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send GET http request to the remote server."/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="isConnected" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if the HTTP connection is connected."/>
      <return type="boolean"/>
    </docblock>
  </method>
  <method name="on" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Register callback function by event name."/>
      <return type="void"/>
    </docblock>
    <parameter name="event_name" optional="false" byreference="false" type="string"/>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="post" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send POST http request to the remote server."/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
    <parameter name="data" optional="false" byreference="false" type="string"/>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
  </method>
  <method name="push" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Push data to websocket client."/>
      <return type="void"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
    <parameter name="opcode" optional="true" byreference="false" type="string"/>
    <parameter name="finish" optional="true" byreference="false" type="string"/>
  </method>
  <method name="set" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Update the HTTP client paramters."/>
      <return type="void"/>
    </docblock>
    <parameter name="settings" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <method name="setCookies" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the http request cookies."/>
      <return type="void"/>
    </docblock>
    <parameter name="cookies" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <method name="setData" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the HTTP request body data."/>
      <return type="ReturnType"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the HTTP request headers."/>
      <return type="void"/>
    </docblock>
    <parameter name="headers" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <method name="setMethod" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set the HTTP request method."/>
      <return type="void"/>
    </docblock>
    <parameter name="method" optional="false" byreference="false" type="string"/>
  </method>
  <method name="upgrade" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Upgrade to websocket protocol."/>
      <return type="void"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
    <parameter name="callback" optional="false" byreference="false" type="string"/>
  </method>
</class>