Commit ed793fcb authored by Michael Weinrich's avatar Michael Weinrich
Browse files

documentation update

parent 82951ddd
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module __init__</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>__init__</strong></big></big> (version 0.0.1)</font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/micxer/development/UPnT/upntest/__init__.py">/home/micxer/development/UPnT/upntest/__init__.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>__version__</strong> = '0.0.1'<br>
<strong>__version_info__</strong> = (0, 0, 1)</td></tr></table>
</body></html>
\ No newline at end of file
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module base</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>base</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/micxer/development/UPnT/upntest/base.py">/home/micxer/development/UPnT/upntest/base.py</a></font></td></tr></table>
<p><tt>#&nbsp;Licensed&nbsp;under&nbsp;the&nbsp;MIT&nbsp;license<br>
#&nbsp;<a href="http://opensource.org/licenses/mit-license.php">http://opensource.org/licenses/mit-license.php</a></tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="louie.html">louie</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="base.html#UPnT">UPnT</a>
</font></dt></dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="UPnT">class <strong>UPnT</strong></a></font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="UPnT-__init__"><strong>__init__</strong></a>(self, *args, **kwargs)</dt></dl>
<dl><dt><a name="UPnT-datagramReceived"><strong>datagramReceived</strong></a>(self, data, host, port)</dt></dl>
<dl><dt><a name="UPnT-getDevice"><strong>getDevice</strong></a>(self, host)</dt></dl>
<dl><dt><a name="UPnT-showHints"><strong>showHints</strong></a>(self)</dt></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>known_devices</strong> = []</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>log</strong> = &lt;coherence.extern.logger.Logger instance&gt;<br>
<strong>reactor</strong> = &lt;twisted.internet.selectreactor.SelectReactor object&gt;</td></tr></table>
</body></html>
\ No newline at end of file
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module testdevice</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>testdevice</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/micxer/development/UPnT/upntest/testdevice.py">/home/micxer/development/UPnT/upntest/testdevice.py</a></font></td></tr></table>
<p><tt>#&nbsp;Licensed&nbsp;under&nbsp;the&nbsp;MIT&nbsp;license<br>
#&nbsp;<a href="http://opensource.org/licenses/mit-license.php">http://opensource.org/licenses/mit-license.php</a></tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="testdevice.html#TestDevice">TestDevice</a>
</font></dt></dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="TestDevice">class <strong>TestDevice</strong></a></font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Class&nbsp;for&nbsp;storing&nbsp;data&nbsp;about&nbsp;active&nbsp;devices<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="TestDevice-__init__"><strong>__init__</strong></a>(self, uuid)</dt></dl>
<dl><dt><a name="TestDevice-addSubdevice"><strong>addSubdevice</strong></a>(self, subdevice)</dt><dd><tt>Add&nbsp;a&nbsp;subdevice</tt></dd></dl>
<dl><dt><a name="TestDevice-checkDescription"><strong>checkDescription</strong></a>(self)</dt><dd><tt>Check&nbsp;if&nbsp;description&nbsp;of&nbsp;device&nbsp;is&nbsp;valid&nbsp;and&nbsp;if&nbsp;all&nbsp;devices&nbsp;and&nbsp;<br>
services&nbsp;were&nbsp;announced&nbsp;hence&nbsp;existent&nbsp;in&nbsp;the&nbsp;_sub_devices&nbsp;and&nbsp;_services</tt></dd></dl>
<dl><dt><a name="TestDevice-getLocation"><strong>getLocation</strong></a>(self)</dt></dl>
<dl><dt><a name="TestDevice-getParent"><strong>getParent</strong></a>(self)</dt><dd><tt>Get&nbsp;current&nbsp;parent&nbsp;device</tt></dd></dl>
<dl><dt><a name="TestDevice-getUuid"><strong>getUuid</strong></a>(self)</dt></dl>
<dl><dt><a name="TestDevice-setParent"><strong>setParent</strong></a>(self, parent_device)</dt><dd><tt>Set&nbsp;new&nbsp;parent&nbsp;device</tt></dd></dl>
<hr>
Properties defined here:<br>
<dl><dt><strong>UUID</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = getUuid(self)</dt></dl>
</dd>
</dl>
<dl><dt><strong>location</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = getLocation(self)</dt></dl>
</dd>
</dl>
<dl><dt><strong>parent</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = getParent(self)</dt><dd><tt>Get&nbsp;current&nbsp;parent&nbsp;device</tt></dd></dl>
</dd>
<dd><dl><dt><a name="-<em>set</em>"><strong><em>set</em></strong></a> = setParent(self, parent_device)</dt><dd><tt>Set&nbsp;new&nbsp;parent&nbsp;device</tt></dd></dl>
</dd>
</dl>
</td></tr></table></td></tr></table>
</body></html>
\ No newline at end of file
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module testhost</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>testhost</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/micxer/development/UPnT/upntest/testhost.py">/home/micxer/development/UPnT/upntest/testhost.py</a></font></td></tr></table>
<p><tt>#&nbsp;UPnT&nbsp;-&nbsp;UPnP&nbsp;Test&nbsp;Suite<br>
#<br>
#&nbsp;Licensed&nbsp;under&nbsp;the&nbsp;MIT&nbsp;license<br>
#&nbsp;<a href="http://opensource.org/licenses/mit-license.php">http://opensource.org/licenses/mit-license.php</a></tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="string.html">string</a><br>
</td><td width="25%" valign=top><a href="urllib2.html">urllib2</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="testhost.html#TestHost">TestHost</a>
</font></dt></dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="TestHost">class <strong>TestHost</strong></a></font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>helper&nbsp;class&nbsp;to&nbsp;keep&nbsp;track&nbsp;of&nbsp;devices&nbsp;and&nbsp;their&nbsp;behaviour<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="TestHost-__init__"><strong>__init__</strong></a>(self, host)</dt></dl>
<dl><dt><a name="TestHost-checkAlivePacket"><strong>checkAlivePacket</strong></a>(self, headers)</dt><dd><tt>checks&nbsp;special&nbsp;content&nbsp;of&nbsp;an&nbsp;alive&nbsp;notification&nbsp;packet&nbsp;for&nbsp;errors&nbsp;<br>
and&nbsp;returns&nbsp;True&nbsp;if&nbsp;everything&nbsp;looks&nbsp;ok</tt></dd></dl>
<dl><dt><a name="TestHost-checkDiscoveryAnswerPacket"><strong>checkDiscoveryAnswerPacket</strong></a>(self, header, payload)</dt><dd><tt>checks&nbsp;the&nbsp;answer&nbsp;of&nbsp;a&nbsp;discovery&nbsp;packet&nbsp;for&nbsp;errors&nbsp;and&nbsp;returns&nbsp;<br>
True&nbsp;if&nbsp;everything&nbsp;looks&nbsp;ok</tt></dd></dl>
<dl><dt><a name="TestHost-checkDiscoveryPacket"><strong>checkDiscoveryPacket</strong></a>(self, header, payload)</dt><dd><tt>checks&nbsp;content&nbsp;of&nbsp;a&nbsp;discovery&nbsp;packet&nbsp;for&nbsp;errors&nbsp;and&nbsp;returns&nbsp;<br>
True&nbsp;if&nbsp;everything&nbsp;looks&nbsp;ok</tt></dd></dl>
<dl><dt><a name="TestHost-checkNotificationPacket"><strong>checkNotificationPacket</strong></a>(self, header, payload)</dt><dd><tt>checks&nbsp;common&nbsp;content&nbsp;of&nbsp;a&nbsp;notification&nbsp;packet&nbsp;for&nbsp;errors&nbsp;and&nbsp;returns&nbsp;<br>
True&nbsp;if&nbsp;everything&nbsp;looks&nbsp;ok</tt></dd></dl>
<dl><dt><a name="TestHost-createDeviceTree"><strong>createDeviceTree</strong></a>(self)</dt><dd><tt>Create&nbsp;device&nbsp;tree&nbsp;from&nbsp;the&nbsp;received&nbsp;SSDP&nbsp;packets</tt></dd></dl>
<dl><dt><a name="TestHost-dispatchDiscoveryPacketData"><strong>dispatchDiscoveryPacketData</strong></a>(self, data)</dt></dl>
<dl><dt><a name="TestHost-formatHeader"><strong>formatHeader</strong></a>(self, header)</dt><dd><tt>parses&nbsp;the&nbsp;header&nbsp;and&nbsp;returns&nbsp;a&nbsp;dictionary&nbsp;containing&nbsp;the&nbsp;command&nbsp;<br>
and&nbsp;the&nbsp;header&nbsp;lines&nbsp;also&nbsp;as&nbsp;dictionary</tt></dd></dl>
<dl><dt><a name="TestHost-getHost"><strong>getHost</strong></a>(self)</dt></dl>
<dl><dt><a name="TestHost-msearchDatagramsReceived"><strong>msearchDatagramsReceived</strong></a>(self)</dt></dl>
<dl><dt><a name="TestHost-processSentUUID"><strong>processSentUUID</strong></a>(self, header)</dt><dd><tt>Register&nbsp;a&nbsp;new&nbsp;device&nbsp;or&nbsp;delete&nbsp;an&nbsp;existing&nbsp;device&nbsp;based&nbsp;on&nbsp;the&nbsp;UUID&nbsp;<br>
and&nbsp;packet&nbsp;header</tt></dd></dl>
<dl><dt><a name="TestHost-showPacketData"><strong>showPacketData</strong></a>(self, header, payload)</dt><dd><tt>show&nbsp;erroneous&nbsp;packet&nbsp;data</tt></dd></dl>
<dl><dt><a name="TestHost-ssdpDatagramsReceived"><strong>ssdpDatagramsReceived</strong></a>(self)</dt></dl>
<hr>
Properties defined here:<br>
<dl><dt><strong>host</strong></dt>
<dd><dl><dt><a name="-<em>get</em>"><strong><em>get</em></strong></a> = getHost(self)</dt></dl>
</dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-time"><strong>time</strong></a>(...)</dt><dd><tt><a href="#-time">time</a>()&nbsp;-&gt;&nbsp;floating&nbsp;point&nbsp;number<br>
&nbsp;<br>
Return&nbsp;the&nbsp;current&nbsp;time&nbsp;in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;Epoch.<br>
Fractions&nbsp;of&nbsp;a&nbsp;second&nbsp;may&nbsp;be&nbsp;present&nbsp;if&nbsp;the&nbsp;system&nbsp;clock&nbsp;provides&nbsp;them.</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>log</strong> = &lt;coherence.extern.logger.Logger instance&gt;<br>
<strong>reactor</strong> = &lt;twisted.internet.selectreactor.SelectReactor object&gt;</td></tr></table>
</body></html>
\ No newline at end of file
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module testservice</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>testservice</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/micxer/development/UPnT/upntest/testservice.py">/home/micxer/development/UPnT/upntest/testservice.py</a></font></td></tr></table>
<p><tt>#&nbsp;Licensed&nbsp;under&nbsp;the&nbsp;MIT&nbsp;license<br>
#&nbsp;<a href="http://opensource.org/licenses/mit-license.php">http://opensource.org/licenses/mit-license.php</a></tt></p>
</body></html>
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment