Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.E5Network.E5NetworkProxyFactory.html
eric6/Documentation/Source/eric6.E5Network.E5NetworkProxyFactory.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.E5Network.E5NetworkProxyFactory</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.E5NetworkProxyFactory</h1> | |
| 23 <p> | |
| 24 Module implementing a network proxy factory. | |
| 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="#E5NetworkProxyFactory">E5NetworkProxyFactory</a></td> | |
| 34 <td>Class implementing a network proxy factory.</td> | |
| 35 </tr><tr> | |
| 36 <td><a href="#HostnameMatcher">HostnameMatcher</a></td> | |
| 37 <td>Class implementing a matcher for host names.</td> | |
| 38 </tr> | |
| 39 </table> | |
| 40 <h3>Functions</h3> | |
| 41 <table> | |
| 42 <tr> | |
| 43 <td><a href="#proxyAuthenticationRequired">proxyAuthenticationRequired</a></td> | |
| 44 <td>Module slot to handle a proxy authentication request.</td> | |
| 45 </tr><tr> | |
| 46 <td><a href="#schemeFromProxyType">schemeFromProxyType</a></td> | |
| 47 <td>Module function to determine the scheme name from the proxy type.</td> | |
| 48 </tr> | |
| 49 </table> | |
| 50 <hr /><hr /> | |
| 51 <a NAME="E5NetworkProxyFactory" ID="E5NetworkProxyFactory"></a> | |
| 52 <h2>E5NetworkProxyFactory</h2> | |
| 53 <p> | |
| 54 Class implementing a network proxy factory. | |
| 55 </p> | |
| 56 <h3>Derived from</h3> | |
| 57 QNetworkProxyFactory | |
| 58 <h3>Class Attributes</h3> | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 <table> | |
| 68 <tr> | |
| 69 <td><a href="#E5NetworkProxyFactory.__init__">E5NetworkProxyFactory</a></td> | |
| 70 <td>Constructor</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#E5NetworkProxyFactory.__setExceptions">__setExceptions</a></td> | |
| 73 <td>Private method to set the host name exceptions.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#E5NetworkProxyFactory.queryProxy">queryProxy</a></td> | |
| 76 <td>Public method to determine a proxy for a given query.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <h3>Static Methods</h3> | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 <a NAME="E5NetworkProxyFactory.__init__" ID="E5NetworkProxyFactory.__init__"></a> | |
| 84 <h4>E5NetworkProxyFactory (Constructor)</h4> | |
| 85 <b>E5NetworkProxyFactory</b>(<i></i>) | |
| 86 <p> | |
| 87 Constructor | |
| 88 </p><a NAME="E5NetworkProxyFactory.__setExceptions" ID="E5NetworkProxyFactory.__setExceptions"></a> | |
| 89 <h4>E5NetworkProxyFactory.__setExceptions</h4> | |
| 90 <b>__setExceptions</b>(<i>exceptions</i>) | |
| 91 <p> | |
| 92 Private method to set the host name exceptions. | |
| 93 </p><dl> | |
| 94 <dt><i>exceptions</i> (str)</dt> | |
| 95 <dd> | |
| 96 list of exceptions separated by ',' | |
| 97 </dd> | |
| 98 </dl><a NAME="E5NetworkProxyFactory.queryProxy" ID="E5NetworkProxyFactory.queryProxy"></a> | |
| 99 <h4>E5NetworkProxyFactory.queryProxy</h4> | |
| 100 <b>queryProxy</b>(<i>query</i>) | |
| 101 <p> | |
| 102 Public method to determine a proxy for a given query. | |
| 103 </p><dl> | |
| 104 <dt><i>query</i></dt> | |
| 105 <dd> | |
| 106 reference to the query object (QNetworkProxyQuery) | |
| 107 </dd> | |
| 108 </dl><dl> | |
| 109 <dt>Returns:</dt> | |
| 110 <dd> | |
| 111 list of proxies in order of preference (list of QNetworkProxy) | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <div align="right"><a href="#top">Up</a></div> | |
| 115 <hr /><hr /> | |
| 116 <a NAME="HostnameMatcher" ID="HostnameMatcher"></a> | |
| 117 <h2>HostnameMatcher</h2> | |
| 118 <p> | |
| 119 Class implementing a matcher for host names. | |
| 120 </p> | |
| 121 <h3>Derived from</h3> | |
| 122 object | |
| 123 <h3>Class Attributes</h3> | |
| 124 <table> | |
| 125 <tr><td>None</td></tr> | |
| 126 </table> | |
| 127 <h3>Class Methods</h3> | |
| 128 <table> | |
| 129 <tr><td>None</td></tr> | |
| 130 </table> | |
| 131 <h3>Methods</h3> | |
| 132 <table> | |
| 133 <tr> | |
| 134 <td><a href="#HostnameMatcher.__init__">HostnameMatcher</a></td> | |
| 135 <td>Constructor</td> | |
| 136 </tr><tr> | |
| 137 <td><a href="#HostnameMatcher.match">match</a></td> | |
| 138 <td>Public method to test the given string.</td> | |
| 139 </tr><tr> | |
| 140 <td><a href="#HostnameMatcher.pattern">pattern</a></td> | |
| 141 <td>Public method to get the match pattern.</td> | |
| 142 </tr><tr> | |
| 143 <td><a href="#HostnameMatcher.setPattern">setPattern</a></td> | |
| 144 <td>Public method to set the match pattern.</td> | |
| 145 </tr> | |
| 146 </table> | |
| 147 <h3>Static Methods</h3> | |
| 148 <table> | |
| 149 <tr><td>None</td></tr> | |
| 150 </table> | |
| 151 <a NAME="HostnameMatcher.__init__" ID="HostnameMatcher.__init__"></a> | |
| 152 <h4>HostnameMatcher (Constructor)</h4> | |
| 153 <b>HostnameMatcher</b>(<i>pattern</i>) | |
| 154 <p> | |
| 155 Constructor | |
| 156 </p><dl> | |
| 157 <dt><i>pattern</i> (str)</dt> | |
| 158 <dd> | |
| 159 pattern to be matched against | |
| 160 </dd> | |
| 161 </dl><a NAME="HostnameMatcher.match" ID="HostnameMatcher.match"></a> | |
| 162 <h4>HostnameMatcher.match</h4> | |
| 163 <b>match</b>(<i>host</i>) | |
| 164 <p> | |
| 165 Public method to test the given string. | |
| 166 </p><dl> | |
| 167 <dt><i>host</i> (str)</dt> | |
| 168 <dd> | |
| 169 host name to be matched | |
| 170 </dd> | |
| 171 </dl><dl> | |
| 172 <dt>Returns:</dt> | |
| 173 <dd> | |
| 174 flag indicating a successful match | |
| 175 </dd> | |
| 176 </dl><dl> | |
| 177 <dt>Return Type:</dt> | |
| 178 <dd> | |
| 179 bool | |
| 180 </dd> | |
| 181 </dl><a NAME="HostnameMatcher.pattern" ID="HostnameMatcher.pattern"></a> | |
| 182 <h4>HostnameMatcher.pattern</h4> | |
| 183 <b>pattern</b>(<i></i>) | |
| 184 <p> | |
| 185 Public method to get the match pattern. | |
| 186 </p><dl> | |
| 187 <dt>Returns:</dt> | |
| 188 <dd> | |
| 189 match pattern | |
| 190 </dd> | |
| 191 </dl><dl> | |
| 192 <dt>Return Type:</dt> | |
| 193 <dd> | |
| 194 str | |
| 195 </dd> | |
| 196 </dl><a NAME="HostnameMatcher.setPattern" ID="HostnameMatcher.setPattern"></a> | |
| 197 <h4>HostnameMatcher.setPattern</h4> | |
| 198 <b>setPattern</b>(<i>pattern</i>) | |
| 199 <p> | |
| 200 Public method to set the match pattern. | |
| 201 </p><dl> | |
| 202 <dt><i>pattern</i></dt> | |
| 203 <dd> | |
| 204 pattern to be matched against | |
| 205 </dd> | |
| 206 </dl> | |
| 207 <div align="right"><a href="#top">Up</a></div> | |
| 208 <hr /><hr /> | |
| 209 <a NAME="proxyAuthenticationRequired" ID="proxyAuthenticationRequired"></a> | |
| 210 <h2>proxyAuthenticationRequired</h2> | |
| 211 <b>proxyAuthenticationRequired</b>(<i>proxy, auth</i>) | |
| 212 <p> | |
| 213 Module slot to handle a proxy authentication request. | |
| 214 </p><dl> | |
| 215 <dt><i>proxy</i></dt> | |
| 216 <dd> | |
| 217 reference to the proxy object (QNetworkProxy) | |
| 218 </dd><dt><i>auth</i></dt> | |
| 219 <dd> | |
| 220 reference to the authenticator object (QAuthenticator) | |
| 221 </dd> | |
| 222 </dl> | |
| 223 <div align="right"><a href="#top">Up</a></div> | |
| 224 <hr /><hr /> | |
| 225 <a NAME="schemeFromProxyType" ID="schemeFromProxyType"></a> | |
| 226 <h2>schemeFromProxyType</h2> | |
| 227 <b>schemeFromProxyType</b>(<i>proxyType</i>) | |
| 228 <p> | |
| 229 Module function to determine the scheme name from the proxy type. | |
| 230 </p><dl> | |
| 231 <dt><i>proxyType</i></dt> | |
| 232 <dd> | |
| 233 type of the proxy (QNetworkProxy.ProxyType) | |
| 234 </dd> | |
| 235 </dl><dl> | |
| 236 <dt>Returns:</dt> | |
| 237 <dd> | |
| 238 scheme (string, one of Http, Https, Ftp) | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <div align="right"><a href="#top">Up</a></div> | |
| 242 <hr /> | |
| 243 </body></html> |
