215 lines
11 KiB
HTML
215 lines
11 KiB
HTML
<!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.lib.base 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.lib.base 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.lib.base 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.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>, <em>message_template=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>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.udpserializer.UDPMessageSerializer">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.udpserializer.</tt><tt class="descname">UDPMessageSerializer</tt><big>(</big><em>message_template=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.UDPMessageSerializer" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>an adpater for serializing a IUDPMessage 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.UDPMessageSerializer.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.UDPMessageSerializer.build_block" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.udpserializer.UDPMessageSerializer.serialize">
|
|
<tt class="descname">serialize</tt><big>(</big><em>context</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.UDPMessageSerializer.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.UDPMessageSerializer.set_current_template">
|
|
<tt class="descname">set_current_template</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.udpserializer.UDPMessageSerializer.set_current_template" title="Permalink to this definition">¶</a></dt>
|
|
<dd>establish the template for the current packet</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.lib.base 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.2.
|
|
</div>
|
|
</body>
|
|
</html> |