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