mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
74 lines
16 KiB
HTML
74 lines
16 KiB
HTML
<!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>FairMQ: fairmq/FairMQStateMachine.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">FairMQ
|
|
 <span id="projectnumber">1.3.7</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Passing Framework</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_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">FairMQStateMachine.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This software is distributed under the terms of the *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * GNU Lesser General Public Licence (LGPL) version 3, *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * copied verbatim in the file "LICENSE" *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> ********************************************************************************/</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef FAIRMQSTATEMACHINE_H_</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define FAIRMQSTATEMACHINE_H_</span></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="preprocessor">#define FAIRMQ_INTERFACE_VERSION 3</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "FairMQLogger.h"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classFairMQStateMachine.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="classFairMQStateMachine.html">FairMQStateMachine</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">enum</span> Event</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  INIT_DEVICE,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  internal_DEVICE_READY,</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  INIT_TASK,</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  internal_READY,</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  RUN,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  PAUSE,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  STOP,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  RESET_TASK,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  RESET_DEVICE,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  internal_IDLE,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  END,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  ERROR_FOUND</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  };</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">enum</span> State</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  OK,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  Error,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  IDLE,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  INITIALIZING_DEVICE,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  DEVICE_READY,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  INITIALIZING_TASK,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  READY,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  RUNNING,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  PAUSED,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  RESETTING_TASK,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  RESETTING_DEVICE,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  EXITING</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  };</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classFairMQStateMachine.html">FairMQStateMachine</a>();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">virtual</span> ~<a class="code" href="classFairMQStateMachine.html">FairMQStateMachine</a>();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">int</span> GetInterfaceVersion() <span class="keyword">const</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">bool</span> ChangeState(<span class="keywordtype">int</span> event);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span> ChangeState(<span class="keyword">const</span> std::string& event);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> WaitForEndOfState(<span class="keywordtype">int</span> event);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">void</span> WaitForEndOfState(<span class="keyword">const</span> std::string& event);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">bool</span> WaitForEndOfStateForMs(<span class="keywordtype">int</span> event, <span class="keywordtype">int</span> durationInMs);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">bool</span> WaitForEndOfStateForMs(<span class="keyword">const</span> std::string& event, <span class="keywordtype">int</span> durationInMs);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> SubscribeToStateChange(<span class="keyword">const</span> std::string& key, std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> State)> callback);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> UnsubscribeFromStateChange(<span class="keyword">const</span> std::string& key);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span> CallStateChangeCallbacks(<span class="keyword">const</span> State state) <span class="keyword">const</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  std::string GetCurrentStateName() <span class="keyword">const</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">static</span> std::string GetStateName(<span class="keyword">const</span> State);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> GetCurrentState() <span class="keyword">const</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">bool</span> CheckCurrentState(<span class="keywordtype">int</span> state) <span class="keyword">const</span>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">bool</span> CheckCurrentState(<span class="keyword">const</span> std::string& state) <span class="keyword">const</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// actions to be overwritten by derived classes</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> InitWrapper() {}</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> InitTaskWrapper() {}</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> RunWrapper() {}</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> PauseWrapper() {}</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ResetWrapper() {}</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ResetTaskWrapper() {}</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Exit() {}</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Unblock() {}</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> ProcessWork();</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> GetEventNumber(<span class="keyword">const</span> std::string& event);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  std::mutex fChangeStateMutex;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  std::shared_ptr<void> fFsm;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> };</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIRMQSTATEMACHINE_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="classFairMQStateMachine_html"><div class="ttname"><a href="classFairMQStateMachine.html">FairMQStateMachine</a></div><div class="ttdef"><b>Definition:</b> FairMQStateMachine.h:27</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|