summaryrefslogtreecommitdiff
path: root/doc/html/signals.html
blob: ce30d69471ddfab5c980b201e09245c96d61e6f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Chapter&#160;35.&#160;Boost.Signals</title>
<link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="libraries.html" title="Part&#160;I.&#160;The Boost C++ Libraries (BoostBook Subset)">
<link rel="prev" href="ratio/appendices.html" title="Appendices">
<link rel="next" href="signals/tutorial.html" title="Tutorial">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.html">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ratio/appendices.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><img src="../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="signals/tutorial.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="chapter">
<div class="titlepage"><div>
<div><h2 class="title">
<a name="signals"></a>Chapter&#160;35.&#160;Boost.Signals</h2></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Douglas</span> <span class="surname">Gregor</span>
</h3></div></div>
<div><p class="copyright">Copyright &#169; 2001-2004 Douglas Gregor</p></div>
<div><div class="legalnotice">
<a name="idp522557760"></a><p>Use, modification and distribution is subject to the Boost
    Software License, Version 1.0. (See accompanying file
    <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
</div></div>
</div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl class="toc">
<dt><span class="section"><a href="signals.html#idp522560480">Introduction</a></span></dt>
<dt><span class="section"><a href="signals/tutorial.html">Tutorial</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="signals/tutorial.html#idp522568848">How to Read this Tutorial</a></span></dt>
<dt><span class="section"><a href="signals/tutorial.html#idp522575632">Compatibility Note</a></span></dt>
<dt><span class="section"><a href="signals/tutorial.html#idp522589312">Hello, World! (Beginner)</a></span></dt>
<dt><span class="section"><a href="signals/tutorial.html#idp522606416">Calling multiple slots</a></span></dt>
<dt><span class="section"><a href="signals/tutorial.html#idp522653232">Passing values to and from slots</a></span></dt>
<dt><span class="section"><a href="signals/tutorial.html#idp522760112">Connection Management</a></span></dt>
<dt><span class="section"><a href="signals/tutorial.html#idp522847296">Example: Document-View</a></span></dt>
<dt><span class="section"><a href="signals/tutorial.html#idp522862480">Linking against the Signals library</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="signals/reference.html">Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="signals/reference.html#header.boost.signal_hpp">Header &lt;boost/signal.hpp&gt;</a></span></dt>
<dt><span class="section"><a href="signals/reference.html#header.boost.signals.slot_hpp">Header &lt;boost/signals/slot.hpp&gt;</a></span></dt>
<dt><span class="section"><a href="signals/reference.html#header.boost.signals.trackable_hpp">Header &lt;boost/signals/trackable.hpp&gt;</a></span></dt>
<dt><span class="section"><a href="signals/reference.html#header.boost.signals.connection_hpp">Header &lt;boost/signals/connection.hpp&gt;</a></span></dt>
<dt><span class="section"><a href="signals/reference.html#header.boost.visit_each_hpp">Header &lt;boost/visit_each.hpp&gt;</a></span></dt>
<dt><span class="section"><a href="signals/reference.html#header.boost.last_value_hpp">Header &lt;boost/last_value.hpp&gt;</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="signals/s04.html">Frequently Asked Questions</a></span></dt>
<dt><span class="section"><a href="signals/s05.html">Design Overview</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="signals/s05.html#idp523974912">Type Erasure</a></span></dt>
<dt><span class="section"><a href="signals/s05.html#idp523982176"><code class="computeroutput">connection</code> class</a></span></dt>
<dt><span class="section"><a href="signals/s05.html#idp523995440">Slot Call Iterator</a></span></dt>
<dt><span class="section"><a href="signals/s05.html#idp524017728"><code class="computeroutput">visit_each</code> function template</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="signals/s06.html">Design Rationale</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="signals/s06.html#idp524034800">Choice of Slot Definitions</a></span></dt>
<dt><span class="section"><a href="signals/s06.html#idp524044192">User-level Connection Management</a></span></dt>
<dt><span class="section"><a href="signals/s06.html#idp524062496">Combiner Interface</a></span></dt>
<dt><span class="section"><a href="signals/s06.html#idp524077584">Connection Interfaces: +=  operator</a></span></dt>
<dt><span class="section"><a href="signals/s06.html#idp524096960"><code class="computeroutput">trackable</code> rationale</a></span></dt>
<dt><span class="section"><a href="signals/s06.html#idp524117072">Comparison with other Signal/Slot implementations</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="signals/tests.html">Testsuite</a></span></dt>
<dd><dl><dt><span class="section"><a href="signals/tests.html#idp524132432">Acceptance tests</a></span></dt></dl></dd>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="idp522560480"></a>Introduction</h2></div></div></div>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p><span class="bold"><strong>Boost.Signals is no longer being actively maintained.</strong></span>
Do not use Boost.Signals for new development (use 
<a class="link" href="signals2.html" title="Chapter&#160;36.&#160;Boost.Signals2">Boost.Signals2</a>
instead). If you have existing Boost.Signals-based code, it will
continue to work, but consider moving to Boost.Signals2. There is
<a class="link" href="signals2/api_changes.html#signals2.porting" title="Porting from Boost.Signals to Boost.Signals2">
a porting guide</a> in the Signals2 documentation.</p></td></tr>
</table></div>
<p>The Boost.Signals library is an implementation of a managed
signals and slots system. Signals represent callbacks with multiple
targets, and are also called publishers or events in similar
systems. Signals are connected to some set of slots, which are
callback receivers (also called event targets or subscribers), which
are called when the signal is "emitted."</p>
<p>Signals and slots are managed, in that signals and slots (or,
more properly, objects that occur as part of the slots) track all
connections and are capable of automatically disconnecting signal/slot
connections when either is destroyed. This enables the user to make
signal/slot connections without expending a great effort to manage the
lifetimes of those connections with regard to the lifetimes of all
objects involved.</p>
<p>When signals are connected to multiple slots, there is a
question regarding the relationship between the return values of the
slots and the return value of the signals. Boost.Signals allows the
user to specify the manner in which multiple return values are
combined.</p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="ratio/appendices.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><img src="../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="signals/tutorial.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>