[ceph.git] / ceph / src / boost / libs / graph_parallel / doc / html / simple_trigger.html

<?xml version="1.0" encoding="utf-8" ?>
<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
<title>Parallel BGL Simple Triggers</title>
<link rel="stylesheet" href="../../../../rst.css" type="text/css" />
</head>
<body>
<div class="document" id="logo-simple-triggers">
<h1 class="title"><a class="reference external" href="http://www.osl.iu.edu/research/pbgl"><img align="middle" alt="Parallel BGL" class="align-middle" src="pbgl-logo.png" /></a> Simple Triggers</h1>

<!-- Copyright (C) 2004-2008 The Trustees of Indiana University.
Use, modification and distribution is subject to the Boost Software
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt) -->
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li>
<li><a class="reference internal" href="#where-defined" id="id2">Where Defined</a></li>
<li><a class="reference internal" href="#reference" id="id3">Reference</a></li>
</ul>
</div>
<div class="section" id="introduction">
<h1><a class="toc-backref" href="#id1">Introduction</a></h1>
<p>Triggers in the <a class="reference external" href="process_group.html">process group</a> interface are used to asynchronously
receive and process messages destined for distributed data
structures. The trigger interface is relatively versatile, permitting
one to attach any function object to handle requests. The
<tt class="docutils literal"><span class="pre">simple_trigger</span></tt> function simplifies a common case for triggers:
attaching a trigger that invokes a specific member function of the
distributed data structure.</p>
</div>
<div class="section" id="where-defined">
<h1><a class="toc-backref" href="#id2">Where Defined</a></h1>
<p>Header <tt class="docutils literal"><span class="pre">&lt;boost/graph/parallel/simple_trigger.hpp&gt;</span></tt></p>
</div>
<div class="section" id="reference">
<h1><a class="toc-backref" href="#id3">Reference</a></h1>
<blockquote>
<pre class="literal-block">
template&lt;typename ProcessGroup, typename Class, typename T&gt;
  void
  simple_trigger(ProcessGroup&amp; pg, int tag, Class* self,
                 void (Class::*pmf)(int source, int tag, const T&amp; data,
                                    trigger_receive_context context))

template&lt;typename ProcessGroup, typename Class, typename T, typename Result&gt;
  void
  simple_trigger(ProcessGroup&amp; pg, int tag, Class* self,
                 Result (Class::*pmf)(int source, int tag, const T&amp; data,
                                      trigger_receive_context context))
</pre>
</blockquote>
<p>The <tt class="docutils literal"><span class="pre">simple_trigger</span></tt> function registers a trigger that invokes the
given member function (<tt class="docutils literal"><span class="pre">pmf</span></tt>) on the object <tt class="docutils literal"><span class="pre">self</span></tt> whenever a
message is received. If the member function has a return value, then
the trigger has a reply, and can only be used via out-of-band sends
that expect a reply. Otherwise, the member function returns <tt class="docutils literal"><span class="pre">void</span></tt>,
and the function is registered as a normal trigger.</p>
<hr class="docutils" />
<p>Copyright (C) 2007 Douglas Gregor</p>
<p>Copyright (C) 2007 Matthias Troyer</p>
</div>
</div>
<div class="footer">
<hr class="footer" />
Generated on: 2009-05-31 00:21 UTC.
Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.

</div>
</body>
</html>
Commit	Line	Data
7c673cae FG	1	<?xml version="1.0" encoding="utf-8" ?>
	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	4	<head>
	5	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	6	<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
	7	<title>Parallel BGL Simple Triggers</title>
	8	<link rel="stylesheet" href="../../../../rst.css" type="text/css" />
	9	</head>
	10	<body>
	11	<div class="document" id="logo-simple-triggers">
	12	<h1 class="title"><a class="reference external" href="http://www.osl.iu.edu/research/pbgl"><img align="middle" alt="Parallel BGL" class="align-middle" src="pbgl-logo.png" /></a> Simple Triggers</h1>
	13
	14	<!-- Copyright (C) 2004-2008 The Trustees of Indiana University.
	15	Use, modification and distribution is subject to the Boost Software
	16	License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
	17	http://www.boost.org/LICENSE_1_0.txt) -->
	18	<div class="contents topic" id="contents">
	19	<p class="topic-title first">Contents</p>
	20	<ul class="simple">
	21	<li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li>
	22	<li><a class="reference internal" href="#where-defined" id="id2">Where Defined</a></li>
	23	<li><a class="reference internal" href="#reference" id="id3">Reference</a></li>
	24	</ul>
	25	</div>
	26	<div class="section" id="introduction">
	27	<h1><a class="toc-backref" href="#id1">Introduction</a></h1>
	28	<p>Triggers in the <a class="reference external" href="process_group.html">process group</a> interface are used to asynchronously
	29	receive and process messages destined for distributed data
	30	structures. The trigger interface is relatively versatile, permitting
	31	one to attach any function object to handle requests. The
	32	<tt class="docutils literal"><span class="pre">simple_trigger</span></tt> function simplifies a common case for triggers:
	33	attaching a trigger that invokes a specific member function of the
	34	distributed data structure.</p>
	35	</div>
	36	<div class="section" id="where-defined">
	37	<h1><a class="toc-backref" href="#id2">Where Defined</a></h1>
	38	<p>Header <tt class="docutils literal"><span class="pre"><boost/graph/parallel/simple_trigger.hpp></span></tt></p>
	39	</div>
	40	<div class="section" id="reference">
	41	<h1><a class="toc-backref" href="#id3">Reference</a></h1>
	42	<blockquote>
	43	<pre class="literal-block">
	44	template<typename ProcessGroup, typename Class, typename T>
	45	void
	46	simple_trigger(ProcessGroup& pg, int tag, Class* self,
	47	void (Class::*pmf)(int source, int tag, const T& data,
	48	trigger_receive_context context))
	49
	50	template<typename ProcessGroup, typename Class, typename T, typename Result>
	51	void
	52	simple_trigger(ProcessGroup& pg, int tag, Class* self,
	53	Result (Class::*pmf)(int source, int tag, const T& data,
	54	trigger_receive_context context))
	55	</pre>
	56	</blockquote>
	57	<p>The <tt class="docutils literal"><span class="pre">simple_trigger</span></tt> function registers a trigger that invokes the
	58	given member function (<tt class="docutils literal"><span class="pre">pmf</span></tt>) on the object <tt class="docutils literal"><span class="pre">self</span></tt> whenever a
	59	message is received. If the member function has a return value, then
	60	the trigger has a reply, and can only be used via out-of-band sends
	61	that expect a reply. Otherwise, the member function returns <tt class="docutils literal"><span class="pre">void</span></tt>,
	62	and the function is registered as a normal trigger.</p>
	63	<hr class="docutils" />
	64	<p>Copyright (C) 2007 Douglas Gregor</p>
65	<p>Copyright (C) 2007 Matthias Troyer</p>
66	</div>
67	</div>
68	<div class="footer">
69	<hr class="footer" />
70	Generated on: 2009-05-31 00:21 UTC.
71	Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
72
73	</div>
74	</body>
75	</html>