summaryrefslogtreecommitdiffstats
path: root/classuscxml_1_1_basic_delayed_event_queue.html
blob: 879819fd150701c9d380acf3d690513d42b9ffa4 (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<!-- HTML header for doxygen 1.8.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">
    <head>
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <!-- For Mobile Devices -->
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
        <meta name="generator" content="Doxygen 1.8.10"/>
        <script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
        <title>uSCXML: uscxml::BasicDelayedEventQueue Class Reference</title>
        <!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
        <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>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
        <link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
        <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
        <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
        <script type="text/javascript" src="doxy-boot.js"></script>
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="container">
                <div class="navbar-header">
                    <a class="navbar-brand">uSCXML 2.0.0</a>
                </div>
            </div>
        </nav>
        <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
            <div class="content" id="content">
                <div class="container">
                    <div class="row">
                        <div class="col-sm-12 panel " style="padding-bottom: 15px;">
                            <div style="margin-bottom: 15px;">
<!-- end header part --><!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </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"><b>uscxml</b></li><li class="navelem"><a class="el" href="classuscxml_1_1_basic_delayed_event_queue.html">BasicDelayedEventQueue</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classuscxml_1_1_basic_delayed_event_queue-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">uscxml::BasicDelayedEventQueue Class Reference<div class="ingroups"><a class="el" href="group__interpreter.html">Interpreter</a> &raquo; <a class="el" href="group__eventqueue.html">Event Queue</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for uscxml::BasicDelayedEventQueue:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classuscxml_1_1_basic_delayed_event_queue__inherit__graph.svg" width="432" height="202"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for uscxml::BasicDelayedEventQueue:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classuscxml_1_1_basic_delayed_event_queue__coll__graph.svg" width="100%" height="416"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structuscxml_1_1_basic_delayed_event_queue_1_1callback_data.html">callbackData</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acaed532499050b36583358fd29b8bb39"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acaed532499050b36583358fd29b8bb39"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BasicDelayedEventQueue</b> (<a class="el" href="classuscxml_1_1_delayed_event_queue_callbacks.html">DelayedEventQueueCallbacks</a> *callbacks)</td></tr>
<tr class="separator:acaed532499050b36583358fd29b8bb39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7357348efc1d96af0e782a23c06578f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7357348efc1d96af0e782a23c06578f"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>enqueueDelayed</b> (const <a class="el" href="classuscxml_1_1_event.html">Event</a> &amp;event, size_t delayMs, const std::string &amp;eventUUID)</td></tr>
<tr class="separator:aa7357348efc1d96af0e782a23c06578f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3802c7fa7c4d1c6d08af3e691a7081f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3802c7fa7c4d1c6d08af3e691a7081f9"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>cancelDelayed</b> (const std::string &amp;eventId)</td></tr>
<tr class="separator:a3802c7fa7c4d1c6d08af3e691a7081f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1c709c057ad34c3bb64bbd8727d37ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1c709c057ad34c3bb64bbd8727d37ca"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>cancelAllDelayed</b> ()</td></tr>
<tr class="separator:ac1c709c057ad34c3bb64bbd8727d37ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6f9040d7836575ed2c9c31464a1ec53"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6f9040d7836575ed2c9c31464a1ec53"></a>
virtual <a class="el" href="classuscxml_1_1_event.html">Event</a>&#160;</td><td class="memItemRight" valign="bottom"><b>dequeue</b> (bool blocking)</td></tr>
<tr class="separator:ac6f9040d7836575ed2c9c31464a1ec53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d21e13a575cbec7487f0ca39714ed6c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d21e13a575cbec7487f0ca39714ed6c"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>enqueue</b> (const <a class="el" href="classuscxml_1_1_event.html">Event</a> &amp;event)</td></tr>
<tr class="separator:a4d21e13a575cbec7487f0ca39714ed6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a2c9d84152899ff77b037fbfcc3ccd8b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c9d84152899ff77b037fbfcc3ccd8b0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>start</b> ()</td></tr>
<tr class="separator:a2c9d84152899ff77b037fbfcc3ccd8b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a845dbe5a199c6e58592bae5b3b7620e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a845dbe5a199c6e58592bae5b3b7620e1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>stop</b> ()</td></tr>
<tr class="separator:a845dbe5a199c6e58592bae5b3b7620e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a121101701a8c88a4e8eff947bbfb6149"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuscxml_1_1_basic_delayed_event_queue.html#a121101701a8c88a4e8eff947bbfb6149">run</a> (void *instance)</td></tr>
<tr class="separator:a121101701a8c88a4e8eff947bbfb6149"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78d2158558e40122766544a554f5d7d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78d2158558e40122766544a554f5d7d6"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>timerCallback</b> (evutil_socket_t fd, short what, void *arg)</td></tr>
<tr class="separator:a78d2158558e40122766544a554f5d7d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a25bbad52b9b5322ce597a9c649d1870e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25bbad52b9b5322ce597a9c649d1870e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>_isStarted</b></td></tr>
<tr class="separator:a25bbad52b9b5322ce597a9c649d1870e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18a45c200d759642f3cab592c0b79142"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18a45c200d759642f3cab592c0b79142"></a>
std::thread *&#160;</td><td class="memItemRight" valign="bottom"><b>_thread</b></td></tr>
<tr class="separator:a18a45c200d759642f3cab592c0b79142"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addf606626e97c754fdfdcf84f935abdd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="addf606626e97c754fdfdcf84f935abdd"></a>
std::map&lt; std::string, <a class="el" href="structuscxml_1_1_basic_delayed_event_queue_1_1callback_data.html">callbackData</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_callbackData</b></td></tr>
<tr class="separator:addf606626e97c754fdfdcf84f935abdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa91591e0e7d23011b8daf743a85e7f87"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa91591e0e7d23011b8daf743a85e7f87"></a>
struct event_base *&#160;</td><td class="memItemRight" valign="bottom"><b>_eventLoop</b></td></tr>
<tr class="separator:aa91591e0e7d23011b8daf743a85e7f87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd211f81de4c9ea587c0441793205dcd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd211f81de4c9ea587c0441793205dcd"></a>
struct event *&#160;</td><td class="memItemRight" valign="bottom"><b>_dummyEvent</b></td></tr>
<tr class="separator:abd211f81de4c9ea587c0441793205dcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30babc44bf122789ba5f2a98361e7750"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30babc44bf122789ba5f2a98361e7750"></a>
<a class="el" href="classuscxml_1_1_delayed_event_queue_callbacks.html">DelayedEventQueueCallbacks</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>_callbacks</b></td></tr>
<tr class="separator:a30babc44bf122789ba5f2a98361e7750"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classuscxml_1_1_basic_event_queue"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classuscxml_1_1_basic_event_queue')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classuscxml_1_1_basic_event_queue.html">uscxml::BasicEventQueue</a></td></tr>
<tr class="memitem:a126c9562b940b0aa31a1e0474160d8f9 inherit pro_attribs_classuscxml_1_1_basic_event_queue"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a126c9562b940b0aa31a1e0474160d8f9"></a>
std::list&lt; <a class="el" href="classuscxml_1_1_event.html">Event</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_queue</b></td></tr>
<tr class="separator:a126c9562b940b0aa31a1e0474160d8f9 inherit pro_attribs_classuscxml_1_1_basic_event_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fd214fdfd8fc21ff6ee7d6a09cf6bc5 inherit pro_attribs_classuscxml_1_1_basic_event_queue"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fd214fdfd8fc21ff6ee7d6a09cf6bc5"></a>
std::recursive_mutex&#160;</td><td class="memItemRight" valign="bottom"><b>_mutex</b></td></tr>
<tr class="separator:a2fd214fdfd8fc21ff6ee7d6a09cf6bc5 inherit pro_attribs_classuscxml_1_1_basic_event_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94d2d5a6f7504b925f8b53d0537791a5 inherit pro_attribs_classuscxml_1_1_basic_event_queue"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94d2d5a6f7504b925f8b53d0537791a5"></a>
std::condition_variable_any&#160;</td><td class="memItemRight" valign="bottom"><b>_cond</b></td></tr>
<tr class="separator:a94d2d5a6f7504b925f8b53d0537791a5 inherit pro_attribs_classuscxml_1_1_basic_event_queue"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a121101701a8c88a4e8eff947bbfb6149"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void uscxml::BasicDelayedEventQueue::run </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>instance</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>EVLOOP_NO_EXIT_ON_EMPTY was removed in libevent2.1 - we are using the event in the far future approach to get blocking behavior back (see comments in contructor)</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>interpreter/<a class="el" href="_basic_event_queue_8h_source.html">BasicEventQueue.h</a></li>
<li>interpreter/<a class="el" href="_basic_event_queue_8cpp.html">BasicEventQueue.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<!-- <hr class="footer"/><address class="footer"><small>
Generated on Thu May 19 2016 10:34:09 for uSCXML by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address> -->
</body>
</html>