<!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>Module: parallel.controller.heartmonitor — IPython 2.3.0 documentation</title> <link rel="stylesheet" href="../../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '2.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <link rel="top" title="IPython 2.3.0 documentation" href="../../index.html" /> <link rel="up" title="The IPython API" href="../index.html" /> <link rel="next" title="Module: parallel.controller.hub" href="IPython.parallel.controller.hub.html" /> <link rel="prev" title="Module: parallel.controller.dictdb" href="IPython.parallel.controller.dictdb.html" /> </head> <body> <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px"> <a href="http://ipython.org/"><img src="../../_static/logo.png" border="0" alt="IPython Documentation"/></a> </div> <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="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="IPython.parallel.controller.hub.html" title="Module: parallel.controller.hub" accesskey="N">next</a> |</li> <li class="right" > <a href="IPython.parallel.controller.dictdb.html" title="Module: parallel.controller.dictdb" accesskey="P">previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" accesskey="U">The IPython API</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Module: <tt class="docutils literal"><span class="pre">parallel.controller.heartmonitor</span></tt></a><ul> <li><a class="reference internal" href="#classes">2 Classes</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="IPython.parallel.controller.dictdb.html" title="previous chapter">Module: <tt class="docutils literal"><span class="pre">parallel.controller.dictdb</span></tt></a></p> <h4>Next topic</h4> <p class="topless"><a href="IPython.parallel.controller.hub.html" title="next chapter">Module: <tt class="docutils literal"><span class="pre">parallel.controller.hub</span></tt></a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/generated/IPython.parallel.controller.heartmonitor.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" /> <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-IPython.parallel.controller.heartmonitor"> <span id="module-parallel-controller-heartmonitor"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">parallel.controller.heartmonitor</span></tt><a class="headerlink" href="#module-IPython.parallel.controller.heartmonitor" title="Permalink to this headline">¶</a></h1> <p>A multi-heart Heartbeat system using PUB and ROUTER sockets. pings are sent out on the PUB, and hearts are tracked based on their DEALER identities.</p> <p>Authors:</p> <ul class="simple"> <li>Min RK</li> </ul> <div class="section" id="classes"> <h2>2 Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="IPython.parallel.controller.heartmonitor.Heart"> <em class="property">class </em><tt class="descclassname">IPython.parallel.controller.heartmonitor.</tt><tt class="descname">Heart</tt><big>(</big><em>in_addr</em>, <em>out_addr</em>, <em>mon_addr=None</em>, <em>in_type=2</em>, <em>out_type=5</em>, <em>mon_type=1</em>, <em>heart_id=None</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.heartmonitor.Heart" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="http://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p> <p>A basic heart object for responding to a HeartMonitor. This is a simple wrapper with defaults for the most common Device model for responding to heartbeats.</p> <p>It simply builds a threadsafe zmq.FORWARDER Device, defaulting to using SUB/DEALER for in/out.</p> <p>You can specify the DEALER’s IDENTITY via the optional heart_id argument.</p> <dl class="method"> <dt id="IPython.parallel.controller.heartmonitor.Heart.__init__"> <tt class="descname">__init__</tt><big>(</big><em>in_addr</em>, <em>out_addr</em>, <em>mon_addr=None</em>, <em>in_type=2</em>, <em>out_type=5</em>, <em>mon_type=1</em>, <em>heart_id=None</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.heartmonitor.Heart.__init__" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> <dl class="class"> <dt id="IPython.parallel.controller.heartmonitor.HeartMonitor"> <em class="property">class </em><tt class="descclassname">IPython.parallel.controller.heartmonitor.</tt><tt class="descname">HeartMonitor</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.heartmonitor.HeartMonitor" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="IPython.config.configurable.html#IPython.config.configurable.LoggingConfigurable" title="IPython.config.configurable.LoggingConfigurable"><tt class="xref py py-class docutils literal"><span class="pre">IPython.config.configurable.LoggingConfigurable</span></tt></a></p> <p>A basic HeartMonitor class pingstream: a PUB stream pongstream: an ROUTER stream period: the period of the heartbeat in milliseconds</p> <dl class="method"> <dt id="IPython.parallel.controller.heartmonitor.HeartMonitor.__init__"> <tt class="descname">__init__</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.heartmonitor.HeartMonitor.__init__" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.heartmonitor.HeartMonitor.add_heart_failure_handler"> <tt class="descname">add_heart_failure_handler</tt><big>(</big><em>handler</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.heartmonitor.HeartMonitor.add_heart_failure_handler" title="Permalink to this definition">¶</a></dt> <dd><p>add a new handler for heart failure</p> </dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.heartmonitor.HeartMonitor.add_new_heart_handler"> <tt class="descname">add_new_heart_handler</tt><big>(</big><em>handler</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.heartmonitor.HeartMonitor.add_new_heart_handler" title="Permalink to this definition">¶</a></dt> <dd><p>add a new handler for new hearts</p> </dd></dl> <dl class="method"> <dt id="IPython.parallel.controller.heartmonitor.HeartMonitor.handle_pong"> <tt class="descname">handle_pong</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#IPython.parallel.controller.heartmonitor.HeartMonitor.handle_pong" title="Permalink to this definition">¶</a></dt> <dd><p>a heart just beat</p> </dd></dl> </dd></dl> </div> </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="../../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="IPython.parallel.controller.hub.html" title="Module: parallel.controller.hub" >next</a> |</li> <li class="right" > <a href="IPython.parallel.controller.dictdb.html" title="Module: parallel.controller.dictdb" >previous</a> |</li> <li><a href="http://ipython.org">home</a>| </li> <li><a href="../../search.html">search</a>| </li> <li><a href="../../index.html">documentation </a> »</li> <li><a href="../index.html" >The IPython API</a> »</li> </ul> </div> <div class="footer"> © Copyright The IPython Development Team. Last updated on Jul 14, 2015. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. </div> </body> </html>