470 строки
17 KiB
HTML
470 строки
17 KiB
HTML
<?xml version="1.0" encoding="ascii"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>nss.io.NetworkAddress</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
|
<script type="text/javascript" src="epydoc.js"></script>
|
|
</head>
|
|
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="nss-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="nss-module.html">Package nss</a> ::
|
|
<a href="nss.io-module.html">Module io</a> ::
|
|
Class NetworkAddress
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
|
|
onclick="toggle_private();">hide private</a>]</span></td></tr>
|
|
<tr><td align="right"><span class="options"
|
|
>[<a href="frames.html" target="_top">frames</a
|
|
>] | <a href="nss.io.NetworkAddress-class.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== TYPE DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">type NetworkAddress</h1><p class="nomargin-top"></p>
|
|
<pre class="base-tree">
|
|
object --+
|
|
|
|
|
<strong class="uidshort">NetworkAddress</strong>
|
|
</pre>
|
|
|
|
<hr />
|
|
<p>NetworkAddress(addr, port=0, family=PR_AF_INET)</p>
|
|
<p>If addr argument is a string it may be either a numeric address or a
|
|
DNS host name and is passed to the <a href="nss.io.AddrInfo-class.html" class="link">AddrInfo</a> constructor along with
|
|
the family parameter. The first address in the <a href="nss.io.AddrInfo-class.html" class="link">AddrInfo</a> object is
|
|
selected. If you need more fine grained control over which address is
|
|
selected from the <a href="nss.io.AddrInfo-class.html" class="link">AddrInfo</a> object then invoke <a href="nss.io.AddrInfo-class.html" class="link">AddrInfo</a> and select
|
|
one of the <a href="nss.io.NetworkAddress-class.html" class="link">NetworkAddress</a> it provides.</p>
|
|
<p>If the addr argument is an integer it may be one of the following constants:</p>
|
|
<dl class="rst-docutils">
|
|
<dt>PR_IpAddrNull</dt>
|
|
<dd>Do not set the IP address, only set the port.
|
|
NetworkAddress(PR_IpAddrNull, 123) is equivalent to NetworkAddress(port=123)</dd>
|
|
<dt>PR_IpAddrAny</dt>
|
|
<dd>Assign logical PR_INADDR_ANY to IP address. This wildcard value is typically
|
|
used to establish a socket on which to listen for incoming connection requests.</dd>
|
|
<dt>PR_IpAddrLoopback</dt>
|
|
<dd>Assign logical PR_INADDR_LOOPBACK. A client can use this value to connect to
|
|
itself without knowing the host's network address.</dd>
|
|
<dt>PR_IpAddrV4Mapped</dt>
|
|
<dd>Use IPv4 mapped address</dd>
|
|
</dl>
|
|
<p>The optional port argument sets the port number in the NetworkAddress object.
|
|
The port number may be modfied later by assigning to the port attribute.</p>
|
|
<p>Example:</p>
|
|
<pre class="rst-literal-block">
|
|
netaddr = nss.io.NetworkAddress('www.python.org')
|
|
print '%s %s' % (netaddr, netaddr.hostname)
|
|
netaddr = nss.io.NetworkAddress('82.94.237.218')
|
|
print '%s %s' % (netaddr, netaddr.hostname)
|
|
|
|
Output:
|
|
82.94.237.218:0 www.python.org
|
|
82.94.237.218:0 dinsdale.python.org
|
|
</pre>
|
|
<p><strong>WARNING:</strong> NetworkAddress initialization from a string only works with IPv4
|
|
and its use should be considered <em>deprecated</em>. Use <a href="nss.io.AddrInfo-class.html" class="link">AddrInfo</a> instead.</p>
|
|
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Instance Methods</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-InstanceMethods"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="nss.io.NetworkAddress-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">addr</span>,
|
|
<span class="summary-sig-arg">port</span>=<span class="summary-sig-default">0</span>,
|
|
<span class="summary-sig-arg">family</span>=<span class="summary-sig-default">PR_AF_INET</span>)</span><br />
|
|
x.__init__(...) initializes x; see help(type(x)) for signature</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type">a new object with type S, a subtype of T</span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="nss.io.NetworkAddress-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
|
|
<span class="summary-sig-arg">S</span>,
|
|
<span class="summary-sig-arg">...</span>)</span></td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="nss.io.NetworkAddress-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">x</span>)</span><br />
|
|
str(x)</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="nss.io.NetworkAddress-class.html#set_from_string" class="summary-sig-name">set_from_string</a>(<span class="summary-sig-arg">addr</span>,
|
|
<span class="summary-sig-arg">family</span>=<span class="summary-sig-default">PR_AF_INET</span>)</span><br />
|
|
Reinitializes the NetworkAddress object given a string.</td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== PROPERTIES ==================== -->
|
|
<a name="section-Properties"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Properties</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-Properties"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a name="address"></a><span class="summary-name">address</span><br />
|
|
address as string
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="nss.io.NetworkAddress-class.html#family" class="summary-name">family</a><br />
|
|
address family (e.g.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a name="hostentry"></a><span class="summary-name">hostentry</span><br />
|
|
HostEntry object representing this NetworkAddress (Warning: Deprecated, use AddrInfo instead)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a name="hostname"></a><span class="summary-name">hostname</span><br />
|
|
If an address string was used to construct this NetworkAddress then return the canonical hostname if available, otherwise the original address string
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a name="port"></a><span class="summary-name">port</span><br />
|
|
network address port
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></a>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Method Details</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-MethodDetails"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="__init__"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">addr</span>,
|
|
<span class="sig-arg">port</span>=<span class="sig-default">0</span>,
|
|
<span class="sig-arg">family</span>=<span class="sig-default">PR_AF_INET</span>)</span>
|
|
<br /><em class="fname">(Constructor)</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
x.__init__(...) initializes x; see help(type(x)) for signature
|
|
<dl class="fields">
|
|
<dt>Parameters:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><strong class="pname"><code>addr</code></strong> (string or integer) - may be an int or a string.</li>
|
|
<li><strong class="pname"><code>port</code></strong> (integer) - port number</li>
|
|
<li><strong class="pname"><code>family</code></strong> (integer) - <dl class="rst-docutils">
|
|
<dt>one of:</dt>
|
|
<dd><ul class="rst-first rst-last rst-simple">
|
|
<li>PR_AF_INET</li>
|
|
<li>PR_AF_INET6</li>
|
|
</ul>
|
|
</dd>
|
|
</dl></li>
|
|
</ul></dd>
|
|
<dt>Overrides:
|
|
object.__init__
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="__new__"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
|
|
<span class="sig-arg">S</span>,
|
|
<span class="sig-arg">...</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
|
|
<dl class="fields">
|
|
<dt>Returns: a new object with type S, a subtype of T</dt>
|
|
<dt>Overrides:
|
|
object.__new__
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="__str__"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>
|
|
<br /><em class="fname">(Informal representation operator)</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
str(x)
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
object.__str__
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="set_from_string"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">set_from_string</span>(<span class="sig-arg">addr</span>,
|
|
<span class="sig-arg">family</span>=<span class="sig-default">PR_AF_INET</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>Reinitializes the NetworkAddress object given a string.
|
|
Identical to constructing nss.io.NetworkAddress() with a
|
|
string value (see <a href="nss.io.NetworkAddress-class.html" class="link">NetworkAddress</a> constructor for documentation).</p>
|
|
<p><strong>WARNING:</strong> NetworkAddress initialization from a string only works with IPv4
|
|
and its use should be considered <em>deprecated</em>. Use <a href="nss.io.AddrInfo-class.html" class="link">AddrInfo</a> instead.</p>
|
|
<dl class="fields">
|
|
<dt>Parameters:</dt>
|
|
<dd><ul class="nomargin-top">
|
|
<li><strong class="pname"><code>addr</code></strong> (string) - the address string to convert</li>
|
|
<li><strong class="pname"><code>family</code></strong> (integer) - <dl class="rst-docutils">
|
|
<dt>one of:</dt>
|
|
<dd><ul class="rst-first rst-last rst-simple">
|
|
<li>PR_AF_INET</li>
|
|
<li>PR_AF_INET6</li>
|
|
<li>PR_AF_UNSPEC</li>
|
|
</ul>
|
|
</dd>
|
|
</dl></li>
|
|
</ul></dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== PROPERTY DETAILS ==================== -->
|
|
<a name="section-PropertyDetails"></a>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Property Details</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-PropertyDetails"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="family"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<h3 class="epydoc">family</h3>
|
|
address family (e.g. PR_AF_INET, etc.)
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="nss-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0.1
|
|
</td>
|
|
<td align="right" class="footer">
|
|
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
>http://epydoc.sourceforge.net</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<script type="text/javascript">
|
|
<!--
|
|
// Private objects are initially displayed (because if
|
|
// javascript is turned off then we want them to be
|
|
// visible); but by default, we want to hide them. So hide
|
|
// them unless we have a cookie that says to show them.
|
|
checkCookie();
|
|
// -->
|
|
</script>
|
|
</body>
|
|
</html>
|