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

<!DOCTYPE html>
<html><head>
<title>eric6.E5Network.E5NetworkProxyFactory</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.E5Network.E5NetworkProxyFactory</h1>

<p>
Module implementing a network proxy factory.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#E5NetworkProxyFactory">E5NetworkProxyFactory</a></td>
<td>Class implementing a network proxy factory.</td>
</tr>
<tr>
<td><a href="#HostnameMatcher">HostnameMatcher</a></td>
<td>Class implementing a matcher for host names.</td>
</tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#proxyAuthenticationRequired">proxyAuthenticationRequired</a></td>
<td>Module slot to handle a proxy authentication request.</td>
</tr>
<tr>
<td><a href="#schemeFromProxyType">schemeFromProxyType</a></td>
<td>Module function to determine the scheme name from the proxy type.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="E5NetworkProxyFactory" ID="E5NetworkProxyFactory"></a>
<h2>E5NetworkProxyFactory</h2>

<p>
    Class implementing a network proxy factory.
</p>
<h3>Derived from</h3>
QNetworkProxyFactory
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#E5NetworkProxyFactory.__init__">E5NetworkProxyFactory</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#E5NetworkProxyFactory.__setExceptions">__setExceptions</a></td>
<td>Private method to set the host name exceptions.</td>
</tr>
<tr>
<td><a href="#E5NetworkProxyFactory.queryProxy">queryProxy</a></td>
<td>Public method to determine a proxy for a given query.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="E5NetworkProxyFactory.__init__" ID="E5NetworkProxyFactory.__init__"></a>
<h4>E5NetworkProxyFactory (Constructor)</h4>
<b>E5NetworkProxyFactory</b>(<i></i>)

<p>
        Constructor
</p>
<a NAME="E5NetworkProxyFactory.__setExceptions" ID="E5NetworkProxyFactory.__setExceptions"></a>
<h4>E5NetworkProxyFactory.__setExceptions</h4>
<b>__setExceptions</b>(<i>exceptions</i>)

<p>
        Private method to set the host name exceptions.
</p>
<dl>

<dt><i>exceptions</i> (str)</dt>
<dd>
list of exceptions separated by ','
</dd>
</dl>
<a NAME="E5NetworkProxyFactory.queryProxy" ID="E5NetworkProxyFactory.queryProxy"></a>
<h4>E5NetworkProxyFactory.queryProxy</h4>
<b>queryProxy</b>(<i>query</i>)

<p>
        Public method to determine a proxy for a given query.
</p>
<dl>

<dt><i>query</i></dt>
<dd>
reference to the query object (QNetworkProxyQuery)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of proxies in order of preference (list of QNetworkProxy)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="HostnameMatcher" ID="HostnameMatcher"></a>
<h2>HostnameMatcher</h2>

<p>
    Class implementing a matcher for host names.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#HostnameMatcher.__init__">HostnameMatcher</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HostnameMatcher.match">match</a></td>
<td>Public method to test the given string.</td>
</tr>
<tr>
<td><a href="#HostnameMatcher.pattern">pattern</a></td>
<td>Public method to get the match pattern.</td>
</tr>
<tr>
<td><a href="#HostnameMatcher.setPattern">setPattern</a></td>
<td>Public method to set the match pattern.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="HostnameMatcher.__init__" ID="HostnameMatcher.__init__"></a>
<h4>HostnameMatcher (Constructor)</h4>
<b>HostnameMatcher</b>(<i>pattern</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>pattern</i> (str)</dt>
<dd>
pattern to be matched against
</dd>
</dl>
<a NAME="HostnameMatcher.match" ID="HostnameMatcher.match"></a>
<h4>HostnameMatcher.match</h4>
<b>match</b>(<i>host</i>)

<p>
        Public method to test the given string.
</p>
<dl>

<dt><i>host</i> (str)</dt>
<dd>
host name to be matched
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a successful match
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="HostnameMatcher.pattern" ID="HostnameMatcher.pattern"></a>
<h4>HostnameMatcher.pattern</h4>
<b>pattern</b>(<i></i>)

<p>
        Public method to get the match pattern.
</p>
<dl>
<dt>Return:</dt>
<dd>
match pattern
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="HostnameMatcher.setPattern" ID="HostnameMatcher.setPattern"></a>
<h4>HostnameMatcher.setPattern</h4>
<b>setPattern</b>(<i>pattern</i>)

<p>
        Public method to set the match pattern.
</p>
<dl>

<dt><i>pattern</i></dt>
<dd>
pattern to be matched against
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="proxyAuthenticationRequired" ID="proxyAuthenticationRequired"></a>
<h2>proxyAuthenticationRequired</h2>
<b>proxyAuthenticationRequired</b>(<i>proxy, auth</i>)

<p>
    Module slot to handle a proxy authentication request.
</p>
<dl>

<dt><i>proxy</i></dt>
<dd>
reference to the proxy object (QNetworkProxy)
</dd>
<dt><i>auth</i></dt>
<dd>
reference to the authenticator object (QAuthenticator)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="schemeFromProxyType" ID="schemeFromProxyType"></a>
<h2>schemeFromProxyType</h2>
<b>schemeFromProxyType</b>(<i>proxyType</i>)

<p>
    Module function to determine the scheme name from the proxy type.
</p>
<dl>

<dt><i>proxyType</i></dt>
<dd>
type of the proxy (QNetworkProxy.ProxyType)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
scheme (string, one of Http, Https, Ftp)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>