/
route-event-bus_8h_source.html
88 lines (86 loc) · 10.6 KB
/
route-event-bus_8h_source.html
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
<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libbgp: src/route-event-bus.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libbgp
 <span id="projectnumber">0.6</span>
</div>
<div id="projectbrief">A C++ BGP Library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">route-event-bus.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="route-event-bus_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifndef ROUTE_EV_BUS_H_</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#define ROUTE_EV_BUS_H_</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="route-event_8h.html">route-event.h</a>"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="route-event-receiver_8h.html">route-event-receiver.h</a>"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespacelibbgp.html">libbgp</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">class </span>RouteEventReceiver;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classlibbgp_1_1RouteEventBus.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="classlibbgp_1_1RouteEventBus.html">RouteEventBus</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classlibbgp_1_1RouteEventBus.html">RouteEventBus</a>();</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// publish a route event. For non FSM (administratively/other proto), use fsm = NULL</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="comment">// return number of subscriber reached, or -1 on error</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">int</span> <a class="code" href="classlibbgp_1_1RouteEventBus.html#aca68243e992480debcef8011cf0a0886">publish</a>(<a class="code" href="classlibbgp_1_1RouteEventReceiver.html">RouteEventReceiver</a> *recv, <span class="keyword">const</span> <a class="code" href="classlibbgp_1_1RouteEvent.html">RouteEvent</a> &ev);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// subscribe to event bus, return true if success</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> <a class="code" href="classlibbgp_1_1RouteEventBus.html#a8479fcd6ead5e448841eb46610ab00d2">subscribe</a>(<a class="code" href="classlibbgp_1_1RouteEventReceiver.html">RouteEventReceiver</a> *recv);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// unsubscribe from event bus, return true if success</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">bool</span> <a class="code" href="classlibbgp_1_1RouteEventBus.html#a55ddb50c9ae7fc4883a5cb9654ceb1c5">unsubscribe</a>(<a class="code" href="classlibbgp_1_1RouteEventReceiver.html">RouteEventReceiver</a> *recv);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  std::vector<RouteEventReceiver *> subscribers;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">int</span> subscription_id;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> };</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif // ROUTE_EV_BUS_H_</span></div><div class="ttc" id="classlibbgp_1_1RouteEventBus_html_aca68243e992480debcef8011cf0a0886"><div class="ttname"><a href="classlibbgp_1_1RouteEventBus.html#aca68243e992480debcef8011cf0a0886">libbgp::RouteEventBus::publish</a></div><div class="ttdeci">int publish(RouteEventReceiver *recv, const RouteEvent &ev)</div><div class="ttdoc">Publish a route event. </div><div class="ttdef"><b>Definition:</b> <a href="route-event-bus_8cc_source.html#l00028">route-event-bus.cc:28</a></div></div>
<div class="ttc" id="classlibbgp_1_1RouteEventBus_html"><div class="ttname"><a href="classlibbgp_1_1RouteEventBus.html">libbgp::RouteEventBus</a></div><div class="ttdoc">The RouteEventBus class. </div><div class="ttdef"><b>Definition:</b> <a href="route-event-bus_8h_source.html#l00027">route-event-bus.h:27</a></div></div>
<div class="ttc" id="route-event-receiver_8h_html"><div class="ttname"><a href="route-event-receiver_8h.html">route-event-receiver.h</a></div><div class="ttdoc">Route event receiver. </div></div>
<div class="ttc" id="classlibbgp_1_1RouteEventBus_html_a8479fcd6ead5e448841eb46610ab00d2"><div class="ttname"><a href="classlibbgp_1_1RouteEventBus.html#a8479fcd6ead5e448841eb46610ab00d2">libbgp::RouteEventBus::subscribe</a></div><div class="ttdeci">bool subscribe(RouteEventReceiver *recv)</div><div class="ttdoc">Subscribe from this event bus. </div><div class="ttdef"><b>Definition:</b> <a href="route-event-bus_8cc_source.html#l00047">route-event-bus.cc:47</a></div></div>
<div class="ttc" id="classlibbgp_1_1RouteEventBus_html_a55ddb50c9ae7fc4883a5cb9654ceb1c5"><div class="ttname"><a href="classlibbgp_1_1RouteEventBus.html#a55ddb50c9ae7fc4883a5cb9654ceb1c5">libbgp::RouteEventBus::unsubscribe</a></div><div class="ttdeci">bool unsubscribe(RouteEventReceiver *recv)</div><div class="ttdoc">Unsubscribe to this event bus. </div><div class="ttdef"><b>Definition:</b> <a href="route-event-bus_8cc_source.html#l00060">route-event-bus.cc:60</a></div></div>
<div class="ttc" id="namespacelibbgp_html"><div class="ttname"><a href="namespacelibbgp.html">libbgp</a></div><div class="ttdef"><b>Definition:</b> <a href="bgp-afi_8h_source.html#l00014">bgp-afi.h:14</a></div></div>
<div class="ttc" id="route-event_8h_html"><div class="ttname"><a href="route-event_8h.html">route-event.h</a></div><div class="ttdoc">The route events. </div></div>
<div class="ttc" id="classlibbgp_1_1RouteEventReceiver_html"><div class="ttname"><a href="classlibbgp_1_1RouteEventReceiver.html">libbgp::RouteEventReceiver</a></div><div class="ttdoc">The RouteEventReceiver interface. </div><div class="ttdef"><b>Definition:</b> <a href="route-event-receiver_8h_source.html#l00032">route-event-receiver.h:32</a></div></div>
<div class="ttc" id="classlibbgp_1_1RouteEvent_html"><div class="ttname"><a href="classlibbgp_1_1RouteEvent.html">libbgp::RouteEvent</a></div><div class="ttdoc">The RouteEvent base. </div><div class="ttdef"><b>Definition:</b> <a href="route-event_8h_source.html#l00039">route-event.h:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>