189 lines
9.9 KiB
HTML
189 lines
9.9 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>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.AppEventEnum">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.event_system.</tt><tt class="descname">AppEventEnum</tt><a class="headerlink" href="#pyogp.lib.base.event_system.AppEventEnum" title="Permalink to this definition">¶</a></dt>
|
|
<dd>enumeration of application level events and their keys</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.event_system.AppEventsHandler">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.event_system.</tt><tt class="descname">AppEventsHandler</tt><big>(</big><em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.AppEventsHandler" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>general class handling individual events</p>
|
|
<p>initialize the AppEventsHandler</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.event_system.AppEventsHandler.handle">
|
|
<tt class="descname">handle</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.AppEventsHandler.handle" title="Permalink to this definition">¶</a></dt>
|
|
<dd>essentially a case statement to pass event data to notifiers</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.event_system.AppEventsHandler.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.AppEventsHandler.is_event_handled" title="Permalink to this definition">¶</a></dt>
|
|
<dd>if the event is being monitored, return True, otherwise, return False</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.event_system.AppEventsHandler.register">
|
|
<tt class="descname">register</tt><big>(</big><em>event_name</em>, <em>timeout=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.AppEventsHandler.register" title="Permalink to this definition">¶</a></dt>
|
|
<dd>create a watcher for a specific event in this event system. the timeout is optional, and defaults to no timeout</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.event_system.AppEvent">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.event_system.</tt><tt class="descname">AppEvent</tt><big>(</big><em>name</em>, <em>payload=None</em>, <em>llsd=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.AppEvent" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>container for an event payload.</p>
|
|
<p>name = name of the event, to which applications will subscribe.
|
|
payload = dict of the contents of the event (key:value)
|
|
<a href="#id1"><span class="problematic" id="id2">**</span></a>kwdargs = key:value pairs</p>
|
|
<p>either payload or <a href="#id3"><span class="problematic" id="id4">**</span></a>kwdargs should be used, not both</p>
|
|
<p>initialize the AppEvent contents</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.event_system.AppEvent.from_llsd">
|
|
<tt class="descname">from_llsd</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.AppEvent.from_llsd" title="Permalink to this definition">¶</a></dt>
|
|
<dd>transform llsd into an event payload</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.event_system.AppEvent.to_llsd">
|
|
<tt class="descname">to_llsd</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.AppEvent.to_llsd" title="Permalink to this definition">¶</a></dt>
|
|
<dd>transform the event payload into llsd</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.event_system.AppEventNotifier">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.event_system.</tt><tt class="descname">AppEventNotifier</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.AppEventNotifier" 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.AppEventNotifier.received">
|
|
<tt class="descname">received</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.event_system.AppEventNotifier.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.AppEventNotifier.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.AppEventNotifier.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.AppEventNotifier.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.AppEventNotifier.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.2.
|
|
</div>
|
|
</body>
|
|
</html> |