~peekabot-devs/peekabot/peekabot.org

« back to all changes in this revision

Viewing changes to doc/0.8.x/MessageHub_8hh_source.html

  • Committer: Staffan Gimåker
  • Date: 2011-01-30 20:22:14 UTC
  • Revision ID: staffan@gimaker.se-20110130202214-joasm9qvwni8n0g7
Add doxygen documentation for 0.8.x.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>peekabot: src/MessageHub.hh Source File</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.1 -->
 
11
<div class="navigation" id="top">
 
12
  <div class="tabs">
 
13
    <ul class="tablist">
 
14
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
 
15
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
16
      <li><a href="annotated.html"><span>Classes</span></a></li>
 
17
      <li class="current"><a href="files.html"><span>Files</span></a></li>
 
18
    </ul>
 
19
  </div>
 
20
  <div class="tabs2">
 
21
    <ul class="tablist">
 
22
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
 
23
    </ul>
 
24
  </div>
 
25
<div class="header">
 
26
  <div class="headertitle">
 
27
<h1>src/MessageHub.hh</h1>  </div>
 
28
</div>
 
29
<div class="contents">
 
30
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
 
31
<a name="l00002"></a>00002 <span class="comment"> * This file is part of peekabot.</span>
 
32
<a name="l00003"></a>00003 <span class="comment"> *</span>
 
33
<a name="l00004"></a>00004 <span class="comment"> * peekabot is free software; you can redistribute it and/or modify</span>
 
34
<a name="l00005"></a>00005 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
 
35
<a name="l00006"></a>00006 <span class="comment"> * the Free Software Foundation; either version 3 of the License, or</span>
 
36
<a name="l00007"></a>00007 <span class="comment"> * (at your option) any later version.</span>
 
37
<a name="l00008"></a>00008 <span class="comment"> *</span>
 
38
<a name="l00009"></a>00009 <span class="comment"> * peekabot is distributed in the hope that it will be useful,</span>
 
39
<a name="l00010"></a>00010 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
 
40
<a name="l00011"></a>00011 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
 
41
<a name="l00012"></a>00012 <span class="comment"> * GNU General Public License for more details.</span>
 
42
<a name="l00013"></a>00013 <span class="comment"> *</span>
 
43
<a name="l00014"></a>00014 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
 
44
<a name="l00015"></a>00015 <span class="comment"> * along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
 
45
<a name="l00016"></a>00016 <span class="comment"> */</span>
 
46
<a name="l00017"></a>00017 
 
47
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef __PEEKABOT_MESSAGE_HUB_HH</span>
 
48
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define __PEEKABOT_MESSAGE_HUB_HH</span>
 
49
<a name="l00020"></a>00020 <span class="preprocessor"></span>
 
50
<a name="l00021"></a>00021 
 
51
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;map&gt;</span>
 
52
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;set&gt;</span>
 
53
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;string&gt;</span>
 
54
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;boost/thread/recursive_mutex.hpp&gt;</span>
 
55
<a name="l00026"></a>00026 
 
56
<a name="l00027"></a>00027 <span class="preprocessor">#include &quot;Types.hh&quot;</span>
 
57
<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;Singleton.hh&quot;</span>
 
58
<a name="l00029"></a>00029 
 
59
<a name="l00030"></a>00030 <span class="keyword">namespace </span>peekabot
 
60
<a name="l00031"></a>00031 {
 
61
<a name="l00032"></a>00032 
 
62
<a name="l00039"></a>00039     <span class="keyword">enum</span> MessageType
 
63
<a name="l00040"></a>00040     {
 
64
<a name="l00045"></a>00045         CLIENT_MESSAGE = 0,
 
65
<a name="l00046"></a>00046 
 
66
<a name="l00053"></a>00053         INFO_MESSAGE = 1,
 
67
<a name="l00054"></a>00054 
 
68
<a name="l00063"></a>00063         WARNING_MESSAGE = 2,
 
69
<a name="l00064"></a>00064 
 
70
<a name="l00068"></a>00068         ERROR_MESSAGE = 3,
 
71
<a name="l00069"></a>00069 
 
72
<a name="l00073"></a>00073         DEBUG_MESSAGE = 4,
 
73
<a name="l00074"></a>00074 
 
74
<a name="l00081"></a>00081         LOG_MESSAGE = 5
 
75
<a name="l00082"></a>00082     };
 
76
<a name="l00083"></a>00083 
 
77
<a name="l00084"></a>00084 
 
78
<a name="l00085"></a>00085     <span class="keyword">class </span>Subscriber;
 
79
<a name="l00086"></a>00086     <span class="keyword">class </span>Message;
 
80
<a name="l00087"></a>00087 
 
81
<a name="l00088"></a>00088 
 
82
<a name="l00100"></a>00100     <span class="keyword">class </span>MessageHub
 
83
<a name="l00101"></a>00101     {
 
84
<a name="l00106"></a>00106         <span class="keyword">typedef</span> std::set&lt;Subscriber *&gt; SubscriberSet;
 
85
<a name="l00107"></a>00107 
 
86
<a name="l00112"></a>00112         <span class="keyword">typedef</span> std::map&lt;MessageType, SubscriberSet&gt; SubscriberMap;
 
87
<a name="l00113"></a>00113 
 
88
<a name="l00121"></a>00121         SubscriberMap m_subscribers;
 
89
<a name="l00122"></a>00122 
 
90
<a name="l00127"></a>00127         <span class="keyword">mutable</span> boost::recursive_mutex m_mutex;
 
91
<a name="l00128"></a>00128 
 
92
<a name="l00129"></a>00129     <span class="keyword">public</span>:
 
93
<a name="l00130"></a>00130         ~MessageHub();
 
94
<a name="l00131"></a>00131 
 
95
<a name="l00149"></a>00149         <span class="keywordtype">void</span> publish(
 
96
<a name="l00150"></a>00150             MessageType type, 
 
97
<a name="l00151"></a>00151             <span class="keyword">const</span> std::string &amp;msg, ...) <span class="keyword">const</span> throw();
 
98
<a name="l00152"></a>00152 
 
99
<a name="l00166"></a>00166         <span class="keywordtype">void</span> publish(
 
100
<a name="l00167"></a>00167             MessageType type, SourceID source, 
 
101
<a name="l00168"></a>00168             const std::<span class="keywordtype">string</span> &amp;msg, ...) const throw();
 
102
<a name="l00169"></a>00169 
 
103
<a name="l00179"></a>00179         <span class="keywordtype">void</span> subscribe(MessageType type, Subscriber *recipient) throw();
 
104
<a name="l00180"></a>00180 
 
105
<a name="l00186"></a>00186         <span class="keywordtype">void</span> subscribe(Subscriber *recipient) throw();
 
106
<a name="l00187"></a>00187 
 
107
<a name="l00197"></a>00197         <span class="keywordtype">void</span> unsubscribe(MessageType type, Subscriber *recipient) throw();
 
108
<a name="l00198"></a>00198 
 
109
<a name="l00199"></a>00199     protected:
 
110
<a name="l00205"></a>00205         <span class="keywordtype">void</span> publish(const Message &amp;message) const throw();
 
111
<a name="l00206"></a>00206     };
 
112
<a name="l00207"></a>00207 
 
113
<a name="l00208"></a>00208 
 
114
<a name="l00209"></a>00209 
 
115
<a name="l00214"></a>00214     typedef Singleton&lt;MessageHub&gt; TheMessageHub;
 
116
<a name="l00215"></a>00215 
 
117
<a name="l00216"></a>00216 
 
118
<a name="l00217"></a>00217 }
 
119
<a name="l00218"></a>00218 
 
120
<a name="l00219"></a>00219 
 
121
<a name="l00220"></a>00220 <span class="preprocessor">#endif // __PEEKABOT_MESSAGE_HUB_HH</span>
 
122
</pre></div></div>
 
123
</div>
 
124
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 30 2011 for peekabot by&nbsp;
 
125
<a href="http://www.doxygen.org/index.html">
 
126
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
 
127
</body>
 
128
</html>