eric6/Documentation/Source/eric6.E5Network.E5NetworkProxyFactory.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.E5Network.E5NetworkProxyFactory</h1> 23 <h1>eric6.E5Network.E5NetworkProxyFactory</h1>
24
23 <p> 25 <p>
24 Module implementing a network proxy factory. 26 Module implementing a network proxy factory.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#E5NetworkProxyFactory">E5NetworkProxyFactory</a></td> 38 <td><a href="#E5NetworkProxyFactory">E5NetworkProxyFactory</a></td>
34 <td>Class implementing a network proxy factory.</td> 39 <td>Class implementing a network proxy factory.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#HostnameMatcher">HostnameMatcher</a></td> 42 <td><a href="#HostnameMatcher">HostnameMatcher</a></td>
37 <td>Class implementing a matcher for host names.</td> 43 <td>Class implementing a matcher for host names.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
41 <table> 47
48 <table>
49
42 <tr> 50 <tr>
43 <td><a href="#proxyAuthenticationRequired">proxyAuthenticationRequired</a></td> 51 <td><a href="#proxyAuthenticationRequired">proxyAuthenticationRequired</a></td>
44 <td>Module slot to handle a proxy authentication request.</td> 52 <td>Module slot to handle a proxy authentication request.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#schemeFromProxyType">schemeFromProxyType</a></td> 55 <td><a href="#schemeFromProxyType">schemeFromProxyType</a></td>
47 <td>Module function to determine the scheme name from the proxy type.</td> 56 <td>Module function to determine the scheme name from the proxy type.</td>
48 </tr> 57 </tr>
49 </table> 58 </table>
50 <hr /><hr /> 59 <hr />
60 <hr />
51 <a NAME="E5NetworkProxyFactory" ID="E5NetworkProxyFactory"></a> 61 <a NAME="E5NetworkProxyFactory" ID="E5NetworkProxyFactory"></a>
52 <h2>E5NetworkProxyFactory</h2> 62 <h2>E5NetworkProxyFactory</h2>
63
53 <p> 64 <p>
54 Class implementing a network proxy factory. 65 Class implementing a network proxy factory.
55 </p> 66 </p>
56 <h3>Derived from</h3> 67 <h3>Derived from</h3>
57 QNetworkProxyFactory 68 QNetworkProxyFactory
58 <h3>Class Attributes</h3> 69 <h3>Class Attributes</h3>
70
59 <table> 71 <table>
60 <tr><td>None</td></tr> 72 <tr><td>None</td></tr>
61 </table> 73 </table>
62 <h3>Class Methods</h3> 74 <h3>Class Methods</h3>
75
63 <table> 76 <table>
64 <tr><td>None</td></tr> 77 <tr><td>None</td></tr>
65 </table> 78 </table>
66 <h3>Methods</h3> 79 <h3>Methods</h3>
67 <table> 80
81 <table>
82
68 <tr> 83 <tr>
69 <td><a href="#E5NetworkProxyFactory.__init__">E5NetworkProxyFactory</a></td> 84 <td><a href="#E5NetworkProxyFactory.__init__">E5NetworkProxyFactory</a></td>
70 <td>Constructor</td> 85 <td>Constructor</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#E5NetworkProxyFactory.__setExceptions">__setExceptions</a></td> 88 <td><a href="#E5NetworkProxyFactory.__setExceptions">__setExceptions</a></td>
73 <td>Private method to set the host name exceptions.</td> 89 <td>Private method to set the host name exceptions.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#E5NetworkProxyFactory.queryProxy">queryProxy</a></td> 92 <td><a href="#E5NetworkProxyFactory.queryProxy">queryProxy</a></td>
76 <td>Public method to determine a proxy for a given query.</td> 93 <td>Public method to determine a proxy for a given query.</td>
77 </tr> 94 </tr>
78 </table> 95 </table>
79 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
80 <table> 97
81 <tr><td>None</td></tr> 98 <table>
82 </table> 99 <tr><td>None</td></tr>
100 </table>
101
83 <a NAME="E5NetworkProxyFactory.__init__" ID="E5NetworkProxyFactory.__init__"></a> 102 <a NAME="E5NetworkProxyFactory.__init__" ID="E5NetworkProxyFactory.__init__"></a>
84 <h4>E5NetworkProxyFactory (Constructor)</h4> 103 <h4>E5NetworkProxyFactory (Constructor)</h4>
85 <b>E5NetworkProxyFactory</b>(<i></i>) 104 <b>E5NetworkProxyFactory</b>(<i></i>)
105
86 <p> 106 <p>
87 Constructor 107 Constructor
88 </p><a NAME="E5NetworkProxyFactory.__setExceptions" ID="E5NetworkProxyFactory.__setExceptions"></a> 108 </p>
109 <a NAME="E5NetworkProxyFactory.__setExceptions" ID="E5NetworkProxyFactory.__setExceptions"></a>
89 <h4>E5NetworkProxyFactory.__setExceptions</h4> 110 <h4>E5NetworkProxyFactory.__setExceptions</h4>
90 <b>__setExceptions</b>(<i>exceptions</i>) 111 <b>__setExceptions</b>(<i>exceptions</i>)
112
91 <p> 113 <p>
92 Private method to set the host name exceptions. 114 Private method to set the host name exceptions.
93 </p><dl> 115 </p>
116 <dl>
117
94 <dt><i>exceptions</i> (str)</dt> 118 <dt><i>exceptions</i> (str)</dt>
95 <dd> 119 <dd>
96 list of exceptions separated by ',' 120 list of exceptions separated by ','
97 </dd> 121 </dd>
98 </dl><a NAME="E5NetworkProxyFactory.queryProxy" ID="E5NetworkProxyFactory.queryProxy"></a> 122 </dl>
123 <a NAME="E5NetworkProxyFactory.queryProxy" ID="E5NetworkProxyFactory.queryProxy"></a>
99 <h4>E5NetworkProxyFactory.queryProxy</h4> 124 <h4>E5NetworkProxyFactory.queryProxy</h4>
100 <b>queryProxy</b>(<i>query</i>) 125 <b>queryProxy</b>(<i>query</i>)
126
101 <p> 127 <p>
102 Public method to determine a proxy for a given query. 128 Public method to determine a proxy for a given query.
103 </p><dl> 129 </p>
130 <dl>
131
104 <dt><i>query</i></dt> 132 <dt><i>query</i></dt>
105 <dd> 133 <dd>
106 reference to the query object (QNetworkProxyQuery) 134 reference to the query object (QNetworkProxyQuery)
107 </dd> 135 </dd>
108 </dl><dl> 136 </dl>
137 <dl>
109 <dt>Returns:</dt> 138 <dt>Returns:</dt>
110 <dd> 139 <dd>
111 list of proxies in order of preference (list of QNetworkProxy) 140 list of proxies in order of preference (list of QNetworkProxy)
112 </dd> 141 </dd>
113 </dl> 142 </dl>
114 <div align="right"><a href="#top">Up</a></div> 143 <div align="right"><a href="#top">Up</a></div>
115 <hr /><hr /> 144 <hr />
145 <hr />
116 <a NAME="HostnameMatcher" ID="HostnameMatcher"></a> 146 <a NAME="HostnameMatcher" ID="HostnameMatcher"></a>
117 <h2>HostnameMatcher</h2> 147 <h2>HostnameMatcher</h2>
148
118 <p> 149 <p>
119 Class implementing a matcher for host names. 150 Class implementing a matcher for host names.
120 </p> 151 </p>
121 <h3>Derived from</h3> 152 <h3>Derived from</h3>
122 object 153 object
123 <h3>Class Attributes</h3> 154 <h3>Class Attributes</h3>
155
124 <table> 156 <table>
125 <tr><td>None</td></tr> 157 <tr><td>None</td></tr>
126 </table> 158 </table>
127 <h3>Class Methods</h3> 159 <h3>Class Methods</h3>
160
128 <table> 161 <table>
129 <tr><td>None</td></tr> 162 <tr><td>None</td></tr>
130 </table> 163 </table>
131 <h3>Methods</h3> 164 <h3>Methods</h3>
132 <table> 165
166 <table>
167
133 <tr> 168 <tr>
134 <td><a href="#HostnameMatcher.__init__">HostnameMatcher</a></td> 169 <td><a href="#HostnameMatcher.__init__">HostnameMatcher</a></td>
135 <td>Constructor</td> 170 <td>Constructor</td>
136 </tr><tr> 171 </tr>
172 <tr>
137 <td><a href="#HostnameMatcher.match">match</a></td> 173 <td><a href="#HostnameMatcher.match">match</a></td>
138 <td>Public method to test the given string.</td> 174 <td>Public method to test the given string.</td>
139 </tr><tr> 175 </tr>
176 <tr>
140 <td><a href="#HostnameMatcher.pattern">pattern</a></td> 177 <td><a href="#HostnameMatcher.pattern">pattern</a></td>
141 <td>Public method to get the match pattern.</td> 178 <td>Public method to get the match pattern.</td>
142 </tr><tr> 179 </tr>
180 <tr>
143 <td><a href="#HostnameMatcher.setPattern">setPattern</a></td> 181 <td><a href="#HostnameMatcher.setPattern">setPattern</a></td>
144 <td>Public method to set the match pattern.</td> 182 <td>Public method to set the match pattern.</td>
145 </tr> 183 </tr>
146 </table> 184 </table>
147 <h3>Static Methods</h3> 185 <h3>Static Methods</h3>
148 <table> 186
149 <tr><td>None</td></tr> 187 <table>
150 </table> 188 <tr><td>None</td></tr>
189 </table>
190
151 <a NAME="HostnameMatcher.__init__" ID="HostnameMatcher.__init__"></a> 191 <a NAME="HostnameMatcher.__init__" ID="HostnameMatcher.__init__"></a>
152 <h4>HostnameMatcher (Constructor)</h4> 192 <h4>HostnameMatcher (Constructor)</h4>
153 <b>HostnameMatcher</b>(<i>pattern</i>) 193 <b>HostnameMatcher</b>(<i>pattern</i>)
194
154 <p> 195 <p>
155 Constructor 196 Constructor
156 </p><dl> 197 </p>
198 <dl>
199
157 <dt><i>pattern</i> (str)</dt> 200 <dt><i>pattern</i> (str)</dt>
158 <dd> 201 <dd>
159 pattern to be matched against 202 pattern to be matched against
160 </dd> 203 </dd>
161 </dl><a NAME="HostnameMatcher.match" ID="HostnameMatcher.match"></a> 204 </dl>
205 <a NAME="HostnameMatcher.match" ID="HostnameMatcher.match"></a>
162 <h4>HostnameMatcher.match</h4> 206 <h4>HostnameMatcher.match</h4>
163 <b>match</b>(<i>host</i>) 207 <b>match</b>(<i>host</i>)
208
164 <p> 209 <p>
165 Public method to test the given string. 210 Public method to test the given string.
166 </p><dl> 211 </p>
212 <dl>
213
167 <dt><i>host</i> (str)</dt> 214 <dt><i>host</i> (str)</dt>
168 <dd> 215 <dd>
169 host name to be matched 216 host name to be matched
170 </dd> 217 </dd>
171 </dl><dl> 218 </dl>
219 <dl>
172 <dt>Returns:</dt> 220 <dt>Returns:</dt>
173 <dd> 221 <dd>
174 flag indicating a successful match 222 flag indicating a successful match
175 </dd> 223 </dd>
176 </dl><dl> 224 </dl>
225 <dl>
177 <dt>Return Type:</dt> 226 <dt>Return Type:</dt>
178 <dd> 227 <dd>
179 bool 228 bool
180 </dd> 229 </dd>
181 </dl><a NAME="HostnameMatcher.pattern" ID="HostnameMatcher.pattern"></a> 230 </dl>
231 <a NAME="HostnameMatcher.pattern" ID="HostnameMatcher.pattern"></a>
182 <h4>HostnameMatcher.pattern</h4> 232 <h4>HostnameMatcher.pattern</h4>
183 <b>pattern</b>(<i></i>) 233 <b>pattern</b>(<i></i>)
234
184 <p> 235 <p>
185 Public method to get the match pattern. 236 Public method to get the match pattern.
186 </p><dl> 237 </p>
238 <dl>
187 <dt>Returns:</dt> 239 <dt>Returns:</dt>
188 <dd> 240 <dd>
189 match pattern 241 match pattern
190 </dd> 242 </dd>
191 </dl><dl> 243 </dl>
244 <dl>
192 <dt>Return Type:</dt> 245 <dt>Return Type:</dt>
193 <dd> 246 <dd>
194 str 247 str
195 </dd> 248 </dd>
196 </dl><a NAME="HostnameMatcher.setPattern" ID="HostnameMatcher.setPattern"></a> 249 </dl>
250 <a NAME="HostnameMatcher.setPattern" ID="HostnameMatcher.setPattern"></a>
197 <h4>HostnameMatcher.setPattern</h4> 251 <h4>HostnameMatcher.setPattern</h4>
198 <b>setPattern</b>(<i>pattern</i>) 252 <b>setPattern</b>(<i>pattern</i>)
253
199 <p> 254 <p>
200 Public method to set the match pattern. 255 Public method to set the match pattern.
201 </p><dl> 256 </p>
257 <dl>
258
202 <dt><i>pattern</i></dt> 259 <dt><i>pattern</i></dt>
203 <dd> 260 <dd>
204 pattern to be matched against 261 pattern to be matched against
205 </dd> 262 </dd>
206 </dl> 263 </dl>
207 <div align="right"><a href="#top">Up</a></div> 264 <div align="right"><a href="#top">Up</a></div>
208 <hr /><hr /> 265 <hr />
266 <hr />
209 <a NAME="proxyAuthenticationRequired" ID="proxyAuthenticationRequired"></a> 267 <a NAME="proxyAuthenticationRequired" ID="proxyAuthenticationRequired"></a>
210 <h2>proxyAuthenticationRequired</h2> 268 <h2>proxyAuthenticationRequired</h2>
211 <b>proxyAuthenticationRequired</b>(<i>proxy, auth</i>) 269 <b>proxyAuthenticationRequired</b>(<i>proxy, auth</i>)
270
212 <p> 271 <p>
213 Module slot to handle a proxy authentication request. 272 Module slot to handle a proxy authentication request.
214 </p><dl> 273 </p>
274 <dl>
275
215 <dt><i>proxy</i></dt> 276 <dt><i>proxy</i></dt>
216 <dd> 277 <dd>
217 reference to the proxy object (QNetworkProxy) 278 reference to the proxy object (QNetworkProxy)
218 </dd><dt><i>auth</i></dt> 279 </dd>
280 <dt><i>auth</i></dt>
219 <dd> 281 <dd>
220 reference to the authenticator object (QAuthenticator) 282 reference to the authenticator object (QAuthenticator)
221 </dd> 283 </dd>
222 </dl> 284 </dl>
223 <div align="right"><a href="#top">Up</a></div> 285 <div align="right"><a href="#top">Up</a></div>
224 <hr /><hr /> 286 <hr />
287 <hr />
225 <a NAME="schemeFromProxyType" ID="schemeFromProxyType"></a> 288 <a NAME="schemeFromProxyType" ID="schemeFromProxyType"></a>
226 <h2>schemeFromProxyType</h2> 289 <h2>schemeFromProxyType</h2>
227 <b>schemeFromProxyType</b>(<i>proxyType</i>) 290 <b>schemeFromProxyType</b>(<i>proxyType</i>)
291
228 <p> 292 <p>
229 Module function to determine the scheme name from the proxy type. 293 Module function to determine the scheme name from the proxy type.
230 </p><dl> 294 </p>
295 <dl>
296
231 <dt><i>proxyType</i></dt> 297 <dt><i>proxyType</i></dt>
232 <dd> 298 <dd>
233 type of the proxy (QNetworkProxy.ProxyType) 299 type of the proxy (QNetworkProxy.ProxyType)
234 </dd> 300 </dd>
235 </dl><dl> 301 </dl>
302 <dl>
236 <dt>Returns:</dt> 303 <dt>Returns:</dt>
237 <dd> 304 <dd>
238 scheme (string, one of Http, Https, Ftp) 305 scheme (string, one of Http, Https, Ftp)
239 </dd> 306 </dd>
240 </dl> 307 </dl>

eric ide

mercurial