<!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>BuildSetSummaryNotifierMixin — Buildbot 0.8.12 documentation</title>
<link rel="stylesheet" href="../_static/agogo.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.8.12',
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="shortcut icon" href="../_static/buildbot.ico"/>
<link rel="top" title="Buildbot 0.8.12 documentation" href="../index.html" />
<link rel="up" title="Classes" href="classes.html" />
<link rel="next" title="RemoteCommands" href="cls-remotecommands.html" />
<link rel="prev" title="BuildFactory" href="cls-buildfactory.html" />
</head>
<body role="document">
<div class="header-wrapper" role="banner">
<div class="header">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/header-text-transparent.png" alt="Logo"/>
</a></p>
<div class="headertitle"><a
href="../index.html">Buildbot 0.8.12 documentation</a></div>
<div class="rel" role="navigation" aria-label="related navigation">
<a href="cls-buildfactory.html" title="BuildFactory"
accesskey="P">previous</a> |
<a href="cls-remotecommands.html" title="RemoteCommands"
accesskey="N">next</a> |
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="../genindex.html" title="General Index"
accesskey="I">index</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="buildsetsummarynotifiermixin">
<h1>BuildSetSummaryNotifierMixin<a class="headerlink" href="#buildsetsummarynotifiermixin" title="Permalink to this headline">¶</a></h1>
<p>Some status notifiers will want to report the status of all builds all at once
for a particular buildset, instead of reporting each build individually as it
finishes. In order to do this, the status notifier must wait for all builds to
finish, collect their results, and then report a kind of summary on all of the
collected results. The act of waiting for and collecting the results of all of
the builders is implemented via
<code class="xref py py-class docutils literal"><span class="pre">BuildSetSummaryNotifierMixin</span></code>, to be subclassed by a status
notification implementation.</p>
<div class="section" id="id1">
<h2>BuildSetSummaryNotifierMixin<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt>
<code class="descname">buildbot.status.buildset.BuildSetSummaryNotifierMixin::</code></dt>
<dd><p>This class provides some helper methods for implementing a status
notification that provides notifications for all build results for a
buildset at once.</p>
<p>This class provides the following methods:</p>
<dl class="method">
<dt id="buildbot.status.buildset.summarySubscribe">
<code class="descclassname">buildbot.status.buildset.</code><code class="descname">summarySubscribe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#buildbot.status.buildset.summarySubscribe" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this to start receiving <a class="reference internal" href="#buildbot.status.buildset.sendBuildSetSummary" title="buildbot.status.buildset.sendBuildSetSummary"><code class="xref py py-meth docutils literal"><span class="pre">sendBuildSetSummary</span></code></a> callbacks.
Typically this will be called from the subclass's <code class="xref py py-meth docutils literal"><span class="pre">startService</span></code>
method.</p>
</dd></dl>
<dl class="method">
<dt id="buildbot.status.buildset.summaryUnsubscribe">
<code class="descclassname">buildbot.status.buildset.</code><code class="descname">summaryUnsubscribe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#buildbot.status.buildset.summaryUnsubscribe" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this to stop receiving <a class="reference internal" href="#buildbot.status.buildset.sendBuildSetSummary" title="buildbot.status.buildset.sendBuildSetSummary"><code class="xref py py-meth docutils literal"><span class="pre">sendBuildSetSummary</span></code></a> callbacks.
Typically this will be called from the subclass's <code class="xref py py-meth docutils literal"><span class="pre">stopService</span></code>
method.</p>
</dd></dl>
<p>The following methods are hooks to be implemented by the subclass.</p>
<dl class="method">
<dt id="buildbot.status.buildset.sendBuildSetSummary">
<code class="descclassname">buildbot.status.buildset.</code><code class="descname">sendBuildSetSummary</code><span class="sig-paren">(</span><em>buildset</em>, <em>builds</em><span class="sig-paren">)</span><a class="headerlink" href="#buildbot.status.buildset.sendBuildSetSummary" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>buildset</strong> -- A <code class="xref py py-class docutils literal"><span class="pre">BuildSet</span></code> object</li>
<li><strong>builds</strong> -- A list of <code class="xref py py-class docutils literal"><span class="pre">Build</span></code> objects</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>This method must be implemented by the subclass. This method is called
when all of the builds for a buildset have finished, and it should
initiate sending a summary status for the buildset.</p>
</dd></dl>
<p>The following attributes must be provided by the subclass.</p>
<dl class="attribute">
<dt id="buildbot.status.buildset.master">
<code class="descclassname">buildbot.status.buildset.</code><code class="descname">master</code><a class="headerlink" href="#buildbot.status.buildset.master" title="Permalink to this definition">¶</a></dt>
<dd><p>This must point to the <code class="xref py py-class docutils literal"><span class="pre">BuildMaster</span></code> object.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h3>Table Of Contents</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Buildbot Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../manual/index.html">Buildbot Manual</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Buildbot Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="master-overview.html">Master Organization</a></li>
<li class="toctree-l2"><a class="reference internal" href="definitions.html">Definitions</a></li>
<li class="toctree-l2"><a class="reference internal" href="style.html">Buildbot Coding Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="tests.html">Buildbot's Test Suite</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="database.html">Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="results.html">Build Result Codes</a></li>
<li class="toctree-l2"><a class="reference internal" href="formats.html">File Formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="webstatus.html">Web Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="master-slave.html">Master-Slave API</a></li>
<li class="toctree-l2"><a class="reference internal" href="encodings.html">String Encodings</a></li>
<li class="toctree-l2"><a class="reference internal" href="metrics.html">Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins-publish.html">How to package Buildbot plugins</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="classes.html">Classes</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="cls-buildfactory.html">BuildFactory</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">BuildSetSummaryNotifierMixin</a><ul class="simple">
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="cls-remotecommands.html">RemoteCommands</a></li>
<li class="toctree-l3"><a class="reference internal" href="cls-buildsteps.html">BuildSteps</a></li>
<li class="toctree-l3"><a class="reference internal" href="cls-forcesched.html">ForceScheduler</a></li>
<li class="toctree-l3"><a class="reference internal" href="cls-irenderable.html">IRenderable</a></li>
<li class="toctree-l3"><a class="reference internal" href="cls-iproperties.html">IProperties</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../relnotes/index.html">Release Notes for Buildbot 0.8.12</a></li>
</ul>
<div role="search">
<h3 style="margin-top: 1.5em;">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>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<div role="navigation" aria-label="related navigaton">
<a href="cls-buildfactory.html" title="BuildFactory"
>previous</a> |
<a href="cls-remotecommands.html" title="RemoteCommands"
>next</a> |
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="../genindex.html" title="General Index"
>index</a>
</div>
<div role="note" aria-label="source link">
<br/>
<a href="../_sources/developer/cls-buildsetsummarynotifiermixin.txt"
rel="nofollow">Show Source</a>
</div>
</div>
<div class="right">
<div class="footer" role="contentinfo">
© Copyright Buildbot Team Members.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.1.
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>
