|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.E5Network.E5XmlRpcClient</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.E5Network.E5XmlRpcClient</h1> |
|
23 <p> |
|
24 Module implementing a xmlrpc client for Qt. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#E5XmlRpcClient">E5XmlRpcClient</a></td> |
|
34 <td>Class implementing a xmlrpc client for Qt.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="E5XmlRpcClient" ID="E5XmlRpcClient"></a> |
|
43 <h2>E5XmlRpcClient</h2> |
|
44 <p> |
|
45 Class implementing a xmlrpc client for Qt. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QObject |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#E5XmlRpcClient.__init__">E5XmlRpcClient</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#E5XmlRpcClient.__replyFinished">__replyFinished</a></td> |
|
64 <td>Private slot handling the receipt of a reply.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#E5XmlRpcClient.__sslErrors">__sslErrors</a></td> |
|
67 <td>Private slot to handle SSL errors.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#E5XmlRpcClient.abort">abort</a></td> |
|
70 <td>Public method to abort all calls.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#E5XmlRpcClient.call">call</a></td> |
|
73 <td>Public method to call the remote server.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#E5XmlRpcClient.setUrl">setUrl</a></td> |
|
76 <td>Public slot to set the xmlrpc handler URL.</td> |
|
77 </tr> |
|
78 </table> |
|
79 <h3>Static Methods</h3> |
|
80 <table> |
|
81 <tr><td>None</td></tr> |
|
82 </table> |
|
83 <a NAME="E5XmlRpcClient.__init__" ID="E5XmlRpcClient.__init__"></a> |
|
84 <h4>E5XmlRpcClient (Constructor)</h4> |
|
85 <b>E5XmlRpcClient</b>(<i>url, parent=None</i>) |
|
86 <p> |
|
87 Constructor |
|
88 </p><dl> |
|
89 <dt><i>url</i></dt> |
|
90 <dd> |
|
91 xmlrpc handler URL (string or QUrl) |
|
92 </dd><dt><i>parent</i></dt> |
|
93 <dd> |
|
94 parent object (QObject) |
|
95 </dd> |
|
96 </dl><a NAME="E5XmlRpcClient.__replyFinished" ID="E5XmlRpcClient.__replyFinished"></a> |
|
97 <h4>E5XmlRpcClient.__replyFinished</h4> |
|
98 <b>__replyFinished</b>(<i>reply</i>) |
|
99 <p> |
|
100 Private slot handling the receipt of a reply. |
|
101 </p><dl> |
|
102 <dt><i>reply</i></dt> |
|
103 <dd> |
|
104 reference to the finished reply (QNetworkReply) |
|
105 </dd> |
|
106 </dl><a NAME="E5XmlRpcClient.__sslErrors" ID="E5XmlRpcClient.__sslErrors"></a> |
|
107 <h4>E5XmlRpcClient.__sslErrors</h4> |
|
108 <b>__sslErrors</b>(<i>reply, errors</i>) |
|
109 <p> |
|
110 Private slot to handle SSL errors. |
|
111 </p><dl> |
|
112 <dt><i>reply</i></dt> |
|
113 <dd> |
|
114 reference to the reply object (QNetworkReply) |
|
115 </dd><dt><i>errors</i></dt> |
|
116 <dd> |
|
117 list of SSL errors (list of QSslError) |
|
118 </dd> |
|
119 </dl><a NAME="E5XmlRpcClient.abort" ID="E5XmlRpcClient.abort"></a> |
|
120 <h4>E5XmlRpcClient.abort</h4> |
|
121 <b>abort</b>(<i></i>) |
|
122 <p> |
|
123 Public method to abort all calls. |
|
124 </p><a NAME="E5XmlRpcClient.call" ID="E5XmlRpcClient.call"></a> |
|
125 <h4>E5XmlRpcClient.call</h4> |
|
126 <b>call</b>(<i>method, args, responseCallback, errorCallback</i>) |
|
127 <p> |
|
128 Public method to call the remote server. |
|
129 </p><dl> |
|
130 <dt><i>method</i></dt> |
|
131 <dd> |
|
132 name of the remote method to be called (string) |
|
133 </dd><dt><i>args</i></dt> |
|
134 <dd> |
|
135 tuple of method arguments (tuple) |
|
136 </dd><dt><i>responseCallback</i></dt> |
|
137 <dd> |
|
138 method to be called with the returned |
|
139 result as a tuple (function) |
|
140 </dd><dt><i>errorCallback</i></dt> |
|
141 <dd> |
|
142 method to be called in case of an error |
|
143 with error code and error string (function) |
|
144 </dd> |
|
145 </dl><a NAME="E5XmlRpcClient.setUrl" ID="E5XmlRpcClient.setUrl"></a> |
|
146 <h4>E5XmlRpcClient.setUrl</h4> |
|
147 <b>setUrl</b>(<i>url</i>) |
|
148 <p> |
|
149 Public slot to set the xmlrpc handler URL. |
|
150 </p><dl> |
|
151 <dt><i>url</i></dt> |
|
152 <dd> |
|
153 xmlrpc handler URL (string or QUrl) |
|
154 </dd> |
|
155 </dl> |
|
156 <div align="right"><a href="#top">Up</a></div> |
|
157 <hr /> |
|
158 </body></html> |