moving docs out of the base lib
This commit is contained in:
enus.linden
@@ -1,230 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>agent — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="agentdomain" href="agentdomain.html" />
|
||||
<link rel="prev" title="Modules" href="../modules.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agentdomain.html" title="agentdomain"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../modules.html" title="Modules"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="../modules.html"
|
||||
title="previous chapter">Modules</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="agentdomain.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">agentdomain</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/agent.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.agent">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">agent</span></tt><a class="headerlink" href="#module-pyogp.lib.base.agent" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.agent.Home">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.agent.</tt><tt class="descname">Home</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Home" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>contains the parameters describing an agent’s home location as returned in login_response[‘home’]</p>
|
||||
<p>initialize the Home object by parsing the data passed in</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.agent.Agent">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.agent.</tt><tt class="descname">Agent</tt><big>(</big><em>settings=None</em>, <em>firstname=''</em>, <em>lastname=''</em>, <em>password=''</em>, <em>agent_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The Agent class is a container for agent specific data.</p>
|
||||
<p>Example, of login via the agent class:
|
||||
Initialize the login class</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">Agent</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">login</span><span class="p">(</span><span class="s">'https://login.agni.lindenlab.com/cgi-bin/login.cgi'</span><span class="p">,</span> <span class="s">'firstname'</span><span class="p">,</span> <span class="s">'lastname'</span><span class="p">,</span> <span class="s">'secret'</span><span class="p">,</span> <span class="n">start_location</span> <span class="o">=</span> <span class="s">'last'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Sample implementations: examples/sample_agent_login.py
|
||||
Tests: tests/login.txt, tests/test_agent.py</p>
|
||||
<p>initialize this agent</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.Name">
|
||||
<tt class="descname">Name</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.Name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns a concatenated firstname + ‘ ‘ + lastname</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.instant_message">
|
||||
<tt class="descname">instant_message</tt><big>(</big><em>ToAgentID=None</em>, <em>Message=None</em>, <em>_ID=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.instant_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends an instant message to another avatar, wrapping Agent().send_ImprovedInstantMessage() with some handy defaults</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.login">
|
||||
<tt class="descname">login</tt><big>(</big><em>loginuri</em>, <em>firstname=None</em>, <em>lastname=None</em>, <em>password=None</em>, <em>login_params=None</em>, <em>start_location=None</em>, <em>handler=None</em>, <em>connect_region=True</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>login to a login endpoint using the Login() class</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.logout">
|
||||
<tt class="descname">logout</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.logout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>logs an agent out of the current region. calls Region()._kill_coroutines() for all child regions, and Region().logout() for the host region</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onAgentDataUpdate">
|
||||
<tt class="descname">onAgentDataUpdate</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onAgentDataUpdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received AgentDataUpdate messages which populates various Agent() attributes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onAgentGroupDataUpdate">
|
||||
<tt class="descname">onAgentGroupDataUpdate</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onAgentGroupDataUpdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received AgentGroupDataUpdate messages which updates stored group instances in the group_manager</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onAgentMovementComplete">
|
||||
<tt class="descname">onAgentMovementComplete</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onAgentMovementComplete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received AgentMovementComplete messages which populates various Agent() and Region() attributes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onAlertMessage">
|
||||
<tt class="descname">onAlertMessage</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onAlertMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received AlertMessage messages. logs and raises an event</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onChatFromSimulator">
|
||||
<tt class="descname">onChatFromSimulator</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onChatFromSimulator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received ChatFromSimulator messages which parses and fires a ChatReceived event. (not implemented</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onEnableSimulator">
|
||||
<tt class="descname">onEnableSimulator</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onEnableSimulator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received EnableSimulator messages. stores the region data for later connections</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onEstablishAgentCommunication">
|
||||
<tt class="descname">onEstablishAgentCommunication</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onEstablishAgentCommunication" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received EstablishAgentCommunication messages. try to enable the event queue for a neighboring region based on the data received</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onHealthMessage">
|
||||
<tt class="descname">onHealthMessage</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onHealthMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received HealthMessage messages which populates Agent().health</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.onImprovedInstantMessage">
|
||||
<tt class="descname">onImprovedInstantMessage</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.onImprovedInstantMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>callback handler for received ImprovedInstantMessage messages. much is passed in this message, and handling the data is only partially implemented</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.say">
|
||||
<tt class="descname">say</tt><big>(</big><em>Message</em>, <em>Type=1</em>, <em>Channel=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.say" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>queues a packet to send open chat via ChatFromViewer</p>
|
||||
<p>Channel: 0 is open chat
|
||||
Type: 0 = Whisper</p>
|
||||
<blockquote>
|
||||
1 = Say
|
||||
2 = Shout</blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.send_AgentDataUpdateRequest">
|
||||
<tt class="descname">send_AgentDataUpdateRequest</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.send_AgentDataUpdateRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>queues a packet requesting an agent data update</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.send_ImprovedInstantMessage">
|
||||
<tt class="descname">send_ImprovedInstantMessage</tt><big>(</big><em>AgentID=None</em>, <em>SessionID=None</em>, <em>FromGroup=None</em>, <em>ToAgentID=None</em>, <em>ParentEstateID=None</em>, <em>RegionID=None</em>, <em>Position=None</em>, <em>Offline=None</em>, <em>Dialog=None</em>, <em>_ID=None</em>, <em>Timestamp=None</em>, <em>FromAgentName=None</em>, <em>Message=None</em>, <em>BinaryBucket=None</em>, <em>AgentDataBlock={}</em>, <em>MessageBlockBlock={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.send_ImprovedInstantMessage" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends an instant message packet to ToAgentID. this is a multi-purpose message for inventory offer handling, im, group chat, and more</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agent.Agent.sigint_handler">
|
||||
<tt class="descname">sigint_handler</tt><big>(</big><em>signal</em>, <em>frame</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agent.Agent.sigint_handler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>catches terminal signals (Ctrl-C) to kill running client instances</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agentdomain.html" title="agentdomain"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../modules.html" title="Modules"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,153 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>agentdomain — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="agentmanager" href="agentmanager.html" />
|
||||
<link rel="prev" title="agent" href="agent.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agentmanager.html" title="agentmanager"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agent.html" title="agent"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="agent.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">agent</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="agentmanager.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">agentmanager</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/agentdomain.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.agentdomain">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">agentdomain</span></tt><a class="headerlink" href="#module-pyogp.lib.base.agentdomain" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.agentdomain.AgentDomain">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.agentdomain.</tt><tt class="descname">AgentDomain</tt><big>(</big><em>uri</em>, <em>restclient=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an agent domain endpoint</p>
|
||||
<p>initialize the agent domain endpoint</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentdomain.AgentDomain.eval_login_response">
|
||||
<tt class="descname">eval_login_response</tt><big>(</big><em>response</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.eval_login_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>parse the login uri response</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentdomain.AgentDomain.get_agentdomain_capabilities">
|
||||
<tt class="descname">get_agentdomain_capabilities</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.get_agentdomain_capabilities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>queries the region seed cap for capabilities</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentdomain.AgentDomain.login">
|
||||
<tt class="descname">login</tt><big>(</big><em>credentials</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>login to the agent domain</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentdomain.AgentDomain.parse_login_response">
|
||||
<tt class="descname">parse_login_response</tt><big>(</big><em>response</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.parse_login_response" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>parse the login uri response and returns deserialized data</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentdomain.AgentDomain.place_avatar">
|
||||
<tt class="descname">place_avatar</tt><big>(</big><em>region_uri</em>, <em>position=</em><span class="optional">[</span>, <em>117</em>, <em>73</em>, <em>21</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.place_avatar" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>handles the rez_avatar/place cap on the agent domain, populates some initial region attributes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentdomain.AgentDomain.post_to_loginuri">
|
||||
<tt class="descname">post_to_loginuri</tt><big>(</big><em>credentials</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentdomain.AgentDomain.post_to_loginuri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>post to login_uri and return response</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agentmanager.html" title="agentmanager"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agent.html" title="agent"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,154 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>agentmanager — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="appearance" href="appearance.html" />
|
||||
<link rel="prev" title="agentdomain" href="agentdomain.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="appearance.html" title="appearance"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agentdomain.html" title="agentdomain"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="agentdomain.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">agentdomain</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="appearance.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">appearance</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/agentmanager.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.agentmanager">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">agentmanager</span></tt><a class="headerlink" href="#module-pyogp.lib.base.agentmanager" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.agentmanager.AgentManager">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.agentmanager.</tt><tt class="descname">AgentManager</tt><big>(</big><em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentmanager.AgentManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a simple class to track multiple agents</p>
|
||||
<p>This class can perhaps begin to manage sessions in time.</p>
|
||||
<p>initialize the agent manager</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentmanager.AgentManager.get_active_agents">
|
||||
<tt class="descname">get_active_agents</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentmanager.AgentManager.get_active_agents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns a list of agents that are connected to a grid</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentmanager.AgentManager.has_agents_running">
|
||||
<tt class="descname">has_agents_running</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentmanager.AgentManager.has_agents_running" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns true if there is a client who’s running value = True</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentmanager.AgentManager.initialize">
|
||||
<tt class="descname">initialize</tt><big>(</big><em>agents</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentmanager.AgentManager.initialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>accept a list of Agent() instances, and store them in the agents attribute</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentmanager.AgentManager.login">
|
||||
<tt class="descname">login</tt><big>(</big><em>key</em>, <em>loginuri</em>, <em>start_location</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentmanager.AgentManager.login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>spawns a new agent via an eventlet coroutine</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentmanager.AgentManager.sigint_handler">
|
||||
<tt class="descname">sigint_handler</tt><big>(</big><em>signal</em>, <em>frame</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentmanager.AgentManager.sigint_handler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.agentmanager.AgentManager.store_agent">
|
||||
<tt class="descname">store_agent</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.agentmanager.AgentManager.store_agent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>adds an agent to the store</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="appearance.html" title="appearance"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agentdomain.html" title="agentdomain"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,130 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>appearance — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="callbacks" href="callbacks.html" />
|
||||
<link rel="prev" title="agentmanager" href="agentmanager.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="callbacks.html" title="callbacks"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agentmanager.html" title="agentmanager"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="agentmanager.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">agentmanager</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="callbacks.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">callbacks</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/appearance.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.appearance">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">appearance</span></tt><a class="headerlink" href="#module-pyogp.lib.base.appearance" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.appearance.Appearance">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.appearance.</tt><tt class="descname">Appearance</tt><big>(</big><em>settings=None</em>, <em>agent=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.appearance.Appearance" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The Appearance class handles appearance of an Agent() instance</p>
|
||||
<p>Sample implementations:
|
||||
Tests:</p>
|
||||
<p>initialize the appearance manager</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.appearance.Appearance.request_agent_wearables">
|
||||
<tt class="descname">request_agent_wearables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.appearance.Appearance.request_agent_wearables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>ask the simulator what the avatar is wearing</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="callbacks.html" title="callbacks"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="agentmanager.html" title="agentmanager"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,115 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>build_packet_templates — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="callbacks" href="callbacks.html" />
|
||||
<link rel="prev" title="appearance" href="appearance.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="callbacks.html" title="callbacks"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="appearance.html" title="appearance"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="appearance.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">appearance</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="callbacks.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">callbacks</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/build_packet_templates.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.utilities.build_packet_templates">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">build_packet_templates</span></tt><a class="headerlink" href="#module-pyogp.lib.base.utilities.build_packet_templates" title="Permalink to this headline">¶</a></h1>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="callbacks.html" title="callbacks"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="appearance.html" title="appearance"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,127 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>callbacks — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="caps" href="caps.html" />
|
||||
<link rel="prev" title="appearance" href="appearance.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="caps.html" title="caps"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="appearance.html" title="appearance"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="appearance.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">appearance</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="caps.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">caps</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/callbacks.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.utilities.callbacks">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">callbacks</span></tt><a class="headerlink" href="#module-pyogp.lib.base.utilities.callbacks" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.callbacks.Callbacks">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.callbacks.</tt><tt class="descname">Callbacks</tt><a class="headerlink" href="#pyogp.lib.base.utilities.callbacks.Callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>class containing handlers for parsing of event data</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.callbacks.Callbacks.onObjectUpdate">
|
||||
<tt class="descname">onObjectUpdate</tt><big>(</big><em>packet</em>, <em>objects</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.callbacks.Callbacks.onObjectUpdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="caps.html" title="caps"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="appearance.html" title="appearance"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,165 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>caps — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="circuit" href="circuit.html" />
|
||||
<link rel="prev" title="callbacks" href="callbacks.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="circuit.html" title="circuit"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="callbacks.html" title="callbacks"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="callbacks.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">callbacks</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="circuit.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">circuit</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/caps.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.caps">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">caps</span></tt><a class="headerlink" href="#module-pyogp.lib.base.caps" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.caps.Capability">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.caps.</tt><tt class="descname">Capability</tt><big>(</big><em>name</em>, <em>public_url</em>, <em>restclient=None</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.caps.Capability" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>models a capability
|
||||
A capability is a web resource which enables functionality for a client
|
||||
The seed capability is a special type, through which other capabilities
|
||||
are procured</p>
|
||||
<p>A capability in pyogp provides a GET and a POST method</p>
|
||||
<p>Sample implementations: region.py
|
||||
Tests: tests/caps.txt, tests/test_caps.py</p>
|
||||
<p>initialize the capability</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.caps.Capability.GET">
|
||||
<tt class="descname">GET</tt><big>(</big><em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.caps.Capability.GET" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>call this capability, return the parsed result</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.caps.Capability.POST">
|
||||
<tt class="descname">POST</tt><big>(</big><em>payload</em>, <em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.caps.Capability.POST" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>call this capability, return the parsed result</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.caps.SeedCapability">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.caps.</tt><tt class="descname">SeedCapability</tt><big>(</big><em>name</em>, <em>public_url</em>, <em>restclient=None</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.caps.SeedCapability" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a seed capability which is able to retrieve other capabilities</p>
|
||||
<p>initialize the capability</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.caps.SeedCapability.GET">
|
||||
<tt class="descname">GET</tt><big>(</big><em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.caps.SeedCapability.GET" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>call this capability, return the parsed result</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.caps.SeedCapability.POST">
|
||||
<tt class="descname">POST</tt><big>(</big><em>payload</em>, <em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.caps.SeedCapability.POST" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>call this capability, return the parsed result</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.caps.SeedCapability.get">
|
||||
<tt class="descname">get</tt><big>(</big><em>names=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.caps.SeedCapability.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>if this is a seed cap we can retrieve other caps here</p>
|
||||
<p>Note: changing post key from ‘caps’ to ‘capabilities’ for OGP spec updates in Draft 3
|
||||
see <a class="reference external" href="http://wiki.secondlife.com/wiki/OGP_Base_Draft_3#Seed_Capability_.28Resource_Class.29">http://wiki.secondlife.com/wiki/OGP_Base_Draft_3#Seed_Capability_.28Resource_Class.29</a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="circuit.html" title="circuit"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="callbacks.html" title="callbacks"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,210 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>circuit — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="data_packer" href="data_packer.html" />
|
||||
<link rel="prev" title="caps" href="caps.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="data_packer.html" title="data_packer"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="caps.html" title="caps"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="caps.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">caps</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="data_packer.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">data_packer</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/circuit.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.circuit">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">circuit</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.circuit" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.circuit.CircuitManager">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.circuit.</tt><tt class="descname">CircuitManager</tt><a class="headerlink" href="#pyogp.lib.base.message.circuit.CircuitManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Manages a collection of circuits and provides some higher-level
|
||||
functionality to do so.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.CircuitManager.add_circuit">
|
||||
<tt class="descname">add_circuit</tt><big>(</big><em>host</em>, <em>packet_in_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.CircuitManager.add_circuit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.CircuitManager.get_circuit">
|
||||
<tt class="descname">get_circuit</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.CircuitManager.get_circuit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.CircuitManager.get_unacked_circuits">
|
||||
<tt class="descname">get_unacked_circuits</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.CircuitManager.get_unacked_circuits" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.CircuitManager.is_circuit_alive">
|
||||
<tt class="descname">is_circuit_alive</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.CircuitManager.is_circuit_alive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.CircuitManager.remove_circuit_data">
|
||||
<tt class="descname">remove_circuit_data</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.CircuitManager.remove_circuit_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.circuit.PackFlags">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.circuit.</tt><tt class="descname">PackFlags</tt><a class="headerlink" href="#pyogp.lib.base.message.circuit.PackFlags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.circuit.Host">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.circuit.</tt><tt class="descname">Host</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Host" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.Host.is_ok">
|
||||
<tt class="descname">is_ok</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Host.is_ok" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.Host.set_host_by_name">
|
||||
<tt class="descname">set_host_by_name</tt><big>(</big><em>hostname</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Host.set_host_by_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.circuit.Circuit">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.circuit.</tt><tt class="descname">Circuit</tt><big>(</big><em>host</em>, <em>pack_in_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Circuit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This is used to keep track of a given circuit. It keeps statistics
|
||||
as well as circuit information.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.Circuit.ack_reliable_packet">
|
||||
<tt class="descname">ack_reliable_packet</tt><big>(</big><em>packet_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Circuit.ack_reliable_packet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.Circuit.add_reliable_packet">
|
||||
<tt class="descname">add_reliable_packet</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Circuit.add_reliable_packet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>add a packet that we want to be acked
|
||||
(want an incoming ack)</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.Circuit.collect_ack">
|
||||
<tt class="descname">collect_ack</tt><big>(</big><em>packet_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Circuit.collect_ack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>set a packet_id that this circuit needs to eventually ack
|
||||
(need to send ack out)</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.Circuit.handle_packet">
|
||||
<tt class="descname">handle_packet</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Circuit.handle_packet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.Circuit.next_packet_id">
|
||||
<tt class="descname">next_packet_id</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Circuit.next_packet_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.circuit.Circuit.prepare_packet">
|
||||
<tt class="descname">prepare_packet</tt><big>(</big><em>packet</em>, <em>flag=0</em>, <em>retries=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.circuit.Circuit.prepare_packet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="data_packer.html" title="data_packer"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="caps.html" title="caps"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,144 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>data_packer — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="data_unpacker" href="data_unpacker.html" />
|
||||
<link rel="prev" title="circuit" href="circuit.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="data_unpacker.html" title="data_unpacker"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="circuit.html" title="circuit"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="circuit.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">circuit</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="data_unpacker.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">data_unpacker</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/data_packer.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.data_packer">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">data_packer</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.data_packer" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.data_packer.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.data_packer.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.data_packer.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.data_packer.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.data_packer.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.data_packer.EndianType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.data_packer.</tt><tt class="descname">EndianType</tt><a class="headerlink" href="#pyogp.lib.base.message.data_packer.EndianType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.data_packer.DataPacker">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.data_packer.</tt><tt class="descname">DataPacker</tt><a class="headerlink" href="#pyogp.lib.base.message.data_packer.DataPacker" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.data_packer.DataPacker.pack_data">
|
||||
<tt class="descname">pack_data</tt><big>(</big><em>data</em>, <em>data_type</em>, <em>endian_type=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.data_packer.DataPacker.pack_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="data_unpacker.html" title="data_unpacker"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="circuit.html" title="circuit"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,144 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>data_unpacker — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="datatypes" href="datatypes.html" />
|
||||
<link rel="prev" title="data_packer" href="data_packer.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="datatypes.html" title="datatypes"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="data_packer.html" title="data_packer"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="data_packer.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">data_packer</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="datatypes.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">datatypes</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/data_unpacker.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.data_unpacker">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">data_unpacker</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.data_unpacker" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.data_unpacker.EndianType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.data_unpacker.</tt><tt class="descname">EndianType</tt><a class="headerlink" href="#pyogp.lib.base.message.data_unpacker.EndianType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.data_unpacker.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.data_unpacker.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.data_unpacker.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.data_unpacker.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.data_unpacker.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.data_unpacker.DataUnpacker">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.data_unpacker.</tt><tt class="descname">DataUnpacker</tt><a class="headerlink" href="#pyogp.lib.base.message.data_unpacker.DataUnpacker" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.data_unpacker.DataUnpacker.unpack_data">
|
||||
<tt class="descname">unpack_data</tt><big>(</big><em>data</em>, <em>data_type</em>, <em>start_index=-1</em>, <em>var_size=-1</em>, <em>endian_type=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.data_unpacker.DataUnpacker.unpack_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="datatypes.html" title="datatypes"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="data_packer.html" title="data_packer"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,188 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>datatypes — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="enums" href="enums.html" />
|
||||
<link rel="prev" title="data_unpacker" href="data_unpacker.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="enums.html" title="enums"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="data_unpacker.html" title="data_unpacker"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="data_unpacker.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">data_unpacker</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="enums.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">enums</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/datatypes.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.datatypes">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">datatypes</span></tt><a class="headerlink" href="#module-pyogp.lib.base.datatypes" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.datatypes.Quaternion">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.datatypes.</tt><tt class="descname">Quaternion</tt><big>(</big><em>bytes=None</em>, <em>offset=0</em>, <em>X=0.0</em>, <em>Y=0.0</em>, <em>Z=0.0</em>, <em>W=0.0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.Quaternion" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>represents a quaternion as a tuple</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.Quaternion.data">
|
||||
<tt class="descname">data</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.Quaternion.data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.Quaternion.get_bytes">
|
||||
<tt class="descname">get_bytes</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.Quaternion.get_bytes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>get bytes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.Quaternion.unpack_from_bytes">
|
||||
<tt class="descname">unpack_from_bytes</tt><big>(</big><em>bytes</em>, <em>offset</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.Quaternion.unpack_from_bytes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>unpack floats from binary</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.datatypes.Vector3">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.datatypes.</tt><tt class="descname">Vector3</tt><big>(</big><em>bytes=None</em>, <em>offset=0</em>, <em>X=0.0</em>, <em>Y=0.0</em>, <em>Z=0.0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.Vector3" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>represents a vector as a tuple</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.Vector3.data">
|
||||
<tt class="descname">data</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.Vector3.data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.Vector3.get_bytes">
|
||||
<tt class="descname">get_bytes</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.Vector3.get_bytes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>get bytes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.Vector3.unpack_from_bytes">
|
||||
<tt class="descname">unpack_from_bytes</tt><big>(</big><em>bytes</em>, <em>offset</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.Vector3.unpack_from_bytes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>unpack floats from binary</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.datatypes.UUID">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.datatypes.</tt><tt class="descname">UUID</tt><big>(</big><em>bytes=None</em>, <em>offset=0</em>, <em>string='00000000-0000-0000-0000-000000000000'</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.UUID" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>represents a uuid as, well, a uuid</p>
|
||||
<p>inbound LLUUID data from packets is already UUID(), they are
|
||||
already the same ‘datatype’</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.UUID.data">
|
||||
<tt class="descname">data</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.UUID.data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>represent a uuid as, well, a uuid</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.UUID.get_bytes">
|
||||
<tt class="descname">get_bytes</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.UUID.get_bytes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>get bytes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.UUID.random">
|
||||
<tt class="descname">random</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.UUID.random" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.datatypes.UUID.unpack_from_bytes">
|
||||
<tt class="descname">unpack_from_bytes</tt><big>(</big><em>bytes</em>, <em>offset</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.datatypes.UUID.unpack_from_bytes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>unpack uuid from binary</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="enums.html" title="enums"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="data_unpacker.html" title="data_unpacker"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,145 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>enums — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="event_queue" href="event_queue.html" />
|
||||
<link rel="prev" title="datatypes" href="datatypes.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="event_queue.html" title="event_queue"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="datatypes.html" title="datatypes"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="datatypes.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">datatypes</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="event_queue.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">event_queue</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/enums.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.utilities.enums">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">enums</span></tt><a class="headerlink" href="#module-pyogp.lib.base.utilities.enums" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.enums.CompressedUpdateFlags">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.enums.</tt><tt class="descname">CompressedUpdateFlags</tt><a class="headerlink" href="#pyogp.lib.base.utilities.enums.CompressedUpdateFlags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>map of ObjectData.Flags</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.enums.InventoryType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.enums.</tt><tt class="descname">InventoryType</tt><a class="headerlink" href="#pyogp.lib.base.utilities.enums.InventoryType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>mappings for inventory asset type</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.enums.PCode">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.enums.</tt><tt class="descname">PCode</tt><a class="headerlink" href="#pyogp.lib.base.utilities.enums.PCode" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>classifying the PCode of objects</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.enums.ImprovedIMDialogue">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.enums.</tt><tt class="descname">ImprovedIMDialogue</tt><a class="headerlink" href="#pyogp.lib.base.utilities.enums.ImprovedIMDialogue" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>mappings for the values sent in an ImprovedInstantMessage packet</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.enums.ExtraParam">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.enums.</tt><tt class="descname">ExtraParam</tt><a class="headerlink" href="#pyogp.lib.base.utilities.enums.ExtraParam" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>extended Object attributes buried in some packets</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="event_queue.html" title="event_queue"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="datatypes.html" title="datatypes"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,181 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>event_queue — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="event_system" href="event_system.html" />
|
||||
<link rel="prev" title="enums" href="enums.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="event_system.html" title="event_system"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="enums.html" title="enums"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="enums.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">enums</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="event_system.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">event_system</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/event_queue.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.event_queue">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">event_queue</span></tt><a class="headerlink" href="#module-pyogp.lib.base.event_queue" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueClient">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.event_queue.</tt><tt class="descname">EventQueueClient</tt><big>(</big><em>capability=None</em>, <em>settings=None</em>, <em>packet_handler=None</em>, <em>region=None</em>, <em>event_queue_handler=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>handles an event queue of either an agent domain or a simulator</p>
|
||||
<p>Initialize the event queue client class
|
||||
>>> client = EventQueueClient()</p>
|
||||
<p>The event queue client requires an event queue capability
|
||||
>>> from pyogp.lib.base.caps import Capability
|
||||
>>> cap = Capability(‘EventQueue’, <a class="reference external" href="http://localhost:12345/cap">http://localhost:12345/cap</a>)</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">event_queue</span> <span class="o">=</span> <span class="n">EventQueueClient</span><span class="p">(</span><span class="n">cap</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">event_queue</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Sample implementations: region.py
|
||||
Tests: tests/test_event_queue.py</p>
|
||||
<p>set up the event queue attributes</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueClient.start">
|
||||
<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueClient.start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueClient.stop">
|
||||
<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueClient.stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueHandler">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.event_queue.</tt><tt class="descname">EventQueueHandler</tt><big>(</big><em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>general class handling individual packets</p>
|
||||
<p>i do nothing</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueHandler.is_packet_handled">
|
||||
<tt class="descname">is_packet_handled</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueHandler.is_packet_handled" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>if the data is being monitored, return True, otherwise, return False</p>
|
||||
<p>this can allow us to skip parsing inbound packets if no one is watching a particular one</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueReceivedNotifier">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.event_queue.</tt><tt class="descname">EventQueueReceivedNotifier</tt><big>(</big><em>name</em>, <em>settings</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueReceivedNotifier" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>received TestMessage packet</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueReceivedNotifier.received">
|
||||
<tt class="descname">received</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueReceivedNotifier.received" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueReceivedNotifier.subscribe">
|
||||
<tt class="descname">subscribe</tt><big>(</big><em>*args</em>, <em>**kwdargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueReceivedNotifier.subscribe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_queue.EventQueueReceivedNotifier.unsubscribe">
|
||||
<tt class="descname">unsubscribe</tt><big>(</big><em>*args</em>, <em>**kwdargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_queue.EventQueueReceivedNotifier.unsubscribe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="event_system.html" title="event_system"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="enums.html" title="enums"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,151 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>event_system — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="events" href="events.html" />
|
||||
<link rel="prev" title="event_queue" href="event_queue.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="events.html" title="events"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="event_queue.html" title="event_queue"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="event_queue.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">event_queue</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="events.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">events</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/event_system.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.event_system">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">event_system</span></tt><a class="headerlink" href="#module-pyogp.lib.base.event_system" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.event_system.EventsHandler">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.event_system.</tt><tt class="descname">EventsHandler</tt><big>(</big><em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.EventsHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>general class handling individual events</p>
|
||||
<p>initialize the EventsHandler</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_system.EventsHandler.is_event_handled">
|
||||
<tt class="descname">is_event_handled</tt><big>(</big><em>event_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.EventsHandler.is_event_handled" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>if the event is being monitored, return True, otherwise, return False</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.event_system.EventNotifier">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.event_system.</tt><tt class="descname">EventNotifier</tt><big>(</big><em>event_name</em>, <em>settings</em>, <em>timeout=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.EventNotifier" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>access points for subscribing to application wide events. timeout = 0 for no timeout</p>
|
||||
<p>initialize an event notifier by name, with an optional timeout</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_system.EventNotifier.received">
|
||||
<tt class="descname">received</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.EventNotifier.received" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>notifies subscribers about an event firing and passes along the data</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_system.EventNotifier.subscribe">
|
||||
<tt class="descname">subscribe</tt><big>(</big><em>*args</em>, <em>**kwdargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.EventNotifier.subscribe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>register a callback handler for a specific event, starting the timer if != 0, otherwise it will watch until forced to unsubscribe by the caller</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.event_system.EventNotifier.unsubscribe">
|
||||
<tt class="descname">unsubscribe</tt><big>(</big><em>*args</em>, <em>**kwdargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.EventNotifier.unsubscribe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>stop watching this event</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="events.html" title="events"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="event_queue.html" title="event_queue"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,152 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>events — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="exc" href="exc.html" />
|
||||
<link rel="prev" title="event_system" href="event_system.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="exc.html" title="exc"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="event_system.html" title="event_system"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="event_system.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">event_system</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="exc.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">exc</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/events.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.utilities.events">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">events</span></tt><a class="headerlink" href="#module-pyogp.lib.base.utilities.events" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.events.Event">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.events.</tt><tt class="descname">Event</tt><a class="headerlink" href="#pyogp.lib.base.utilities.events.Event" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an object containing data which will be passed out to all subscribers</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.events.Event.clearSubscribers">
|
||||
<tt class="descname">clearSubscribers</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.events.Event.clearSubscribers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.events.Event.getSubscriberCount">
|
||||
<tt class="descname">getSubscriberCount</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.events.Event.getSubscriberCount" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.events.Event.getSubscribers">
|
||||
<tt class="descname">getSubscribers</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.events.Event.getSubscribers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.events.Event.notify">
|
||||
<tt class="descname">notify</tt><big>(</big><em>args</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.events.Event.notify" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.events.Event.subscribe">
|
||||
<tt class="descname">subscribe</tt><big>(</big><em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.events.Event.subscribe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>establish the subscribers (handlers) to this event</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.events.Event.unsubscribe">
|
||||
<tt class="descname">unsubscribe</tt><big>(</big><em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.events.Event.unsubscribe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>remove the subscriber (handler) to this event</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="exc.html" title="exc"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="event_system.html" title="event_system"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,671 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>exc — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="factory" href="factory.html" />
|
||||
<link rel="prev" title="events" href="events.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="factory.html" title="factory"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="events.html" title="events"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="events.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">events</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="factory.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">factory</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/exc.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.exc">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">exc</span></tt><a class="headerlink" href="#module-pyogp.lib.base.exc" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.MessageDeserializationError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">MessageDeserializationError</tt><big>(</big><em>label=''</em>, <em>reason=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.MessageDeserializationError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>problem deserializing packet data</p>
|
||||
<p>stores the label and reason in <tt class="docutils literal"><span class="pre">label</span></tt> and <tt class="docutils literal"><span class="pre">reason</span></tt> attributes</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageDeserializationError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageDeserializationError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageDeserializationError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageDeserializationError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.AgentDomainError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">AgentDomainError</tt><a class="headerlink" href="#pyogp.lib.base.exc.AgentDomainError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>base exception for all errors which can occur on an agent domain</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.AgentDomainError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.AgentDomainError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.AgentDomainError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.AgentDomainError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.UserNotFound">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">UserNotFound</tt><big>(</big><em>credentials=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.UserNotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>user couldn’t be found</p>
|
||||
<p>This exception stores the credentials used inside a <tt class="docutils literal"><span class="pre">credentials</span></tt> attribute</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.UserNotFound.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.UserNotFound.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.UserNotFound.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.UserNotFound.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.ResourceNotFound">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">ResourceNotFound</tt><big>(</big><em>url=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.ResourceNotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>raised if a resource couldn’t be found</p>
|
||||
<p>the URL to that resource is stored inside a <tt class="docutils literal"><span class="pre">url</span></tt> attribute.</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.ResourceNotFound.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.ResourceNotFound.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.ResourceNotFound.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.ResourceNotFound.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.DataParsingError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">DataParsingError</tt><big>(</big><em>error=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.DataParsingError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an error raised data parsing fails</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DataParsingError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.DataParsingError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DataParsingError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.DataParsingError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.AgentError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">AgentError</tt><a class="headerlink" href="#pyogp.lib.base.exc.AgentError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>general Agent exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.AgentError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.AgentError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.AgentError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.AgentError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.MessageSerializationError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">MessageSerializationError</tt><big>(</big><em>label=''</em>, <em>reason=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.MessageSerializationError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>problem serializing packet data</p>
|
||||
<p>stores the label and reason in <tt class="docutils literal"><span class="pre">label</span></tt> and <tt class="docutils literal"><span class="pre">reason</span></tt> attributes</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageSerializationError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageSerializationError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageSerializationError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageSerializationError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.DeserializationError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">DeserializationError</tt><a class="headerlink" href="#pyogp.lib.base.exc.DeserializationError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>deserialization related exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DeserializationError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.DeserializationError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DeserializationError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.DeserializationError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.RegionSeedCapNotAvailable">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">RegionSeedCapNotAvailable</tt><big>(</big><em>reason=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.RegionSeedCapNotAvailable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an error raised in case a user couldn’t be authorized</p>
|
||||
<p>stores the cap used inside a <tt class="docutils literal"><span class="pre">cap</span></tt> attribute</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.RegionSeedCapNotAvailable.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionSeedCapNotAvailable.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.RegionSeedCapNotAvailable.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionSeedCapNotAvailable.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.RegionCapNotAvailable">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">RegionCapNotAvailable</tt><big>(</big><em>cap=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.RegionCapNotAvailable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an error raised in case a user couldn’t be authorized</p>
|
||||
<p>stores the cap used inside a <tt class="docutils literal"><span class="pre">cap</span></tt> attribute</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.RegionCapNotAvailable.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionCapNotAvailable.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.RegionCapNotAvailable.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionCapNotAvailable.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.MessageTemplateParsingError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">MessageTemplateParsingError</tt><big>(</big><em>context=''</em>, <em>template=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.MessageTemplateParsingError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>message template parsing error</p>
|
||||
<p>stores the context in a <tt class="docutils literal"><span class="pre">context</span></tt> attribute</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageTemplateParsingError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageTemplateParsingError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageTemplateParsingError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageTemplateParsingError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.UserNotAuthorized">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">UserNotAuthorized</tt><big>(</big><em>credentials=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.UserNotAuthorized" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an error raised in case a user couldn’t be authorized</p>
|
||||
<p>stores the credentials used inside a <tt class="docutils literal"><span class="pre">credentials</span></tt> attribute</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.UserNotAuthorized.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.UserNotAuthorized.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.UserNotAuthorized.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.UserNotAuthorized.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.DataUnpackingError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">DataUnpackingError</tt><big>(</big><em>data=''</em>, <em>reason=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.DataUnpackingError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>problem deserializing packet data</p>
|
||||
<p>stores the label and reason in <tt class="docutils literal"><span class="pre">label</span></tt> and <tt class="docutils literal"><span class="pre">reason</span></tt> attributes</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DataUnpackingError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.DataUnpackingError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DataUnpackingError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.DataUnpackingError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.CircuitNotFound">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">CircuitNotFound</tt><big>(</big><em>host=''</em>, <em>reason=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.CircuitNotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>circuit to host could not be found</p>
|
||||
<p>stores the host missing a circuit in a <tt class="docutils literal"><span class="pre">host</span></tt> attribute</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.CircuitNotFound.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.CircuitNotFound.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.CircuitNotFound.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.CircuitNotFound.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.ResourceError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">ResourceError</tt><big>(</big><em>url=''</em>, <em>code=''</em>, <em>message=''</em>, <em>body=''</em>, <em>method='GET'</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.ResourceError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>raised if any other error occurred (usually a 500)</p>
|
||||
<p>contains <tt class="docutils literal"><span class="pre">url</span></tt> to the resource and <tt class="docutils literal"><span class="pre">code</span></tt> and <tt class="docutils literal"><span class="pre">message</span></tt> and <tt class="docutils literal"><span class="pre">body</span></tt></p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.ResourceError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.ResourceError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.ResourceError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.ResourceError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.CredentialDeserializerNotFound">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">CredentialDeserializerNotFound</tt><big>(</big><em>payload=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.CredentialDeserializerNotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>raised if a deserializer for a certain content type couldn’t be found</p>
|
||||
<p>stores the content type inside a <tt class="docutils literal"><span class="pre">content_type</span></tt> attribute.</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.CredentialDeserializerNotFound.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.CredentialDeserializerNotFound.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.CredentialDeserializerNotFound.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.CredentialDeserializerNotFound.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.NotImplemented">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">NotImplemented</tt><big>(</big><em>error=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.NotImplemented" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an error raised when method is not implemented</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.NotImplemented.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.NotImplemented.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.NotImplemented.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.NotImplemented.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.MessageSystemError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">MessageSystemError</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageSystemError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>message system related exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageSystemError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageSystemError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageSystemError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageSystemError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.DeserializerNotFound">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">DeserializerNotFound</tt><big>(</big><em>content_type=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.DeserializerNotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>raised if a deserializer for a certain content type couldn’t be found</p>
|
||||
<p>stores the content type inside a <tt class="docutils literal"><span class="pre">content_type</span></tt> attribute.</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DeserializerNotFound.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.DeserializerNotFound.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DeserializerNotFound.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.DeserializerNotFound.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.LoginError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">LoginError</tt><big>(</big><em>error</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.LoginError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>raised if there is an error in login</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.LoginError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.LoginError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.LoginError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.LoginError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.SerializationError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">SerializationError</tt><a class="headerlink" href="#pyogp.lib.base.exc.SerializationError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>serialization related exceptions</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.SerializationError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.SerializationError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.SerializationError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.SerializationError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.ParseStartLocError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">ParseStartLocError</tt><big>(</big><em>error</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.ParseStartLocError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>raised when the is an error in parsing the user specified start location</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.ParseStartLocError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.ParseStartLocError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.ParseStartLocError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.ParseStartLocError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.RegionDomainError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">RegionDomainError</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionDomainError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>base exception for all errors which can occur on an region domain</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.RegionDomainError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionDomainError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.RegionDomainError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionDomainError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.Error">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">Error</tt><a class="headerlink" href="#pyogp.lib.base.exc.Error" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>base exception for all pyogp related exceptions</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.Error.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.Error.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.Error.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.Error.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.HTTPError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">HTTPError</tt><big>(</big><em>code</em>, <em>msg</em>, <em>fp</em>, <em>details=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.HTTPError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an HTTP error</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.HTTPError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.HTTPError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.HTTPError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.HTTPError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.DeserializationFailed">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">DeserializationFailed</tt><big>(</big><em>payload=''</em>, <em>reason=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.DeserializationFailed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>raised if a deserializer couldn’t deserialize a payload</p>
|
||||
<p>stores the payload inside a <tt class="docutils literal"><span class="pre">payload</span></tt> attribute and the error message
|
||||
inside a <tt class="docutils literal"><span class="pre">reason</span></tt> attribute.</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DeserializationFailed.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.DeserializationFailed.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.DeserializationFailed.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.DeserializationFailed.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.RegionMessageError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">RegionMessageError</tt><big>(</big><em>region=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.RegionMessageError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an error raised when a region does not have a connection
|
||||
over which it can send UDP messages</p>
|
||||
<p>accepts a region object as an attribute</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.RegionMessageError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionMessageError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.RegionMessageError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.RegionMessageError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.UserRezFailed">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">UserRezFailed</tt><big>(</big><em>region=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.UserRezFailed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an error raised in case a user couldn’t rez on a sim</p>
|
||||
<p>stores the region used inside a <tt class="docutils literal"><span class="pre">region</span></tt> attribute</p>
|
||||
<p>initialize this exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.UserRezFailed.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.UserRezFailed.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.UserRezFailed.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.UserRezFailed.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.MessageTemplateNotFound">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">MessageTemplateNotFound</tt><big>(</big><em>context=''</em>, <em>template=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.MessageTemplateNotFound" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>message template file not found</p>
|
||||
<p>stores the context in a <tt class="docutils literal"><span class="pre">context</span></tt> attribute</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageTemplateNotFound.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageTemplateNotFound.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageTemplateNotFound.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageTemplateNotFound.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.NetworkError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">NetworkError</tt><a class="headerlink" href="#pyogp.lib.base.exc.NetworkError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>general network exception</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.NetworkError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.NetworkError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.NetworkError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.NetworkError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.exc.MessageBuildingError">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.exc.</tt><tt class="descname">MessageBuildingError</tt><big>(</big><em>label=''</em>, <em>reason=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.exc.MessageBuildingError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>problem serializing packet data</p>
|
||||
<p>stores the label and reason in <tt class="docutils literal"><span class="pre">label</span></tt> and <tt class="docutils literal"><span class="pre">reason</span></tt> attributes</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageBuildingError.args">
|
||||
<tt class="descname">args</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageBuildingError.args" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.exc.MessageBuildingError.message">
|
||||
<tt class="descname">message</tt><a class="headerlink" href="#pyogp.lib.base.exc.MessageBuildingError.message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>exception message</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="factory.html" title="factory"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="events.html" title="events"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,139 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>factory — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="groups" href="groups.html" />
|
||||
<link rel="prev" title="exc" href="exc.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="groups.html" title="groups"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="exc.html" title="exc"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="exc.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">exc</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="groups.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">groups</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/factory.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.factory">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">factory</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.factory" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.factory.MessageFactory">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.factory.</tt><tt class="descname">MessageFactory</tt><a class="headerlink" href="#pyogp.lib.base.message.factory.MessageFactory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.factory.MessageFactory.add_data">
|
||||
<tt class="descname">add_data</tt><big>(</big><em>var_name</em>, <em>data</em>, <em>data_type</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.factory.MessageFactory.add_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>the data type is passed in to make sure that the programmer is aware of
|
||||
what type (and therefore size) of the data that is being passed in.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.factory.MessageFactory.new_message">
|
||||
<tt class="descname">new_message</tt><big>(</big><em>message_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.factory.MessageFactory.new_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Creates a new packet where data can be added to it. Note, the variables
|
||||
are added when they are used, or data added to them, so to make sure
|
||||
no bad data is sent over the network.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.factory.MessageFactory.next_block">
|
||||
<tt class="descname">next_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.factory.MessageFactory.next_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="groups.html" title="groups"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="exc.html" title="exc"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,286 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>groups — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="helpers" href="helpers.html" />
|
||||
<link rel="prev" title="factory" href="factory.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="helpers.html" title="helpers"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="factory.html" title="factory"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="factory.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">factory</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="helpers.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">helpers</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/groups.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.groups">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">groups</span></tt><a class="headerlink" href="#module-pyogp.lib.base.groups" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.groups.ChatterBoxSessionEventReply_Message">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.groups.</tt><tt class="descname">ChatterBoxSessionEventReply_Message</tt><big>(</big><em>message_data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.ChatterBoxSessionEventReply_Message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.groups.Group">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.groups.</tt><tt class="descname">Group</tt><big>(</big><em>AcceptNotices=None</em>, <em>GroupPowers=None</em>, <em>GroupID=None</em>, <em>GroupName=None</em>, <em>ListInProfile=None</em>, <em>Contribution=None</em>, <em>GroupInsigniaID=None</em>, <em>agent=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.Group" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>representation of a group</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.Group.activate_group">
|
||||
<tt class="descname">activate_group</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.Group.activate_group" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>set this group as active</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.Group.chat">
|
||||
<tt class="descname">chat</tt><big>(</big><em>Message=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.Group.chat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>sends an instant message to another avatar</p>
|
||||
<p>wraps send_ImprovedInstantMessage with some handy defaults</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.Group.handle_inbound_chat">
|
||||
<tt class="descname">handle_inbound_chat</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.Group.handle_inbound_chat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.Group.request_join_group_chat">
|
||||
<tt class="descname">request_join_group_chat</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.Group.request_join_group_chat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends an ImprovedInstantMessage packet with the atributes necessary to join a group chat</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.Group.update_properties">
|
||||
<tt class="descname">update_properties</tt><big>(</big><em>properties</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.Group.update_properties" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>takes a dictionary of attribute:value and makes it so</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.groups.ChatterBoxSessionAgentListUpdates_Message">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.groups.</tt><tt class="descname">ChatterBoxSessionAgentListUpdates_Message</tt><big>(</big><em>message_data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.ChatterBoxSessionAgentListUpdates_Message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>incomplete implementation</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.groups.MockChatInterface">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.groups.</tt><tt class="descname">MockChatInterface</tt><big>(</big><em>agent</em>, <em>chat_handler</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.MockChatInterface" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a super simple chat interface for testing</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.MockChatInterface.data_watcher">
|
||||
<tt class="descname">data_watcher</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.MockChatInterface.data_watcher" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.MockChatInterface.get_and_send_input">
|
||||
<tt class="descname">get_and_send_input</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.MockChatInterface.get_and_send_input" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.MockChatInterface.start">
|
||||
<tt class="descname">start</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.MockChatInterface.start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.groups.ChatterBoxSessionStartReply_Message">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.groups.</tt><tt class="descname">ChatterBoxSessionStartReply_Message</tt><big>(</big><em>message_data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.ChatterBoxSessionStartReply_Message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>incomplete implementation</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.groups.</tt><tt class="descname">GroupManager</tt><big>(</big><em>agent</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a storage bin for groups</p>
|
||||
<p>also, a functional area for group creation operations</p>
|
||||
<p>initialize the group manager</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.activate_group">
|
||||
<tt class="descname">activate_group</tt><big>(</big><em>group_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.activate_group" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>set a particular group as active</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.create_group">
|
||||
<tt class="descname">create_group</tt><big>(</big><em>AgentID=None</em>, <em>SessionID=None</em>, <em>Name=None</em>, <em>Charter=''</em>, <em>ShowInList=True</em>, <em>InsigniaID=00000000-0000-0000-0000-000000000000</em>, <em>MembershipFee=0</em>, <em>OpenEnrollment=False</em>, <em>AllowPublish=False</em>, <em>MaturePublish=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.create_group" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>sends a message to the agent’s current region requesting to create a group</p>
|
||||
<p>enables a callback (which should be unsubscribed from once we get a response)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.get_group">
|
||||
<tt class="descname">get_group</tt><big>(</big><em>GroupID=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.get_group" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>searches the store and returns group if stored, None otherwise</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.handle_group_chat">
|
||||
<tt class="descname">handle_group_chat</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.handle_group_chat" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>process a ChatterBoxInvitation_Message instance</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.join_group">
|
||||
<tt class="descname">join_group</tt><big>(</big><em>group_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.join_group" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends a JoinGroupRequest packet for the specified uuid</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.onAgentGroupDataUpdate">
|
||||
<tt class="descname">onAgentGroupDataUpdate</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.onAgentGroupDataUpdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>deal with the data that comes in over the event queue</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.onChatterBoxInvitation_Message">
|
||||
<tt class="descname">onChatterBoxInvitation_Message</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.onChatterBoxInvitation_Message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>handle a group chat message from the event queue</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.onChatterBoxSessionAgentListUpdates">
|
||||
<tt class="descname">onChatterBoxSessionAgentListUpdates</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.onChatterBoxSessionAgentListUpdates" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>parse teh response to a request to join a group chat and propagate data out</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.onChatterBoxSessionEventReply">
|
||||
<tt class="descname">onChatterBoxSessionEventReply</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.onChatterBoxSessionEventReply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>handle a response from the simulator re: a message we sent to a group chat</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.onChatterBoxSessionStartReply">
|
||||
<tt class="descname">onChatterBoxSessionStartReply</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.onChatterBoxSessionStartReply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.onCreateGroupReply">
|
||||
<tt class="descname">onCreateGroupReply</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.onCreateGroupReply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>when we get a CreateGroupReply packet, log Success, and if True, request the group details. remove the callback in any case</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.onJoinGroupReply">
|
||||
<tt class="descname">onJoinGroupReply</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.onJoinGroupReply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>the simulator tells us if joining a group was a success.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.store_group">
|
||||
<tt class="descname">store_group</tt><big>(</big><em>_group</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.store_group" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>append to or replace a group in self.group_store</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.update_group">
|
||||
<tt class="descname">update_group</tt><big>(</big><em>group_data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.update_group" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>accepts a dictionary of group data and creates/updates a group</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.update_group_by_name">
|
||||
<tt class="descname">update_group_by_name</tt><big>(</big><em>group_data</em>, <em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.update_group_by_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>accepts a dictionary of group data and creates/updates a group</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.groups.GroupManager.update_group_by_session_id">
|
||||
<tt class="descname">update_group_by_session_id</tt><big>(</big><em>group_data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.GroupManager.update_group_by_session_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>accepts a dictionary of group data and creates/updates a group</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.groups.ChatterBoxInvitation_Message">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.groups.</tt><tt class="descname">ChatterBoxInvitation_Message</tt><big>(</big><em>session_name=None</em>, <em>from_name=None</em>, <em>session_id=None</em>, <em>_type=None</em>, <em>region_id=None</em>, <em>offline=None</em>, <em>timestamp=None</em>, <em>ttl=None</em>, <em>to_id=None</em>, <em>source=None</em>, <em>from_group=None</em>, <em>position=None</em>, <em>parent_estate_id=None</em>, <em>message=None</em>, <em>binary_bucket=None</em>, <em>_id=None</em>, <em>god_level=None</em>, <em>limited_to_estate=None</em>, <em>check_estate=None</em>, <em>agent_id=None</em>, <em>from_id=None</em>, <em>ChatterBoxInvitation_Data=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.groups.ChatterBoxInvitation_Message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>a group chat message sent over the event queue</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="helpers.html" title="helpers"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="factory.html" title="factory"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,276 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>helpers — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="inventory" href="inventory.html" />
|
||||
<link rel="prev" title="groups" href="groups.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="inventory.html" title="inventory"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="groups.html" title="groups"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="groups.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">groups</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="inventory.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">inventory</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/helpers.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.utilities.helpers">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">helpers</span></tt><a class="headerlink" href="#module-pyogp.lib.base.utilities.helpers" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.LLSDDeserializer">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.helpers.</tt><tt class="descname">LLSDDeserializer</tt><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.LLSDDeserializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>utility for deserializing LLSD data</p>
|
||||
<p>The deserialization component is defined as a utility because the input
|
||||
data can be a string or a file. It might be possible to define this as
|
||||
an adapter on a string but a string is too generic for this. So that’s
|
||||
why it is a utility.</p>
|
||||
<p>You can use it like this:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">s</span><span class="o">=</span><span class="s">'<?xml version="1.0" ?><llsd><map><key>test</key><integer>1234</integer><key>foo</key><string>bar</string></map></llsd>'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>We use queryUtility because this returns None instead of an exception
|
||||
when a utility is not registered. We use the content type we received
|
||||
as the name of the utility. Another option would of course be to subclas
|
||||
string to some LLSDString class and use an adapter. We then would need some
|
||||
factory for generating the LLSDString class from whatever came back from
|
||||
the HTTP call.</p>
|
||||
<p>So here is how you use that utility:
|
||||
>>> deserializer = LLSDDeserializer()
|
||||
>>> llsd = deserializer.deserialize(s)
|
||||
>>> llsd
|
||||
{‘test’: 1234, ‘foo’: ‘bar’}</p>
|
||||
<p>We can also test this with some non-LLSD string:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">llsd</span> <span class="o">=</span> <span class="n">deserializer</span><span class="o">.</span><span class="n">deserialize_string</span><span class="p">(</span><span class="s">'mumpitz'</span><span class="p">)</span> <span class="c"># this is not LLSD</span>
|
||||
<span class="gp">...</span>
|
||||
<span class="go">DeserializationFailed: deserialization failed for 'mumpitz', reason: 'invalid token at index 0: 109'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">llsd</span> <span class="o">=</span> <span class="n">deserializer</span><span class="o">.</span><span class="n">deserialize_string</span><span class="p">(</span><span class="s">'barfoo'</span><span class="p">)</span>
|
||||
<span class="gp">...</span>
|
||||
<span class="go">DeserializationFailed: deserialization failed for 'barfoo', reason: 'binary notation not yet supported'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.LLSDDeserializer.deserialize">
|
||||
<tt class="descname">deserialize</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.LLSDDeserializer.deserialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>convenience class to handle a variety of inputs</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.LLSDDeserializer.deserialize_file">
|
||||
<tt class="descname">deserialize_file</tt><big>(</big><em>fp</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.LLSDDeserializer.deserialize_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>deserialize a file</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.LLSDDeserializer.deserialize_string">
|
||||
<tt class="descname">deserialize_string</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.LLSDDeserializer.deserialize_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>deserialize a string</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.ListLLSDSerializer">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.helpers.</tt><tt class="descname">ListLLSDSerializer</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.ListLLSDSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>adapter for serializing a list to LLSD</p>
|
||||
<p>An example:
|
||||
>>> d=[‘ChatSessionRequest’, ‘CopyInventoryFromNotecard’]
|
||||
>>> serializer = ListLLSDSerializer(d)
|
||||
>>> serializer.serialize()
|
||||
‘<?xml version=”1.0” ?><llsd><array><string>ChatSessionRequest</string><string>CopyInventoryFromNotecard</string></array></llsd>’
|
||||
>>> serializer.content_type
|
||||
‘application/llsd+xml’</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.ListLLSDSerializer.content_type">
|
||||
<tt class="descname">content_type</tt><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.ListLLSDSerializer.content_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>return the content type of this serializer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.ListLLSDSerializer.serialize">
|
||||
<tt class="descname">serialize</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.ListLLSDSerializer.serialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>convert the payload to LLSD</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Helpers">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.helpers.</tt><tt class="descname">Helpers</tt><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Helpers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>contains useful helper functions</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Helpers.bytes_to_ascii">
|
||||
<tt class="descname">bytes_to_ascii</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Helpers.bytes_to_ascii" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>converts bytes to ascii format</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Helpers.bytes_to_base64">
|
||||
<tt class="descname">bytes_to_base64</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Helpers.bytes_to_base64" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>converts bytes to ascii format</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Helpers.bytes_to_hex">
|
||||
<tt class="descname">bytes_to_hex</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Helpers.bytes_to_hex" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>converts bytes to hex format</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Helpers.hex_to_ascii">
|
||||
<tt class="descname">hex_to_ascii</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Helpers.hex_to_ascii" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>converts bytes to ascii format</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Helpers.log_event_queue_data">
|
||||
<tt class="descname">log_event_queue_data</tt><big>(</big><em>data</em>, <em>_object</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Helpers.log_event_queue_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>default logging function for event queue data events</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Helpers.log_packet">
|
||||
<tt class="descname">log_packet</tt><big>(</big><em>packet</em>, <em>_object</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Helpers.log_packet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>default logging function for packets</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Helpers.null_packet_handler">
|
||||
<tt class="descname">null_packet_handler</tt><big>(</big><em>packet</em>, <em>_object</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Helpers.null_packet_handler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>just a null event handler for watching aka fully parsing specific packets</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.DictLLSDSerializer">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.helpers.</tt><tt class="descname">DictLLSDSerializer</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.DictLLSDSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>adapter for serializing a dictionary to LLSD</p>
|
||||
<p>An example:
|
||||
>>> d={‘foo’:’bar’, ‘test’:1234}
|
||||
>>> serializer = DictLLSDSerializer(d)
|
||||
>>> serializer.serialize()
|
||||
‘<?xml version=”1.0” ?><llsd><map><key>test</key><integer>1234</integer><key>foo</key><string>bar</string></map></llsd>’
|
||||
>>> serializer.content_type
|
||||
‘application/llsd+xml’</p>
|
||||
<dl class="attribute">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.DictLLSDSerializer.content_type">
|
||||
<tt class="descname">content_type</tt><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.DictLLSDSerializer.content_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>return the content type of this serializer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.DictLLSDSerializer.serialize">
|
||||
<tt class="descname">serialize</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.DictLLSDSerializer.serialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>convert the payload to LLSD</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Wait">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.helpers.</tt><tt class="descname">Wait</tt><big>(</big><em>duration</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Wait" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a simple timer that blocks a calling routine for the specified number of seconds</p>
|
||||
<p>done since we were writing timing loops in test scripts repeatedly
|
||||
returns True when it’s done</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Wait.run">
|
||||
<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Wait.run" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.helpers.Wait.stop">
|
||||
<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.helpers.Wait.stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="inventory.html" title="inventory"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="groups.html" title="groups"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,482 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>inventory — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="llsd_builder" href="llsd_builder.html" />
|
||||
<link rel="prev" title="helpers" href="helpers.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="llsd_builder.html" title="llsd_builder"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="helpers.html" title="helpers"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="helpers.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">helpers</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="llsd_builder.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">llsd_builder</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/inventory.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.inventory">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">inventory</span></tt><a class="headerlink" href="#module-pyogp.lib.base.inventory" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.inventory.InventoryFolder">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">InventoryFolder</tt><big>(</big><em>Name=None</em>, <em>FolderID=None</em>, <em>ParentID=None</em>, <em>Version=None</em>, <em>Type=None</em>, <em>Descendents=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>represents an Inventory folder</p>
|
||||
<p>Initialize the event queue client class
|
||||
>>> inventoryfolder = InventoryFolder()</p>
|
||||
<p>Sample implementations: inventory.py
|
||||
Tests: tests/test_inventory.py</p>
|
||||
<p>initialize the inventory folder</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.InventoryFolder.move">
|
||||
<tt class="descname">move</tt><big>(</big><em>agent</em>, <em>parent_id</em>, <em>restamp=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.move" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>reparents this inventory folder</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.InventoryFolder.purge_descendents">
|
||||
<tt class="descname">purge_descendents</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.purge_descendents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>removes inventory from this folder, by unlinking the inventory from this parent folder</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.InventoryFolder.remove">
|
||||
<tt class="descname">remove</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.remove" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>removes this inventory folder</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.inventory.InventoryItem">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">InventoryItem</tt><big>(</big><em>ItemID=None</em>, <em>FolderID=None</em>, <em>CreatorID=None</em>, <em>OwnerID=None</em>, <em>GroupID=None</em>, <em>BaseMask=None</em>, <em>OwnerMask=None</em>, <em>GroupMask=None</em>, <em>EveryoneMask=None</em>, <em>NextOwnerMask=0</em>, <em>GroupOwned=None</em>, <em>AssetID=None</em>, <em>Type=None</em>, <em>InvType=None</em>, <em>Flags=None</em>, <em>SaleType=None</em>, <em>SalePrice=None</em>, <em>Name=None</em>, <em>Description=None</em>, <em>CreationDate=None</em>, <em>CRC=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryItem" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>represents an Inventory item</p>
|
||||
<p>Initialize the InventoryItem class
|
||||
>>> inventoryitem = InventoryItem()</p>
|
||||
<p>Sample implementations: inventory.py
|
||||
Tests: tests/test_inventory.py</p>
|
||||
<p>initialize the inventory item</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.InventoryItem.give">
|
||||
<tt class="descname">give</tt><big>(</big><em>agent</em>, <em>to_agent_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryItem.give" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends the target agent an inventory offer of this</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.InventoryItem.rez_object">
|
||||
<tt class="descname">rez_object</tt><big>(</big><em>agent</em>, <em>relative_position=(1</em>, <em>0</em>, <em>0)</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryItem.rez_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.InventoryItem.update">
|
||||
<tt class="descname">update</tt><big>(</big><em>agent</em>, <em>name=None</em>, <em>value=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryItem.update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>allow arbitraty update to any data in the inventory item</p>
|
||||
<p>accepts a dictionary of key:value pairs which will update the stored inventory items
|
||||
and then send an UpdateInventoryItem packet</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">Inventory</tt><big>(</big><em>agent=None</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>is an inventory container</p>
|
||||
<p>Initialize the event queue client class
|
||||
>>> inventory = Inventory()</p>
|
||||
<p>Sample implementations: agent.py
|
||||
Tests: tests/test_inventory.py</p>
|
||||
<p>set up the inventory manager</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.confirm_inventory_offer">
|
||||
<tt class="descname">confirm_inventory_offer</tt><big>(</big><em>FromAgentID</em>, <em>FromAgentName</em>, <em>InventoryName</em>, <em>ID</em>, <em>AssetType</em>, <em>ItemID</em>, <em>accept</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.confirm_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends an ImprovedInstantMessage packet accepting or declining an inventory offer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.display_folder_contents">
|
||||
<tt class="descname">display_folder_contents</tt><big>(</big><em>folder_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.display_folder_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns a list of the local representation of a folder’s contents</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.enable_callbacks">
|
||||
<tt class="descname">enable_callbacks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.enable_callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>enable monitors for certain inventory related packet events</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.give_inventory">
|
||||
<tt class="descname">give_inventory</tt><big>(</big><em>ItemID=None</em>, <em>agent_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.give_inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>offers another agent the specified inventory item</p>
|
||||
<p>searches the local inventory for the specified ItemID
|
||||
given a match, sends an ImprovedInventoryMessage packet to the specified AgentID</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.handle_inventory_offer">
|
||||
<tt class="descname">handle_inventory_offer</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.handle_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>parses and handles an incoming inventory offer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.onBulkUpdateInventory">
|
||||
<tt class="descname">onBulkUpdateInventory</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.onBulkUpdateInventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>handle the inventory data being delivered in the BullkUpdateInventory packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.onFetchInventoryReply">
|
||||
<tt class="descname">onFetchInventoryReply</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.onFetchInventoryReply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.onInventoryDescendents">
|
||||
<tt class="descname">onInventoryDescendents</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.onInventoryDescendents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.request_inventory_by_id">
|
||||
<tt class="descname">request_inventory_by_id</tt><big>(</big><em>id_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.request_inventory_by_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>ask for inventory data by id via a list</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.request_known_folder_contents">
|
||||
<tt class="descname">request_known_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.request_known_folder_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send requests to the server for contents of all known folders</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.search_inventory">
|
||||
<tt class="descname">search_inventory</tt><big>(</big><em>folder_list=</em><span class="optional">[</span><span class="optional">]</span>, <em>item_id=None</em>, <em>name=None</em>, <em>match_list=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.search_inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>search through all inventory folders for an id(uuid) or Name, and
|
||||
return a list of matching InventoryItems or InventoryFolders</p>
|
||||
<p>recursive search, based on folder_id. if no folder id is specified
|
||||
look through everything in self.folders</p>
|
||||
<p>This does not request inventory from the grid. It could, were we to go about enabling this...</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.search_inventory_folder">
|
||||
<tt class="descname">search_inventory_folder</tt><big>(</big><em>folder_id</em>, <em>_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.search_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>search an inventory folder for _id or name</p>
|
||||
<p>return a list of matches</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.sendFetchInventoryDescendentsRequest">
|
||||
<tt class="descname">sendFetchInventoryDescendentsRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.sendFetchInventoryDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for folder contents</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.sendFetchInventoryRequest">
|
||||
<tt class="descname">sendFetchInventoryRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.sendFetchInventoryRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for inventory items in folder</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.sendFetchLibDescendentsRequest">
|
||||
<tt class="descname">sendFetchLibDescendentsRequest</tt><big>(</big><em>item_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.sendFetchLibDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for library folder contents</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.sendFetchLibRequest">
|
||||
<tt class="descname">sendFetchLibRequest</tt><big>(</big><em>item_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.sendFetchLibRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for library items</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.Inventory.update_inventory_folder">
|
||||
<tt class="descname">update_inventory_folder</tt><big>(</big><em>folder_data</em>, <em>folder_id</em>, <em>descdendents</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.Inventory.update_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>update a folder’s attributes</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.inventory.AIS">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">AIS</tt><big>(</big><em>agent</em>, <em>capabilities</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>AIS specific inventory manager</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.confirm_inventory_offer">
|
||||
<tt class="descname">confirm_inventory_offer</tt><big>(</big><em>FromAgentID</em>, <em>FromAgentName</em>, <em>InventoryName</em>, <em>ID</em>, <em>AssetType</em>, <em>ItemID</em>, <em>accept</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.confirm_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends an ImprovedInstantMessage packet accepting or declining an inventory offer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.display_folder_contents">
|
||||
<tt class="descname">display_folder_contents</tt><big>(</big><em>folder_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.display_folder_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns a list of the local representation of a folder’s contents</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.enable_callbacks">
|
||||
<tt class="descname">enable_callbacks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.enable_callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>enable monitors for certain inventory related packet events</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.give_inventory">
|
||||
<tt class="descname">give_inventory</tt><big>(</big><em>ItemID=None</em>, <em>agent_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.give_inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>offers another agent the specified inventory item</p>
|
||||
<p>searches the local inventory for the specified ItemID
|
||||
given a match, sends an ImprovedInventoryMessage packet to the specified AgentID</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.handle_inventory_offer">
|
||||
<tt class="descname">handle_inventory_offer</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.handle_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>parses and handles an incoming inventory offer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.onBulkUpdateInventory">
|
||||
<tt class="descname">onBulkUpdateInventory</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.onBulkUpdateInventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>handle the inventory data being delivered in the BullkUpdateInventory packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.onFetchInventoryReply">
|
||||
<tt class="descname">onFetchInventoryReply</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.onFetchInventoryReply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.onInventoryDescendents">
|
||||
<tt class="descname">onInventoryDescendents</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.onInventoryDescendents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.request_inventory_by_id">
|
||||
<tt class="descname">request_inventory_by_id</tt><big>(</big><em>id_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.request_inventory_by_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>ask for inventory data by id via a list</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.request_known_folder_contents">
|
||||
<tt class="descname">request_known_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.request_known_folder_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send requests to the server for contents of all known folders</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.search_inventory">
|
||||
<tt class="descname">search_inventory</tt><big>(</big><em>folder_list=</em><span class="optional">[</span><span class="optional">]</span>, <em>item_id=None</em>, <em>name=None</em>, <em>match_list=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.search_inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>search through all inventory folders for an id(uuid) or Name, and
|
||||
return a list of matching InventoryItems or InventoryFolders</p>
|
||||
<p>recursive search, based on folder_id. if no folder id is specified
|
||||
look through everything in self.folders</p>
|
||||
<p>This does not request inventory from the grid. It could, were we to go about enabling this...</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.search_inventory_folder">
|
||||
<tt class="descname">search_inventory_folder</tt><big>(</big><em>folder_id</em>, <em>_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.search_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>search an inventory folder for _id or name</p>
|
||||
<p>return a list of matches</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.sendFetchInventoryDescendentsRequest">
|
||||
<tt class="descname">sendFetchInventoryDescendentsRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.sendFetchInventoryDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the server for folder contents</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.sendFetchInventoryRequest">
|
||||
<tt class="descname">sendFetchInventoryRequest</tt><big>(</big><em>item_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.sendFetchInventoryRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for folder attributes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.sendFetchLibDescendentsRequest">
|
||||
<tt class="descname">sendFetchLibDescendentsRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.sendFetchLibDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the server for folder contents</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.sendFetchLibRequest">
|
||||
<tt class="descname">sendFetchLibRequest</tt><big>(</big><em>item_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.sendFetchLibRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for folder attributes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.AIS.update_inventory_folder">
|
||||
<tt class="descname">update_inventory_folder</tt><big>(</big><em>folder_data</em>, <em>folder_id</em>, <em>descdendents</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.update_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>update a folder’s attributes</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">UDP_Inventory</tt><big>(</big><em>agent</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.confirm_inventory_offer">
|
||||
<tt class="descname">confirm_inventory_offer</tt><big>(</big><em>FromAgentID</em>, <em>FromAgentName</em>, <em>InventoryName</em>, <em>ID</em>, <em>AssetType</em>, <em>ItemID</em>, <em>accept</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.confirm_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends an ImprovedInstantMessage packet accepting or declining an inventory offer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.display_folder_contents">
|
||||
<tt class="descname">display_folder_contents</tt><big>(</big><em>folder_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.display_folder_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns a list of the local representation of a folder’s contents</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.enable_callbacks">
|
||||
<tt class="descname">enable_callbacks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.enable_callbacks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>enable monitors for certain inventory related packet events</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.give_inventory">
|
||||
<tt class="descname">give_inventory</tt><big>(</big><em>ItemID=None</em>, <em>agent_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.give_inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>offers another agent the specified inventory item</p>
|
||||
<p>searches the local inventory for the specified ItemID
|
||||
given a match, sends an ImprovedInventoryMessage packet to the specified AgentID</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.handle_inventory_offer">
|
||||
<tt class="descname">handle_inventory_offer</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.handle_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>parses and handles an incoming inventory offer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.onBulkUpdateInventory">
|
||||
<tt class="descname">onBulkUpdateInventory</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.onBulkUpdateInventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>handle the inventory data being delivered in the BullkUpdateInventory packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.onFetchInventoryReply">
|
||||
<tt class="descname">onFetchInventoryReply</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.onFetchInventoryReply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.onInventoryDescendents">
|
||||
<tt class="descname">onInventoryDescendents</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.onInventoryDescendents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.request_inventory_by_id">
|
||||
<tt class="descname">request_inventory_by_id</tt><big>(</big><em>id_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.request_inventory_by_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>ask for inventory data by id via a list</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.request_known_folder_contents">
|
||||
<tt class="descname">request_known_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.request_known_folder_contents" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send requests to the server for contents of all known folders</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.search_inventory">
|
||||
<tt class="descname">search_inventory</tt><big>(</big><em>folder_list=</em><span class="optional">[</span><span class="optional">]</span>, <em>item_id=None</em>, <em>name=None</em>, <em>match_list=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.search_inventory" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>search through all inventory folders for an id(uuid) or Name, and
|
||||
return a list of matching InventoryItems or InventoryFolders</p>
|
||||
<p>recursive search, based on folder_id. if no folder id is specified
|
||||
look through everything in self.folders</p>
|
||||
<p>This does not request inventory from the grid. It could, were we to go about enabling this...</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.search_inventory_folder">
|
||||
<tt class="descname">search_inventory_folder</tt><big>(</big><em>folder_id</em>, <em>_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.search_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>search an inventory folder for _id or name</p>
|
||||
<p>return a list of matches</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.sendFetchInventoryDescendentsRequest">
|
||||
<tt class="descname">sendFetchInventoryDescendentsRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.sendFetchInventoryDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for folder contents</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.sendFetchInventoryRequest">
|
||||
<tt class="descname">sendFetchInventoryRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.sendFetchInventoryRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for folder attributes</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.sendFetchLibDescendentsRequest">
|
||||
<tt class="descname">sendFetchLibDescendentsRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.sendFetchLibDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for library items</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.sendFetchLibRequest">
|
||||
<tt class="descname">sendFetchLibRequest</tt><big>(</big><em>item_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.sendFetchLibRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a request to the grid for library items</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.inventory.UDP_Inventory.update_inventory_folder">
|
||||
<tt class="descname">update_inventory_folder</tt><big>(</big><em>folder_data</em>, <em>folder_id</em>, <em>descdendents</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.update_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>update a folder’s attributes</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="llsd_builder.html" title="llsd_builder"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="helpers.html" title="helpers"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,212 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>llsd_builder — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="llsd_sender" href="llsd_sender.html" />
|
||||
<link rel="prev" title="inventory" href="inventory.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="llsd_sender.html" title="llsd_sender"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="inventory.html" title="inventory"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="inventory.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">inventory</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="llsd_sender.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">llsd_sender</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/llsd_builder.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.llsd_builder">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">llsd_builder</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.llsd_builder" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.llsd_builder.</tt><tt class="descname">MsgData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message that is being created that will be
|
||||
serialized and sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgData.add_block">
|
||||
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgData.add_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgData.add_data">
|
||||
<tt class="descname">add_data</tt><big>(</big><em>block_name</em>, <em>var_name</em>, <em>data</em>, <em>data_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgData.add_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgData.get_block">
|
||||
<tt class="descname">get_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgData.get_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgVariableData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.llsd_builder.</tt><tt class="descname">MsgVariableData</tt><big>(</big><em>name</em>, <em>data</em>, <em>var_type=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgVariableData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message Block variable that is being created that will be
|
||||
serialized and sent</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgVariableData.get_data_as_string">
|
||||
<tt class="descname">get_data_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgVariableData.get_data_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgVariableData.get_var_type_as_string">
|
||||
<tt class="descname">get_var_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgVariableData.get_var_type_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgBlockData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.llsd_builder.</tt><tt class="descname">MsgBlockData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgBlockData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message block that is being created that will be
|
||||
serialized and sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgBlockData.add_variable">
|
||||
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgBlockData.add_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgBlockData.get_variable">
|
||||
<tt class="descname">get_variable</tt><big>(</big><em>var_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgBlockData.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.MsgBlockData.get_variables">
|
||||
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.MsgBlockData.get_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.llsd_builder.</tt><tt class="descname">LLSDMessageBuilder</tt><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.add_data">
|
||||
<tt class="descname">add_data</tt><big>(</big><em>var_name</em>, <em>data</em>, <em>data_type</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.add_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.build_message">
|
||||
<tt class="descname">build_message</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.build_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>this does not serialize it for this type of builder. The message
|
||||
will be put in standard Python form and will need to be formatted
|
||||
based on who the target is (xml? something else?)</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.is_built">
|
||||
<tt class="descname">is_built</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.is_built" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.new_message">
|
||||
<tt class="descname">new_message</tt><big>(</big><em>message_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.new_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.next_block">
|
||||
<tt class="descname">next_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder.next_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="llsd_sender.html" title="llsd_sender"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="inventory.html" title="inventory"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,126 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>llsd_sender — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="login" href="login.html" />
|
||||
<link rel="prev" title="llsd_builder" href="llsd_builder.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="login.html" title="login"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="llsd_builder.html" title="llsd_builder"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="llsd_builder.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">llsd_builder</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="login.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">login</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/llsd_sender.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.llsd_sender">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">llsd_sender</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.llsd_sender" title="Permalink to this headline">¶</a></h1>
|
||||
<p>$LicenseInfo:firstyear=2008&license=apachev2$</p>
|
||||
<p>Copyright 2009, Linden Research, Inc.</p>
|
||||
<p>Licensed under the Apache License, Version 2.0 (the “License”).
|
||||
You may obtain a copy of the License at:</p>
|
||||
<blockquote>
|
||||
<a class="reference external" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></blockquote>
|
||||
<dl class="docutils">
|
||||
<dt>or in </dt>
|
||||
<dd><a class="reference external" href="http://svn.secondlife.com/svn/linden/projects/2008/pyogp/LICENSE.txt">http://svn.secondlife.com/svn/linden/projects/2008/pyogp/LICENSE.txt</a></dd>
|
||||
</dl>
|
||||
<p>$/LicenseInfo$</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="login.html" title="login"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="llsd_builder.html" title="llsd_builder"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,177 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>login — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="message" href="message.html" />
|
||||
<link rel="prev" title="llsd_sender" href="llsd_sender.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="message.html" title="message"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="llsd_sender.html" title="llsd_sender"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="llsd_sender.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">llsd_sender</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="message.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">message</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/login.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.login">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">login</span></tt><a class="headerlink" href="#module-pyogp.lib.base.login" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.login.OGPLoginParams">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.login.</tt><tt class="descname">OGPLoginParams</tt><big>(</big><em>firstname</em>, <em>lastname</em>, <em>password</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.login.OGPLoginParams" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an OGP plain password credential</p>
|
||||
<p>initialize this credential</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.login.OGPLoginParams.serialize">
|
||||
<tt class="descname">serialize</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.login.OGPLoginParams.serialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>return a dictionary of login params</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.login.Login">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.login.</tt><tt class="descname">Login</tt><big>(</big><em>settings=None</em>, <em>handler=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.login.Login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>logs into a login endpoint</p>
|
||||
<dl class="docutils">
|
||||
<dt>There are 2 cases here: ‘legacy’ login and ‘OGP’ login.</dt>
|
||||
<dd>Legacy = standard Second Life/OpenSim login
|
||||
OGP = Open Grid Protocol enabled grid, where one logs into an agent domain</dd>
|
||||
</dl>
|
||||
<p>Example (legacy oriented):</p>
|
||||
<p>The login type is determined by parsing the login uri
|
||||
‘legacy’ = login.cgi
|
||||
‘ogp’ = auth.cgi</p>
|
||||
<p>Initialize the login class
|
||||
>>> login = Login()</p>
|
||||
<p>Setup some login parameters.
|
||||
>>> login_params = LegacyLoginParams(‘firstname’, ‘lastname’, ‘password’)
|
||||
>>> login_params = login_params.serialize()</p>
|
||||
<p>login stores & returns the response from the loginuri (in our example a mock response)
|
||||
>>> login.login(‘<a class="reference external" href="http://localhost:12345/login.cgi">http://localhost:12345/login.cgi</a>‘, login_params, ‘region’)
|
||||
{‘login’: ‘true’, ‘seed_capability’: ‘<a class="reference external" href="http://127.0.0.1:12345/seed_cap">http://127.0.0.1:12345/seed_cap</a>‘}</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">login</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s">'login'</span><span class="p">]</span>
|
||||
<span class="go">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Sample implementations: examples/sample_login.py
|
||||
Tests: tests/login.txt, tests/test_legacy_login.py, tests/test_ogp_login.py</p>
|
||||
<p>initialize the login object</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.login.Login.login">
|
||||
<tt class="descname">login</tt><big>(</big><em>loginuri=None</em>, <em>login_params=None</em>, <em>start_location=None</em>, <em>handler=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.login.Login.login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>high level login initiator, returns the login response as a dict</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.login.LegacyLoginParams">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.login.</tt><tt class="descname">LegacyLoginParams</tt><big>(</big><em>firstname</em>, <em>lastname</em>, <em>password</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.login.LegacyLoginParams" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a legacy plain password credential</p>
|
||||
<p>initialize this credential</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.login.LegacyLoginParams.serialize">
|
||||
<tt class="descname">serialize</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.login.LegacyLoginParams.serialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>return a dictionary of login params</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="message.html" title="message"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="llsd_sender.html" title="llsd_sender"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,226 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>message — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="net" href="net.html" />
|
||||
<link rel="prev" title="login" href="login.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="net.html" title="net"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="login.html" title="login"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="login.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">login</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="net.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">net</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/message.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.message">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">message</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.message" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.message.MsgData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.message.</tt><tt class="descname">MsgData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message that is being created that will be
|
||||
serialized and sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.MsgData.add_block">
|
||||
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgData.add_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.MsgData.add_data">
|
||||
<tt class="descname">add_data</tt><big>(</big><em>block_name</em>, <em>var_name</em>, <em>data</em>, <em>data_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgData.add_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.MsgData.get_block">
|
||||
<tt class="descname">get_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgData.get_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.message.Message">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.message.</tt><tt class="descname">Message</tt><big>(</big><em>name</em>, <em>*args</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.Message.add_block">
|
||||
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Message.add_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.Message.add_data">
|
||||
<tt class="descname">add_data</tt><big>(</big><em>block_name</em>, <em>var_name</em>, <em>data</em>, <em>data_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Message.add_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.Message.get_block">
|
||||
<tt class="descname">get_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Message.get_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.Message.parse_blocks">
|
||||
<tt class="descname">parse_blocks</tt><big>(</big><em>block_list</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Message.parse_blocks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.message.MsgVariableData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.message.</tt><tt class="descname">MsgVariableData</tt><big>(</big><em>name</em>, <em>data</em>, <em>var_type=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgVariableData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message Block variable that is being created that will be
|
||||
serialized and sent</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.MsgVariableData.get_data_as_string">
|
||||
<tt class="descname">get_data_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgVariableData.get_data_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.MsgVariableData.get_var_type_as_string">
|
||||
<tt class="descname">get_var_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgVariableData.get_var_type_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.message.MsgBlockData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.message.</tt><tt class="descname">MsgBlockData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgBlockData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message block that is being created that will be
|
||||
serialized and sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.MsgBlockData.add_variable">
|
||||
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgBlockData.add_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.MsgBlockData.get_variable">
|
||||
<tt class="descname">get_variable</tt><big>(</big><em>var_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgBlockData.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.MsgBlockData.get_variables">
|
||||
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.MsgBlockData.get_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.message.Block">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.message.</tt><tt class="descname">Block</tt><big>(</big><em>name</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.Block.add_variable">
|
||||
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Block.add_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.Block.get_variable">
|
||||
<tt class="descname">get_variable</tt><big>(</big><em>var_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Block.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.message.Block.get_variables">
|
||||
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.message.Block.get_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="net.html" title="net"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="login.html" title="login"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,141 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>net — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="objects" href="objects.html" />
|
||||
<link rel="prev" title="message" href="message.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="objects.html" title="objects"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="message.html" title="message"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="message.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">message</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="objects.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">objects</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/net.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.network.net">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">net</span></tt><a class="headerlink" href="#module-pyogp.lib.base.network.net" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.network.net.NetUDPClient">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.network.net.</tt><tt class="descname">NetUDPClient</tt><a class="headerlink" href="#pyogp.lib.base.network.net.NetUDPClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.network.net.NetUDPClient.get_sender">
|
||||
<tt class="descname">get_sender</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.network.net.NetUDPClient.get_sender" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.network.net.NetUDPClient.receive_packet">
|
||||
<tt class="descname">receive_packet</tt><big>(</big><em>sock</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.network.net.NetUDPClient.receive_packet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.network.net.NetUDPClient.send_packet">
|
||||
<tt class="descname">send_packet</tt><big>(</big><em>sock</em>, <em>send_buffer</em>, <em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.network.net.NetUDPClient.send_packet" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.network.net.NetUDPClient.start_udp_connection">
|
||||
<tt class="descname">start_udp_connection</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.network.net.NetUDPClient.start_udp_connection" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Starts a udp connection, returning socket and port.</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="objects.html" title="objects"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="message.html" title="message"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,344 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>objects — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="packet" href="packet.html" />
|
||||
<link rel="prev" title="net" href="net.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packet.html" title="packet"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="net.html" title="net"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="net.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">net</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="packet.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">packet</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/objects.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.objects">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">objects</span></tt><a class="headerlink" href="#module-pyogp.lib.base.objects" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.objects.Object">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.objects.</tt><tt class="descname">Object</tt><big>(</big><em>LocalID=None</em>, <em>State=None</em>, <em>FullID=None</em>, <em>CRC=None</em>, <em>PCode=None</em>, <em>Material=None</em>, <em>ClickAction=None</em>, <em>Scale=None</em>, <em>ObjectData=None</em>, <em>ParentID=None</em>, <em>UpdateFlags=None</em>, <em>PathCurve=None</em>, <em>ProfileCurve=None</em>, <em>PathBegin=None</em>, <em>PathEnd=None</em>, <em>PathScaleX=None</em>, <em>PathScaleY=None</em>, <em>PathShearX=None</em>, <em>PathShearY=None</em>, <em>PathTwist=None</em>, <em>PathTwistBegin=None</em>, <em>PathRadiusOffset=None</em>, <em>PathTaperX=None</em>, <em>PathTaperY=None</em>, <em>PathRevolutions=None</em>, <em>PathSkew=None</em>, <em>ProfileBegin=None</em>, <em>ProfileEnd=None</em>, <em>ProfileHollow=None</em>, <em>TextureEntry=None</em>, <em>TextureAnim=None</em>, <em>NameValue=None</em>, <em>Data=None</em>, <em>Text=None</em>, <em>TextColor=None</em>, <em>MediaURL=None</em>, <em>PSBlock=None</em>, <em>ExtraParams=None</em>, <em>Sound=None</em>, <em>OwnerID=None</em>, <em>Gain=None</em>, <em>Flags=None</em>, <em>Radius=None</em>, <em>JointType=None</em>, <em>JointPivot=None</em>, <em>JointAxisOrAnchor=None</em>, <em>FootCollisionPlane=None</em>, <em>Position=None</em>, <em>Velocity=None</em>, <em>Acceleration=None</em>, <em>Rotation=None</em>, <em>AngularVelocity=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>represents an Object</p>
|
||||
<p>Initialize the Object class instance
|
||||
>>> object = Object()</p>
|
||||
<p>Sample implementations: objects.py
|
||||
Tests: tests/test_objects.py</p>
|
||||
<p>set up the object attributes</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.derez">
|
||||
<tt class="descname">derez</tt><big>(</big><em>agent</em>, <em>destination</em>, <em>destinationID</em>, <em>transactionID</em>, <em>GroupID</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.derez" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>derez an object, specifying the destination</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.deselect">
|
||||
<tt class="descname">deselect</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.deselect" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>deselect an object</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.select">
|
||||
<tt class="descname">select</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.select" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>select an object</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.set_object_copy_mod_permissions">
|
||||
<tt class="descname">set_object_copy_mod_permissions</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.set_object_copy_mod_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Set Next Owner Permissions to Copy/Mod
|
||||
This is a common permission set for attachements.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.set_object_copy_only_permissions">
|
||||
<tt class="descname">set_object_copy_only_permissions</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.set_object_copy_only_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Set Next Owner Permissions to Copy Only</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.set_object_copy_transfer_permissions">
|
||||
<tt class="descname">set_object_copy_transfer_permissions</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.set_object_copy_transfer_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Set Next Owner Permissions to Copy/Transfer</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.set_object_description">
|
||||
<tt class="descname">set_object_description</tt><big>(</big><em>agent</em>, <em>Description</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.set_object_description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>update the description of an objects</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.set_object_full_permissions">
|
||||
<tt class="descname">set_object_full_permissions</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.set_object_full_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Set Next Owner Permissions Copy, Modify, Transfer
|
||||
This is also called ‘full permissions’.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.set_object_mod_transfer_permissions">
|
||||
<tt class="descname">set_object_mod_transfer_permissions</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.set_object_mod_transfer_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Set Next Owner Permissions to Mod/Transfer
|
||||
This is a common permission set for clothing.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.set_object_name">
|
||||
<tt class="descname">set_object_name</tt><big>(</big><em>agent</em>, <em>Name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.set_object_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>update the name of an object</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.set_object_transfer_only_permissions">
|
||||
<tt class="descname">set_object_transfer_only_permissions</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.set_object_transfer_only_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Set Next Owner Permissions to Transfer Only
|
||||
This is the most restrictive set of permissions allowed.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.take">
|
||||
<tt class="descname">take</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.take" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>take object into inventory</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.update_object_permissions">
|
||||
<tt class="descname">update_object_permissions</tt><big>(</big><em>agent</em>, <em>Field</em>, <em>Set</em>, <em>Mask</em>, <em>Override=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.update_object_permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>update permissions for a list of objects</p>
|
||||
<p>This will update a specific bit to a specific value.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Object.update_properties">
|
||||
<tt class="descname">update_properties</tt><big>(</big><em>properties</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Object.update_properties" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>takes a dictionary of attribute:value and makes it so</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.objects.Objects">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.objects.</tt><tt class="descname">Objects</tt><big>(</big><em>agent=None</em>, <em>region=None</em>, <em>settings=None</em>, <em>packet_handler=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>is an Object Manager</p>
|
||||
<p>Initialize the event queue client class
|
||||
>>> objects = Objects()</p>
|
||||
<p>Sample implementations: region.py
|
||||
Tests: tests/test_objects.py</p>
|
||||
<p>set up the inventory manager</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.create_default_box">
|
||||
<tt class="descname">create_default_box</tt><big>(</big><em>GroupID=UUID('00000000-0000-0000-0000-000000000000')</em>, <em>relative_position=(1</em>, <em>0</em>, <em>0)</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.create_default_box" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>creates the default box, defaulting as 1m to the east, with an option GroupID to set the prim to</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.find_objects_by_name">
|
||||
<tt class="descname">find_objects_by_name</tt><big>(</big><em>Name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.find_objects_by_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>searches the store for known objects by name</p>
|
||||
<p>returns a list of all such known objects</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.find_objects_within_radius">
|
||||
<tt class="descname">find_objects_within_radius</tt><big>(</big><em>radius</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.find_objects_within_radius" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns objects nearby. returns a list of objects</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.get_avatar_from_store">
|
||||
<tt class="descname">get_avatar_from_store</tt><big>(</big><em>LocalID=None</em>, <em>FullID=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.get_avatar_from_store" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>searches the store and returns object if stored, None otherwise</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.get_object_from_store">
|
||||
<tt class="descname">get_object_from_store</tt><big>(</big><em>LocalID=None</em>, <em>FullID=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.get_object_from_store" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>searches the store and returns object if stored, None otherwise</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.kill_stored_avatar">
|
||||
<tt class="descname">kill_stored_avatar</tt><big>(</big><em>ID</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.kill_stored_avatar" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.kill_stored_object">
|
||||
<tt class="descname">kill_stored_object</tt><big>(</big><em>ID</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.kill_stored_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.my_objects">
|
||||
<tt class="descname">my_objects</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.my_objects" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns a list of known objects where the calling client is the owner</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.object_add">
|
||||
<tt class="descname">object_add</tt><big>(</big><em>PCode</em>, <em>Material</em>, <em>AddFlags</em>, <em>PathCurve</em>, <em>ProfileCurve</em>, <em>PathBegin</em>, <em>PathEnd</em>, <em>PathScaleX</em>, <em>PathScaleY</em>, <em>PathShearX</em>, <em>PathShearY</em>, <em>PathTwist</em>, <em>PathTwistBegin</em>, <em>PathRadiusOffset</em>, <em>PathTaperX</em>, <em>PathTaperY</em>, <em>PathRevolutions</em>, <em>PathSkew</em>, <em>ProfileBegin</em>, <em>ProfileEnd</em>, <em>ProfileHollow</em>, <em>BypassRaycast</em>, <em>RayStart</em>, <em>RayEnd</em>, <em>RayTargetID</em>, <em>RayEndIsIntersection</em>, <em>Scale</em>, <em>Rotation</em>, <em>State</em>, <em>GroupID=UUID('00000000-0000-0000-0000-000000000000')</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.object_add" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>ObjectAdd - create new object in the world
|
||||
Simulator will assign ID and send message back to signal
|
||||
object actually created.</p>
|
||||
<p>AddFlags (see also ObjectUpdate)
|
||||
0x01 - use physics
|
||||
0x02 - create selected</p>
|
||||
<p>GroupID defaults to (No group active)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.onKillObject">
|
||||
<tt class="descname">onKillObject</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.onKillObject" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.onObjectProperties">
|
||||
<tt class="descname">onObjectProperties</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.onObjectProperties" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.onObjectUpdate">
|
||||
<tt class="descname">onObjectUpdate</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.onObjectUpdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>populates an Object instance and adds it to the Objects() store</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.onObjectUpdateCached">
|
||||
<tt class="descname">onObjectUpdateCached</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.onObjectUpdateCached" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>borrowing from libomv, we’ll request object data for all data coming in via ObjectUpdateCached</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.onObjectUpdateCompressed">
|
||||
<tt class="descname">onObjectUpdateCompressed</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.onObjectUpdateCompressed" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.process_multiple_object_updates">
|
||||
<tt class="descname">process_multiple_object_updates</tt><big>(</big><em>objects</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.process_multiple_object_updates" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>process a list of object updates</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.process_object_update">
|
||||
<tt class="descname">process_object_update</tt><big>(</big><em>_object</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.process_object_update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>append to or replace an object in self.objects</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.remove_object_from_store">
|
||||
<tt class="descname">remove_object_from_store</tt><big>(</big><em>ID=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.remove_object_from_store" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.request_object_update">
|
||||
<tt class="descname">request_object_update</tt><big>(</big><em>ID=None</em>, <em>ID_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.request_object_update" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>requests object updates from the simulator</p>
|
||||
<p>accepts a tuple of (ID, CacheMissType), or a list of such tuples</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.store_avatar">
|
||||
<tt class="descname">store_avatar</tt><big>(</big><em>_objectdata</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.store_avatar" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.store_object">
|
||||
<tt class="descname">store_object</tt><big>(</big><em>_object</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.store_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.update_multiple_objects_properties">
|
||||
<tt class="descname">update_multiple_objects_properties</tt><big>(</big><em>object_list</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.update_multiple_objects_properties" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>update the attributes of objects</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.update_object_properties">
|
||||
<tt class="descname">update_object_properties</tt><big>(</big><em>object_properties</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.update_object_properties" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>update the attributes of an object</p>
|
||||
<p>If the object is known, we update the properties.
|
||||
If not, we create a new object</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.objects.Objects.update_prim_properties">
|
||||
<tt class="descname">update_prim_properties</tt><big>(</big><em>prim_properties</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.objects.Objects.update_prim_properties" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packet.html" title="packet"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="net.html" title="net"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,143 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>packet — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="packethandler" href="packethandler.html" />
|
||||
<link rel="prev" title="objects" href="objects.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packethandler.html" title="packethandler"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="objects.html" title="objects"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="objects.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">objects</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="packethandler.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">packethandler</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/packet.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.packet">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">packet</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.packet" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.packet.PackFlags">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.packet.</tt><tt class="descname">PackFlags</tt><a class="headerlink" href="#pyogp.lib.base.message.packet.PackFlags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.packet.UDPPacket">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.packet.</tt><tt class="descname">UDPPacket</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packet.UDPPacket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a UDP packet</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.packet.UDPPacket.add_ack">
|
||||
<tt class="descname">add_ack</tt><big>(</big><em>packet_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packet.UDPPacket.add_ack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.packet.UDPPacket.data">
|
||||
<tt class="descname">data</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packet.UDPPacket.data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>a string representation of a packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.packet.UDPPacket.get_var">
|
||||
<tt class="descname">get_var</tt><big>(</big><em>block</em>, <em>variable</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packet.UDPPacket.get_var" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packethandler.html" title="packethandler"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="objects.html" title="objects"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,152 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>packethandler — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="packets" href="packets.html" />
|
||||
<link rel="prev" title="packet" href="packet.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packets.html" title="packets"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packet.html" title="packet"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="packet.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">packet</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="packets.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">packets</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/packethandler.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.packethandler">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">packethandler</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.packethandler" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.packethandler.PacketHandler">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.packethandler.</tt><tt class="descname">PacketHandler</tt><big>(</big><em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packethandler.PacketHandler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>general class handling individual packets</p>
|
||||
<p>i do nothing</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.packethandler.PacketHandler.is_packet_handled">
|
||||
<tt class="descname">is_packet_handled</tt><big>(</big><em>packet_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packethandler.PacketHandler.is_packet_handled" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>if the packet is being monitored, return True, otherwise, return False</p>
|
||||
<p>this can allow us to skip parsing inbound packets if no one is watching a particular one</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.packethandler.PacketReceivedNotifier">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.packethandler.</tt><tt class="descname">PacketReceivedNotifier</tt><big>(</big><em>packet_name</em>, <em>settings</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packethandler.PacketReceivedNotifier" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>received TestMessage packet</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.packethandler.PacketReceivedNotifier.received">
|
||||
<tt class="descname">received</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packethandler.PacketReceivedNotifier.received" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.packethandler.PacketReceivedNotifier.subscribe">
|
||||
<tt class="descname">subscribe</tt><big>(</big><em>*args</em>, <em>**kwdargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packethandler.PacketReceivedNotifier.subscribe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.packethandler.PacketReceivedNotifier.unsubscribe">
|
||||
<tt class="descname">unsubscribe</tt><big>(</big><em>*args</em>, <em>**kwdargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.packethandler.PacketReceivedNotifier.unsubscribe" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packets.html" title="packets"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packet.html" title="packet"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,131 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>parse_packet — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="permissions" href="permissions.html" />
|
||||
<link rel="prev" title="packets" href="packets.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="permissions.html" title="permissions"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packets.html" title="packets"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="packets.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">packets</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="permissions.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">permissions</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/parse_packet.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.utilities.parse_packet">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">parse_packet</span></tt><a class="headerlink" href="#module-pyogp.lib.base.utilities.parse_packet" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.utilities.parse_packet.parsingStats">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.utilities.parse_packet.</tt><tt class="descname">parsingStats</tt><a class="headerlink" href="#pyogp.lib.base.utilities.parse_packet.parsingStats" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.parse_packet.parsingStats.addFail">
|
||||
<tt class="descname">addFail</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.parse_packet.parsingStats.addFail" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.utilities.parse_packet.parsingStats.addSuccess">
|
||||
<tt class="descname">addSuccess</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.utilities.parse_packet.parsingStats.addSuccess" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="permissions.html" title="permissions"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="packets.html" title="packets"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,135 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>permissions — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="region" href="region.html" />
|
||||
<link rel="prev" title="parse_packet" href="parse_packet.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="region.html" title="region"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="parse_packet.html" title="parse_packet"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="parse_packet.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">parse_packet</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="region.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">region</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/permissions.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.permissions">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">permissions</span></tt><a class="headerlink" href="#module-pyogp.lib.base.permissions" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.permissions.PermissionsMask">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.permissions.</tt><tt class="descname">PermissionsMask</tt><a class="headerlink" href="#pyogp.lib.base.permissions.PermissionsMask" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>permissions flags mappings</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.permissions.PermissionsTarget">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.permissions.</tt><tt class="descname">PermissionsTarget</tt><a class="headerlink" href="#pyogp.lib.base.permissions.PermissionsTarget" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>who the permissions apply to</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.permissions.Permissions">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.permissions.</tt><tt class="descname">Permissions</tt><big>(</big><em>BaseMask=None</em>, <em>OwnerMask=None</em>, <em>GroupMask=None</em>, <em>EveryoneMask=None</em>, <em>NextOwnerMask=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.permissions.Permissions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>class representing the permissions of an object or inventory item</p>
|
||||
<p>store the values of the various targets permissions</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="region.html" title="region"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="parse_packet.html" title="parse_packet"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,239 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>region — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="settings" href="settings.html" />
|
||||
<link rel="prev" title="permissions" href="permissions.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="settings.html" title="settings"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="permissions.html" title="permissions"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="permissions.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">permissions</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="settings.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">settings</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/region.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.region">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">region</span></tt><a class="headerlink" href="#module-pyogp.lib.base.region" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.region.Region">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.region.</tt><tt class="descname">Region</tt><big>(</big><em>global_x=0</em>, <em>global_y=0</em>, <em>seed_capability_url=None</em>, <em>udp_blacklist=None</em>, <em>sim_ip=None</em>, <em>sim_port=None</em>, <em>circuit_code=None</em>, <em>agent=None</em>, <em>settings=None</em>, <em>packet_handler=None</em>, <em>event_queue_handler=None</em>, <em>handle=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a region container</p>
|
||||
<p>The Region class is a container for region specific data.
|
||||
It is also a nice place for convenience code.</p>
|
||||
<p>Example, of initializing a region class:</p>
|
||||
<p>Initialize the login class</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">region</span> <span class="o">=</span> <span class="n">Region</span><span class="p">(</span><span class="mf">256</span><span class="p">,</span> <span class="mf">256</span><span class="p">,</span> <span class="s">'https://somesim.cap/uuid'</span><span class="p">,</span> <span class="s">'EnableSimulator,TeleportFinish,CrossedRegion'</span><span class="p">,</span> <span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mf">13000</span><span class="p">,</span> <span class="mf">650000000</span><span class="p">,</span> <span class="p">{</span><span class="s">'agent_id'</span><span class="p">:</span><span class="s">'00000000-0000-0000-0000-000000000000'</span><span class="p">,</span> <span class="s">'session_id'</span><span class="p">:</span><span class="s">'00000000-0000-0000-0000-000000000000'</span><span class="p">,</span> <span class="s">'secure_session_id:'</span><span class="mf">00000000</span><span class="o">-</span><span class="mf">0000</span><span class="o">-</span><span class="mf">0000</span><span class="o">-</span><span class="mf">0000</span><span class="o">-</span><span class="mf">000000000000</span><span class="s">'})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Start the udp and event queue connections to the region</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">region</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Sample implementations: examples/sample_region_connect.py
|
||||
Tests: tests/region.txt, tests/test_region.py</p>
|
||||
<p>initialize a region</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.connect">
|
||||
<tt class="descname">connect</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.connect" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>connect to the udp circuit code and event queue</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.connect_child">
|
||||
<tt class="descname">connect_child</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.connect_child" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>connect to the a child region udp circuit code</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.enable_child_simulator">
|
||||
<tt class="descname">enable_child_simulator</tt><big>(</big><em>IP</em>, <em>Port</em>, <em>Handle</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.enable_child_simulator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.enqueue_message">
|
||||
<tt class="descname">enqueue_message</tt><big>(</big><em>packet</em>, <em>reliable=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.enqueue_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>queues packets for the messaging system to send</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.logout">
|
||||
<tt class="descname">logout</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.logout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a logout packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.onRegionHandshake">
|
||||
<tt class="descname">onRegionHandshake</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.onRegionHandshake" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>handles the response to receiving a RegionHandshake packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.onStartPingCheck">
|
||||
<tt class="descname">onStartPingCheck</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.onStartPingCheck" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends the CompletePingCheck packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.sendAgentUpdate">
|
||||
<tt class="descname">sendAgentUpdate</tt><big>(</big><em>BodyRotation=(0.0</em>, <em>0.0</em>, <em>0.0</em>, <em>1.0)</em>, <em>HeadRotation=(0.0</em>, <em>0.0</em>, <em>0.0</em>, <em>1.0)</em>, <em>State=0</em>, <em>CameraCenter=(0.0</em>, <em>0.0</em>, <em>0.0)</em>, <em>CameraAtAxis=(0.0</em>, <em>0.0</em>, <em>0.0)</em>, <em>CameraLeftAxis=(0.0</em>, <em>0.0</em>, <em>0.0)</em>, <em>CameraUpAxis=(0.0</em>, <em>0.0</em>, <em>0.0)</em>, <em>Far=0</em>, <em>ControlFlags=0</em>, <em>Flags=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendAgentUpdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends an AgentUpdate packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.sendCompleteAgentMovement">
|
||||
<tt class="descname">sendCompleteAgentMovement</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendCompleteAgentMovement" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>initializing on a simulator requires sending CompleteAgentMovement, also required on teleport</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.sendCompletePingCheck">
|
||||
<tt class="descname">sendCompletePingCheck</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendCompletePingCheck" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends a CompletePingCheck packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.sendRegionHandshakeReply">
|
||||
<tt class="descname">sendRegionHandshakeReply</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendRegionHandshakeReply" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends a RegionHandshake packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.sendUUIDNameRequest">
|
||||
<tt class="descname">sendUUIDNameRequest</tt><big>(</big><em>agent_ids=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendUUIDNameRequest" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>sends a packet requesting the name corresponding to a UUID</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.sendUseCircuitCode">
|
||||
<tt class="descname">sendUseCircuitCode</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendUseCircuitCode" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>initializing on a simulator requires announcing the circuit code an agent will use</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.send_message">
|
||||
<tt class="descname">send_message</tt><big>(</big><em>packet</em>, <em>reliable=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.send_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a packet to the host</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.send_message_next">
|
||||
<tt class="descname">send_message_next</tt><big>(</big><em>packet</em>, <em>reliable=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.send_message_next" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>inserts this packet at the fron of the queue</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.Region.send_reliable">
|
||||
<tt class="descname">send_reliable</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.send_reliable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>send a reliable packet to the host</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.region.RegionSeedCapability">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.region.</tt><tt class="descname">RegionSeedCapability</tt><big>(</big><em>name</em>, <em>public_url</em>, <em>restclient=None</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a seed capability which is able to retrieve other capabilities</p>
|
||||
<p>initialize the capability</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.RegionSeedCapability.GET">
|
||||
<tt class="descname">GET</tt><big>(</big><em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability.GET" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>call this capability, return the parsed result</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.RegionSeedCapability.POST">
|
||||
<tt class="descname">POST</tt><big>(</big><em>payload</em>, <em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability.POST" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>call this capability, return the parsed result</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.region.RegionSeedCapability.get">
|
||||
<tt class="descname">get</tt><big>(</big><em>names=</em><span class="optional">[</span><span class="optional">]</span>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>if this is a seed cap we can retrieve other caps here</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="settings.html" title="settings"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="permissions.html" title="permissions"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,129 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>settings — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="stdlib_client" href="stdlib_client.html" />
|
||||
<link rel="prev" title="region" href="region.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="stdlib_client.html" title="stdlib_client"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="region.html" title="region"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="region.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">region</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="stdlib_client.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">stdlib_client</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/settings.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.settings">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">settings</span></tt><a class="headerlink" href="#module-pyogp.lib.base.settings" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.settings.Settings">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.settings.</tt><tt class="descname">Settings</tt><big>(</big><em>quiet_logging=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.settings.Settings" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>some lovely configurable settings</p>
|
||||
<p>These are applied application wide, and can be
|
||||
overridden at any time in a specific instance</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.settings.Settings.get_default_xmlrpc_login_parameters">
|
||||
<tt class="descname">get_default_xmlrpc_login_parameters</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.settings.Settings.get_default_xmlrpc_login_parameters" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>returns some default login params</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="stdlib_client.html" title="stdlib_client"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="region.html" title="region"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,149 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>stdlib_client — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="template" href="template.html" />
|
||||
<link rel="prev" title="settings" href="settings.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template.html" title="template"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="settings.html" title="settings"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="settings.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">settings</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="template.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">template</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/stdlib_client.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.network.stdlib_client">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">stdlib_client</span></tt><a class="headerlink" href="#module-pyogp.lib.base.network.stdlib_client" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.network.stdlib_client.StdLibClient">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.network.stdlib_client.</tt><tt class="descname">StdLibClient</tt><a class="headerlink" href="#pyogp.lib.base.network.stdlib_client.StdLibClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>implement a REST client on top of urllib2</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.network.stdlib_client.StdLibClient.GET">
|
||||
<tt class="descname">GET</tt><big>(</big><em>url</em>, <em>headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.network.stdlib_client.StdLibClient.GET" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>GET a resource</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.network.stdlib_client.StdLibClient.POST">
|
||||
<tt class="descname">POST</tt><big>(</big><em>url</em>, <em>data</em>, <em>headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.network.stdlib_client.StdLibClient.POST" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>POST data to a resource</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.network.stdlib_client.EventletClient">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.network.stdlib_client.</tt><tt class="descname">EventletClient</tt><a class="headerlink" href="#pyogp.lib.base.network.stdlib_client.EventletClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>implement a REST client on top of eventlet.httpc</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.network.stdlib_client.EventletClient.GET">
|
||||
<tt class="descname">GET</tt><big>(</big><em>url</em>, <em>headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.network.stdlib_client.EventletClient.GET" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>GET a resource</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.network.stdlib_client.EventletClient.POST">
|
||||
<tt class="descname">POST</tt><big>(</big><em>url</em>, <em>data</em>, <em>headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.network.stdlib_client.EventletClient.POST" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>POST data to a resource</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template.html" title="template"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="settings.html" title="settings"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,343 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>template — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="template_dict" href="template_dict.html" />
|
||||
<link rel="prev" title="stdlib_client" href="stdlib_client.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template_dict.html" title="template_dict"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="stdlib_client.html" title="stdlib_client"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="stdlib_client.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">stdlib_client</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="template_dict.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">template_dict</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/template.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.template">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">template</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.template" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template.MsgData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message that is being created that will be
|
||||
serialized and sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MsgData.add_block">
|
||||
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgData.add_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MsgData.add_data">
|
||||
<tt class="descname">add_data</tt><big>(</big><em>block_name</em>, <em>var_name</em>, <em>data</em>, <em>data_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgData.add_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MsgData.get_block">
|
||||
<tt class="descname">get_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgData.get_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template.MsgBlockType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgBlockType</tt><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.template.MsgBlockType.MBT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MBT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockType.MBT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateVariable">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MessageTemplateVariable</tt><big>(</big><em>name</em>, <em>tp</em>, <em>size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateVariable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>TODO: Add docstring</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateVariable.get_name">
|
||||
<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateVariable.get_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateVariable.get_type">
|
||||
<tt class="descname">get_type</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateVariable.get_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateVariable.get_type_as_string">
|
||||
<tt class="descname">get_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateVariable.get_type_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MessageTemplateBlock</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>TODO: Add docstring</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.add_variable">
|
||||
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.add_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_block_number">
|
||||
<tt class="descname">get_block_number</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_block_number" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_block_type">
|
||||
<tt class="descname">get_block_type</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_block_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_block_type_as_string">
|
||||
<tt class="descname">get_block_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_block_type_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_name">
|
||||
<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_variable">
|
||||
<tt class="descname">get_variable</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_variables">
|
||||
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.template.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.template.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MessageTemplate</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.add_block">
|
||||
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.add_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_block">
|
||||
<tt class="descname">get_block</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_blocks">
|
||||
<tt class="descname">get_blocks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_blocks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_deprecation">
|
||||
<tt class="descname">get_deprecation</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_deprecation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_deprecation_as_string">
|
||||
<tt class="descname">get_deprecation_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_deprecation_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_frequency">
|
||||
<tt class="descname">get_frequency</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_frequency" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_frequency_as_string">
|
||||
<tt class="descname">get_frequency_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_frequency_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_encoding">
|
||||
<tt class="descname">get_message_encoding</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_encoding" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_encoding_as_string">
|
||||
<tt class="descname">get_message_encoding_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_encoding_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_hex_num">
|
||||
<tt class="descname">get_message_hex_num</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_hex_num" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_number">
|
||||
<tt class="descname">get_message_number</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_number" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_trust">
|
||||
<tt class="descname">get_message_trust</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_trust" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_trust_as_string">
|
||||
<tt class="descname">get_message_trust_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_trust_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_name">
|
||||
<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template.MsgVariableData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgVariableData</tt><big>(</big><em>name</em>, <em>data</em>, <em>var_type=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgVariableData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message Block variable that is being created that will be
|
||||
serialized and sent</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MsgVariableData.get_data_as_string">
|
||||
<tt class="descname">get_data_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgVariableData.get_data_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MsgVariableData.get_var_type_as_string">
|
||||
<tt class="descname">get_var_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgVariableData.get_var_type_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template.MsgBlockData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgBlockData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message block that is being created that will be
|
||||
serialized and sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MsgBlockData.add_variable">
|
||||
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockData.add_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MsgBlockData.get_variable">
|
||||
<tt class="descname">get_variable</tt><big>(</big><em>var_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockData.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template.MsgBlockData.get_variables">
|
||||
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockData.get_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template_dict.html" title="template_dict"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="stdlib_client.html" title="stdlib_client"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,189 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>template_dict — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="template_parser" href="template_parser.html" />
|
||||
<link rel="prev" title="template" href="template.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template_parser.html" title="template_parser"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template.html" title="template"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="template.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">template</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="template_parser.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">template_parser</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/template_dict.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.template_dict">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">template_dict</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.template_dict" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_dict.MessageTemplateParser">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_dict.</tt><tt class="descname">MessageTemplateParser</tt><big>(</big><em>template_file</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.MessageTemplateParser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>a parser which parses the message template and creates MessageTemplate objects
|
||||
which are stored in self.message_templates</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_dict.MsgFrequency">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_dict.</tt><tt class="descname">MsgFrequency</tt><a class="headerlink" href="#pyogp.lib.base.message.template_dict.MsgFrequency" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_dict.EndianType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_dict.</tt><tt class="descname">EndianType</tt><a class="headerlink" href="#pyogp.lib.base.message.template_dict.EndianType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_dict.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_dict.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.template_dict.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.template_dict.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_dict.TemplateDictionary">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_dict.</tt><tt class="descname">TemplateDictionary</tt><big>(</big><em>template_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.TemplateDictionary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>the dictionary with all known templates</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template_dict.TemplateDictionary.build_dictionaries">
|
||||
<tt class="descname">build_dictionaries</tt><big>(</big><em>template_list</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.TemplateDictionary.build_dictionaries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template_dict.TemplateDictionary.build_message_ids">
|
||||
<tt class="descname">build_message_ids</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.TemplateDictionary.build_message_ids" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template_dict.TemplateDictionary.get_template">
|
||||
<tt class="descname">get_template</tt><big>(</big><em>template_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.TemplateDictionary.get_template" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template_dict.TemplateDictionary.get_template_by_pair">
|
||||
<tt class="descname">get_template_by_pair</tt><big>(</big><em>frequency</em>, <em>num</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.TemplateDictionary.get_template_by_pair" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template_dict.TemplateDictionary.get_template_list">
|
||||
<tt class="descname">get_template_list</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.TemplateDictionary.get_template_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_dict.DataPacker">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_dict.</tt><tt class="descname">DataPacker</tt><a class="headerlink" href="#pyogp.lib.base.message.template_dict.DataPacker" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.template_dict.DataPacker.pack_data">
|
||||
<tt class="descname">pack_data</tt><big>(</big><em>data</em>, <em>data_type</em>, <em>endian_type=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_dict.DataPacker.pack_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template_parser.html" title="template_parser"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template.html" title="template"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,170 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>template_parser — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="types" href="types.html" />
|
||||
<link rel="prev" title="template_dict" href="template_dict.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="types.html" title="types"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template_dict.html" title="template_dict"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="template_dict.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">template_dict</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="types.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">types</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/template_parser.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.template_parser">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">template_parser</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.template_parser" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MsgTrust">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_parser.</tt><tt class="descname">MsgTrust</tt><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MsgTrust" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MessageTemplateParser">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_parser.</tt><tt class="descname">MessageTemplateParser</tt><big>(</big><em>template_file</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MessageTemplateParser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>a parser which parses the message template and creates MessageTemplate objects
|
||||
which are stored in self.message_templates</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MsgDeprecation">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_parser.</tt><tt class="descname">MsgDeprecation</tt><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MsgDeprecation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MsgBlockType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_parser.</tt><tt class="descname">MsgBlockType</tt><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MsgBlockType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MsgBlockType.MBT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MBT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MsgBlockType.MBT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MsgFrequency">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_parser.</tt><tt class="descname">MsgFrequency</tt><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MsgFrequency" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_parser.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.template_parser.MsgEncoding">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.template_parser.</tt><tt class="descname">MsgEncoding</tt><a class="headerlink" href="#pyogp.lib.base.message.template_parser.MsgEncoding" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="types.html" title="types"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template_dict.html" title="template_dict"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,181 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>types — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="udpdeserializer" href="udpdeserializer.html" />
|
||||
<link rel="prev" title="template_parser" href="template_parser.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpdeserializer.html" title="udpdeserializer"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template_parser.html" title="template_parser"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="template_parser.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">template_parser</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="udpdeserializer.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">udpdeserializer</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/types.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.types">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">types</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.types" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.PackFlags">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">PackFlags</tt><a class="headerlink" href="#pyogp.lib.base.message.types.PackFlags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.MsgTrust">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">MsgTrust</tt><a class="headerlink" href="#pyogp.lib.base.message.types.MsgTrust" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.EndianType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">EndianType</tt><a class="headerlink" href="#pyogp.lib.base.message.types.EndianType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.MsgDeprecation">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">MsgDeprecation</tt><a class="headerlink" href="#pyogp.lib.base.message.types.MsgDeprecation" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.MsgBlockType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">MsgBlockType</tt><a class="headerlink" href="#pyogp.lib.base.message.types.MsgBlockType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.types.MsgBlockType.MBT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MBT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.types.MsgBlockType.MBT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.MsgFrequency">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">MsgFrequency</tt><a class="headerlink" href="#pyogp.lib.base.message.types.MsgFrequency" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.types.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.types.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.types.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.PacketLayout">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">PacketLayout</tt><a class="headerlink" href="#pyogp.lib.base.message.types.PacketLayout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.types.MsgEncoding">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.types.</tt><tt class="descname">MsgEncoding</tt><a class="headerlink" href="#pyogp.lib.base.message.types.MsgEncoding" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpdeserializer.html" title="udpdeserializer"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="template_parser.html" title="template_parser"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,309 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>udpdeserializer — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="udpdispatcher" href="udpdispatcher.html" />
|
||||
<link rel="prev" title="types" href="types.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpdispatcher.html" title="udpdispatcher"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="types.html" title="types"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="types.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">types</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="udpdispatcher.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">udpdispatcher</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/udpdeserializer.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.udpdeserializer">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">udpdeserializer</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.udpdeserializer" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.PackFlags">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">PackFlags</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.PackFlags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.UDPPacketDeserializer">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">UDPPacketDeserializer</tt><big>(</big><em>packet_handler=None</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.UDPPacketDeserializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.UDPPacketDeserializer.deserialize">
|
||||
<tt class="descname">deserialize</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.UDPPacketDeserializer.deserialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.UDPPacketDeserializer.zero_code_expand">
|
||||
<tt class="descname">zero_code_expand</tt><big>(</big><em>msg_buf</em>, <em>msg_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.UDPPacketDeserializer.zero_code_expand" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>made this call more generic due to changes in how zero_code_expand is called.
|
||||
no more header issues in actual call. Its taken care of earlier in process</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.DataUnpacker">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">DataUnpacker</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.DataUnpacker" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.DataUnpacker.unpack_data">
|
||||
<tt class="descname">unpack_data</tt><big>(</big><em>data</em>, <em>data_type</em>, <em>start_index=-1</em>, <em>var_size=-1</em>, <em>endian_type=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.DataUnpacker.unpack_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">MsgData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message that is being created that will be
|
||||
serialized and sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgData.add_block">
|
||||
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgData.add_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgData.add_data">
|
||||
<tt class="descname">add_data</tt><big>(</big><em>block_name</em>, <em>var_name</em>, <em>data</em>, <em>data_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgData.add_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgData.get_block">
|
||||
<tt class="descname">get_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgData.get_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.UDPPacket">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">UDPPacket</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.UDPPacket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a UDP packet</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.UDPPacket.add_ack">
|
||||
<tt class="descname">add_ack</tt><big>(</big><em>packet_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.UDPPacket.add_ack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.UDPPacket.data">
|
||||
<tt class="descname">data</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.UDPPacket.data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>a string representation of a packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.UDPPacket.get_var">
|
||||
<tt class="descname">get_var</tt><big>(</big><em>block</em>, <em>variable</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.UDPPacket.get_var" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgBlockType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">MsgBlockType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgBlockType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgBlockType.MBT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MBT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgBlockType.MBT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.EndianType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">EndianType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.EndianType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgFrequency">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">MsgFrequency</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgFrequency" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.PacketLayout">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">PacketLayout</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.PacketLayout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.TemplateDictionary">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">TemplateDictionary</tt><big>(</big><em>template_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.TemplateDictionary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>the dictionary with all known templates</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.TemplateDictionary.build_dictionaries">
|
||||
<tt class="descname">build_dictionaries</tt><big>(</big><em>template_list</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.TemplateDictionary.build_dictionaries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.TemplateDictionary.build_message_ids">
|
||||
<tt class="descname">build_message_ids</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.TemplateDictionary.build_message_ids" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.TemplateDictionary.get_template">
|
||||
<tt class="descname">get_template</tt><big>(</big><em>template_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.TemplateDictionary.get_template" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.TemplateDictionary.get_template_by_pair">
|
||||
<tt class="descname">get_template_by_pair</tt><big>(</big><em>frequency</em>, <em>num</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.TemplateDictionary.get_template_by_pair" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.TemplateDictionary.get_template_list">
|
||||
<tt class="descname">get_template_list</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.TemplateDictionary.get_template_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgVariableData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">MsgVariableData</tt><big>(</big><em>name</em>, <em>data</em>, <em>var_type=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgVariableData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message Block variable that is being created that will be
|
||||
serialized and sent</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgVariableData.get_data_as_string">
|
||||
<tt class="descname">get_data_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgVariableData.get_data_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgVariableData.get_var_type_as_string">
|
||||
<tt class="descname">get_var_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgVariableData.get_var_type_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgBlockData">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdeserializer.</tt><tt class="descname">MsgBlockData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgBlockData" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used as a Message block that is being created that will be
|
||||
serialized and sent.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgBlockData.add_variable">
|
||||
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgBlockData.add_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgBlockData.get_variable">
|
||||
<tt class="descname">get_variable</tt><big>(</big><em>var_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgBlockData.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdeserializer.MsgBlockData.get_variables">
|
||||
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdeserializer.MsgBlockData.get_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpdispatcher.html" title="udpdispatcher"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="types.html" title="types"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,362 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>udpdispatcher — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="udpserializer" href="udpserializer.html" />
|
||||
<link rel="prev" title="udpdeserializer" href="udpdeserializer.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpserializer.html" title="udpserializer"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpdeserializer.html" title="udpdeserializer"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="udpdeserializer.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">udpdeserializer</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="udpserializer.html"
|
||||
title="next chapter"><tt class="docutils literal"><span class="pre">udpserializer</span></tt></a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/udpdispatcher.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.udpdispatcher">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">udpdispatcher</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.udpdispatcher" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.PackFlags">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">PackFlags</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.PackFlags" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacketDeserializer">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">UDPPacketDeserializer</tt><big>(</big><em>packet_handler=None</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacketDeserializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacketDeserializer.deserialize">
|
||||
<tt class="descname">deserialize</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacketDeserializer.deserialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacketDeserializer.zero_code_expand">
|
||||
<tt class="descname">zero_code_expand</tt><big>(</big><em>msg_buf</em>, <em>msg_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacketDeserializer.zero_code_expand" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>made this call more generic due to changes in how zero_code_expand is called.
|
||||
no more header issues in actual call. Its taken care of earlier in process</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.DataUnpacker">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">DataUnpacker</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.DataUnpacker" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.DataUnpacker.unpack_data">
|
||||
<tt class="descname">unpack_data</tt><big>(</big><em>data</em>, <em>data_type</em>, <em>start_index=-1</em>, <em>var_size=-1</em>, <em>endian_type=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.DataUnpacker.unpack_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.CircuitManager">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">CircuitManager</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.CircuitManager" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Manages a collection of circuits and provides some higher-level
|
||||
functionality to do so.</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.CircuitManager.add_circuit">
|
||||
<tt class="descname">add_circuit</tt><big>(</big><em>host</em>, <em>packet_in_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.CircuitManager.add_circuit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.CircuitManager.get_circuit">
|
||||
<tt class="descname">get_circuit</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.CircuitManager.get_circuit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.CircuitManager.get_unacked_circuits">
|
||||
<tt class="descname">get_unacked_circuits</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.CircuitManager.get_unacked_circuits" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.CircuitManager.is_circuit_alive">
|
||||
<tt class="descname">is_circuit_alive</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.CircuitManager.is_circuit_alive" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.CircuitManager.remove_circuit_data">
|
||||
<tt class="descname">remove_circuit_data</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.CircuitManager.remove_circuit_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacketSerializer">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">UDPPacketSerializer</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacketSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an adpater for serializing a IUDPPacket into the UDP message format</p>
|
||||
<p>This class builds messages at its high level, that is, keeping
|
||||
that data in data structure form. A serializer should be used on
|
||||
the message produced by this so that it can be sent over a network.</p>
|
||||
<p>initialize the adapter</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacketSerializer.build_block">
|
||||
<tt class="descname">build_block</tt><big>(</big><em>template_block</em>, <em>message_data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacketSerializer.build_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacketSerializer.serialize">
|
||||
<tt class="descname">serialize</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacketSerializer.serialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Builds the message by serializing the data. Creates a packet ready
|
||||
to be sent.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacketSerializer.set_current_template">
|
||||
<tt class="descname">set_current_template</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacketSerializer.set_current_template" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>establish the template for the current packet</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacket">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">UDPPacket</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacket" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>a UDP packet</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacket.add_ack">
|
||||
<tt class="descname">add_ack</tt><big>(</big><em>packet_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacket.add_ack" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacket.data">
|
||||
<tt class="descname">data</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacket.data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>a string representation of a packet</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPPacket.get_var">
|
||||
<tt class="descname">get_var</tt><big>(</big><em>block</em>, <em>variable</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPPacket.get_var" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.MsgBlockType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">MsgBlockType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.MsgBlockType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.MsgBlockType.MBT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MBT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.MsgBlockType.MBT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.EndianType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">EndianType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.EndianType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.MsgFrequency">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">MsgFrequency</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.MsgFrequency" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.PacketLayout">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">PacketLayout</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.PacketLayout" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Message">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">Message</tt><big>(</big><em>name</em>, <em>*args</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Message.add_block">
|
||||
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Message.add_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Message.add_data">
|
||||
<tt class="descname">add_data</tt><big>(</big><em>block_name</em>, <em>var_name</em>, <em>data</em>, <em>data_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Message.add_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Message.get_block">
|
||||
<tt class="descname">get_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Message.get_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Message.parse_blocks">
|
||||
<tt class="descname">parse_blocks</tt><big>(</big><em>block_list</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Message.parse_blocks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPDispatcher">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">UDPDispatcher</tt><big>(</big><em>udp_client=None</em>, <em>settings=None</em>, <em>packet_handler=None</em>, <em>region=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPDispatcher" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPDispatcher.find_circuit">
|
||||
<tt class="descname">find_circuit</tt><big>(</big><em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPDispatcher.find_circuit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPDispatcher.has_unacked">
|
||||
<tt class="descname">has_unacked</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPDispatcher.has_unacked" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPDispatcher.process_acks">
|
||||
<tt class="descname">process_acks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPDispatcher.process_acks" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>resends all of our messages that were unacked, and acks all
|
||||
the messages that others are waiting to be acked.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPDispatcher.receive_check">
|
||||
<tt class="descname">receive_check</tt><big>(</big><em>host</em>, <em>msg_buf</em>, <em>msg_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPDispatcher.receive_check" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPDispatcher.send_message">
|
||||
<tt class="descname">send_message</tt><big>(</big><em>message</em>, <em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPDispatcher.send_message" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPDispatcher.send_reliable">
|
||||
<tt class="descname">send_reliable</tt><big>(</big><em>message</em>, <em>host</em>, <em>retries</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPDispatcher.send_reliable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Wants to be acked</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.UDPDispatcher.send_retry">
|
||||
<tt class="descname">send_retry</tt><big>(</big><em>message</em>, <em>host</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.UDPDispatcher.send_retry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>This is a retry because we didn’t get acked</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Block">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpdispatcher.</tt><tt class="descname">Block</tt><big>(</big><em>name</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Block.add_variable">
|
||||
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Block.add_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Block.get_variable">
|
||||
<tt class="descname">get_variable</tt><big>(</big><em>var_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Block.get_variable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpdispatcher.Block.get_variables">
|
||||
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpdispatcher.Block.get_variables" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpserializer.html" title="udpserializer"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpdeserializer.html" title="udpdeserializer"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,215 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>udpserializer — Pyogp v0.1 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.1',
|
||||
COLLAPSE_MODINDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="Modules" href="../modules.html" />
|
||||
<link rel="next" title="Unit Tests" href="../unittest.html" />
|
||||
<link rel="prev" title="udpdispatcher" href="udpdispatcher.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
accesskey="I">index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
accesskey="M">modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../unittest.html" title="Unit Tests"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpdispatcher.html" title="udpdispatcher"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sphinxsidebar">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="udpdispatcher.html"
|
||||
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">udpdispatcher</span></tt></a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="../unittest.html"
|
||||
title="next chapter">Unit Tests</a></p>
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="../_sources/modules/udpserializer.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
<div id="searchbox" style="display: none">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="../search.html" method="get">
|
||||
<input type="text" name="q" size="18" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body">
|
||||
|
||||
<div class="section" id="module-pyogp.lib.base.message.udpserializer">
|
||||
<h1><tt class="xref docutils literal"><span class="pre">udpserializer</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.udpserializer" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.UDPPacketSerializer">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpserializer.</tt><tt class="descname">UDPPacketSerializer</tt><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.UDPPacketSerializer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>an adpater for serializing a IUDPPacket into the UDP message format</p>
|
||||
<p>This class builds messages at its high level, that is, keeping
|
||||
that data in data structure form. A serializer should be used on
|
||||
the message produced by this so that it can be sent over a network.</p>
|
||||
<p>initialize the adapter</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.UDPPacketSerializer.build_block">
|
||||
<tt class="descname">build_block</tt><big>(</big><em>template_block</em>, <em>message_data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.UDPPacketSerializer.build_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.UDPPacketSerializer.serialize">
|
||||
<tt class="descname">serialize</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.UDPPacketSerializer.serialize" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>Builds the message by serializing the data. Creates a packet ready
|
||||
to be sent.</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.UDPPacketSerializer.set_current_template">
|
||||
<tt class="descname">set_current_template</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.UDPPacketSerializer.set_current_template" title="Permalink to this definition">¶</a></dt>
|
||||
<dd>establish the template for the current packet</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.MsgBlockType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpserializer.</tt><tt class="descname">MsgBlockType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.MsgBlockType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.MsgBlockType.MBT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MBT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.MsgBlockType.MBT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.EndianType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpserializer.</tt><tt class="descname">EndianType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.EndianType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.MsgType">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpserializer.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.MsgType" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="classmethod">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.MsgType.MVT_as_string">
|
||||
<em class="property">
|
||||
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.TemplateDictionary">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpserializer.</tt><tt class="descname">TemplateDictionary</tt><big>(</big><em>template_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.TemplateDictionary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>the dictionary with all known templates</p>
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.TemplateDictionary.build_dictionaries">
|
||||
<tt class="descname">build_dictionaries</tt><big>(</big><em>template_list</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.TemplateDictionary.build_dictionaries" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.TemplateDictionary.build_message_ids">
|
||||
<tt class="descname">build_message_ids</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.TemplateDictionary.build_message_ids" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.TemplateDictionary.get_template">
|
||||
<tt class="descname">get_template</tt><big>(</big><em>template_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.TemplateDictionary.get_template" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.TemplateDictionary.get_template_by_pair">
|
||||
<tt class="descname">get_template_by_pair</tt><big>(</big><em>frequency</em>, <em>num</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.TemplateDictionary.get_template_by_pair" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.TemplateDictionary.get_template_list">
|
||||
<tt class="descname">get_template_list</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.TemplateDictionary.get_template_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="class">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.DataPacker">
|
||||
<em class="property">
|
||||
class </em><tt class="descclassname">pyogp.lib.base.message.udpserializer.</tt><tt class="descname">DataPacker</tt><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.DataPacker" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="method">
|
||||
<dt id="pyogp.lib.base.message.udpserializer.DataPacker.pack_data">
|
||||
<tt class="descname">pack_data</tt><big>(</big><em>data</em>, <em>data_type</em>, <em>endian_type=''</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.DataPacker.pack_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="related">
|
||||
<h3>Navigation</h3>
|
||||
<ul>
|
||||
<li class="right" style="margin-right: 10px">
|
||||
<a href="../genindex.html" title="General Index"
|
||||
>index</a></li>
|
||||
<li class="right" >
|
||||
<a href="../modindex.html" title="Global Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../unittest.html" title="Unit Tests"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="udpdispatcher.html" title="udpdispatcher"
|
||||
>previous</a> |</li>
|
||||
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
||||
<li><a href="../modules.html" >Modules</a> »</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer">
|
||||
© Copyright 2009, Pyogp team.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user