No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

classmonitor_1_1_command_manager.html 35KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Monitor: monitor.CommandManager Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20. <script type="text/javascript" src="search/searchdata.js"></script>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 56px;">
  30. <td id="projectlogo"><img alt="Logo" src="robot-icon.resized.png"/></td>
  31. <td id="projectalign" style="padding-left: 0.5em;">
  32. <div id="projectname">Monitor
  33. </div>
  34. </td>
  35. </tr>
  36. </tbody>
  37. </table>
  38. </div>
  39. <!-- end header part -->
  40. <!-- Generated by Doxygen 1.8.13 -->
  41. <script type="text/javascript">
  42. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  43. </script>
  44. <script type="text/javascript" src="menudata.js"></script>
  45. <script type="text/javascript" src="menu.js"></script>
  46. <script type="text/javascript">
  47. $(function() {
  48. initMenu('',true,false,'search.php','Search');
  49. $(document).ready(function() { init_search(); });
  50. });
  51. </script>
  52. <div id="main-nav"></div>
  53. </div><!-- top -->
  54. <div id="side-nav" class="ui-resizable side-nav-resizable">
  55. <div id="nav-tree">
  56. <div id="nav-tree-contents">
  57. <div id="nav-sync" class="sync"></div>
  58. </div>
  59. </div>
  60. <div id="splitbar" style="-moz-user-select:none;"
  61. class="ui-resizable-handle">
  62. </div>
  63. </div>
  64. <script type="text/javascript">
  65. $(document).ready(function(){initNavTree('classmonitor_1_1_command_manager.html','');});
  66. </script>
  67. <div id="doc-content">
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. </div>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. <div class="header">
  81. <div class="summary">
  82. <a href="#pub-types">Public Types</a> &#124;
  83. <a href="#pub-methods">Public Member Functions</a> &#124;
  84. <a href="#pub-attribs">Public Attributes</a> &#124;
  85. <a href="#pri-methods">Private Member Functions</a> &#124;
  86. <a href="#pri-attribs">Private Attributes</a> &#124;
  87. <a href="classmonitor_1_1_command_manager-members.html">List of all members</a> </div>
  88. <div class="headertitle">
  89. <div class="title">monitor.CommandManager Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p>Command Manager. Use for timeout managment during reception of data Used as intermediate layer between TCP client class (<a class="el" href="classmonitor_1_1_client.html" title="Static class for TCP client ">Client</a>) and application level managment of command and answers
  93. <a href="classmonitor_1_1_command_manager.html#details">More...</a></p>
  94. <div class="dynheader">
  95. Collaboration diagram for monitor.CommandManager:</div>
  96. <div class="dyncontent">
  97. <div class="center"><img src="classmonitor_1_1_command_manager__coll__graph.png" border="0" usemap="#monitor_8_command_manager_coll__map" alt="Collaboration graph"/></div>
  98. <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
  99. <table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  101. Public Types</h2></td></tr>
  102. <tr class="memitem:ac8ca53031468acc8be05c37586671a9b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#ac8ca53031468acc8be05c37586671a9b">CommandManagerStatus</a> { <a class="el" href="classmonitor_1_1_command_manager.html#ac8ca53031468acc8be05c37586671a9bae3e095863e3b99e11e8c18efb3901da3">CommandManagerStatus.AnswerReceived</a>,
  103. <a class="el" href="classmonitor_1_1_command_manager.html#ac8ca53031468acc8be05c37586671a9bac85a251cc457840f1e032f1b733e9398">CommandManagerStatus.Timeout</a>,
  104. <a class="el" href="classmonitor_1_1_command_manager.html#ac8ca53031468acc8be05c37586671a9bad8a942ef2b04672adfafef0ad817a407">CommandManagerStatus.Busy</a>
  105. }<tr class="memdesc:ac8ca53031468acc8be05c37586671a9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Available status when sending command <a href="classmonitor_1_1_command_manager.html#ac8ca53031468acc8be05c37586671a9b">More...</a><br /></td></tr>
  106. </td></tr>
  107. <tr class="separator:ac8ca53031468acc8be05c37586671a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table><table class="memberdecls">
  109. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  110. Public Member Functions</h2></td></tr>
  111. <tr class="memitem:a5afd16036cc3d0e69554f69dacad0bcc"><td class="memItemLeft" align="right" valign="top">delegate void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a5afd16036cc3d0e69554f69dacad0bcc">CommandReceivedEvent</a> (string msg, byte[] buffer)</td></tr>
  112. <tr class="memdesc:a5afd16036cc3d0e69554f69dacad0bcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback for sending received data to upper level <a href="#a5afd16036cc3d0e69554f69dacad0bcc">More...</a><br /></td></tr>
  113. <tr class="separator:a5afd16036cc3d0e69554f69dacad0bcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ac2248c90d3a59bc2bf376cd876cece72"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#ac2248c90d3a59bc2bf376cd876cece72">CommandManager</a> (<a class="el" href="classmonitor_1_1_command_manager.html#a5afd16036cc3d0e69554f69dacad0bcc">CommandReceivedEvent</a> callback)</td></tr>
  115. <tr class="memdesc:ac2248c90d3a59bc2bf376cd876cece72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new instance of the T:monitor.CommandManager class. <a href="#ac2248c90d3a59bc2bf376cd876cece72">More...</a><br /></td></tr>
  116. <tr class="separator:ac2248c90d3a59bc2bf376cd876cece72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a7329cbf8008bcb8a0280aa7ffa6aa43c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a7329cbf8008bcb8a0280aa7ffa6aa43c">Open</a> (string hostname)</td></tr>
  118. <tr class="memdesc:a7329cbf8008bcb8a0280aa7ffa6aa43c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the specified hostname server, using default port number. <a href="#a7329cbf8008bcb8a0280aa7ffa6aa43c">More...</a><br /></td></tr>
  119. <tr class="separator:a7329cbf8008bcb8a0280aa7ffa6aa43c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a0a0054ee87d293577fa39af1fcd5ffee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a0a0054ee87d293577fa39af1fcd5ffee">Open</a> (string hostname, int port)</td></tr>
  121. <tr class="memdesc:a0a0054ee87d293577fa39af1fcd5ffee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open connection to server "host", with port number "port" <a href="#a0a0054ee87d293577fa39af1fcd5ffee">More...</a><br /></td></tr>
  122. <tr class="separator:a0a0054ee87d293577fa39af1fcd5ffee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ab28b0e5a2641391e655aaaaa05a1fdf6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#ab28b0e5a2641391e655aaaaa05a1fdf6">Close</a> ()</td></tr>
  124. <tr class="memdesc:ab28b0e5a2641391e655aaaaa05a1fdf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close connection to server <a href="#ab28b0e5a2641391e655aaaaa05a1fdf6">More...</a><br /></td></tr>
  125. <tr class="separator:ab28b0e5a2641391e655aaaaa05a1fdf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a3cd1f2303e47e5148fd3e927a7957363"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmonitor_1_1_command_manager.html#ac8ca53031468acc8be05c37586671a9b">CommandManagerStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a3cd1f2303e47e5148fd3e927a7957363">SendCommand</a> (string cmd, out string answer, double timeout)</td></tr>
  127. <tr class="memdesc:a3cd1f2303e47e5148fd3e927a7957363"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a command to TCP server <a href="#a3cd1f2303e47e5148fd3e927a7957363">More...</a><br /></td></tr>
  128. <tr class="separator:a3cd1f2303e47e5148fd3e927a7957363"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table><table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  131. Public Attributes</h2></td></tr>
  132. <tr class="memitem:ab90d68a3d3a9b3935fa9f1a57e8dabfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmonitor_1_1_command_manager.html#a5afd16036cc3d0e69554f69dacad0bcc">CommandReceivedEvent</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#ab90d68a3d3a9b3935fa9f1a57e8dabfa">commandReceivedEvent</a> = null</td></tr>
  133. <tr class="separator:ab90d68a3d3a9b3935fa9f1a57e8dabfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
  136. Private Member Functions</h2></td></tr>
  137. <tr class="memitem:ad2a8eb1139a5a25a6993887c55b3da4e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#ad2a8eb1139a5a25a6993887c55b3da4e">~CommandManager</a> ()</td></tr>
  138. <tr class="memdesc:ad2a8eb1139a5a25a6993887c55b3da4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases unmanaged resources and performs other cleanup operations before the T:monitor.CommandManager is reclaimed by garbage collection. <a href="#ad2a8eb1139a5a25a6993887c55b3da4e">More...</a><br /></td></tr>
  139. <tr class="separator:ad2a8eb1139a5a25a6993887c55b3da4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a92e5d42afb61f29d9a4746b4446c2a65"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a92e5d42afb61f29d9a4746b4446c2a65">OnMessageReception</a> (string message, byte[] buffer)</td></tr>
  141. <tr class="memdesc:a92e5d42afb61f29d9a4746b4446c2a65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback called by <a class="el" href="classmonitor_1_1_client.html" title="Static class for TCP client ">Client</a> class after reception of new message <a href="#a92e5d42afb61f29d9a4746b4446c2a65">More...</a><br /></td></tr>
  142. <tr class="separator:a92e5d42afb61f29d9a4746b4446c2a65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a2f91bb775ba25855be007886b994a5df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a2f91bb775ba25855be007886b994a5df">OnMessageTimeout</a> (object sender, System.Timers.ElapsedEventArgs e)</td></tr>
  144. <tr class="memdesc:a2f91bb775ba25855be007886b994a5df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback called by stopwatch on timeout <a href="#a2f91bb775ba25855be007886b994a5df">More...</a><br /></td></tr>
  145. <tr class="separator:a2f91bb775ba25855be007886b994a5df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table><table class="memberdecls">
  147. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  148. Private Attributes</h2></td></tr>
  149. <tr class="memitem:a07639cd39445a379667a2450e78001b0"><td class="memItemLeft" align="right" valign="top">System.Timers.Timer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a07639cd39445a379667a2450e78001b0">waitTimer</a> = new System.Timers.Timer()</td></tr>
  150. <tr class="memdesc:a07639cd39445a379667a2450e78001b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer for managing timeout <a href="#a07639cd39445a379667a2450e78001b0">More...</a><br /></td></tr>
  151. <tr class="separator:a07639cd39445a379667a2450e78001b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a0d27eb1a38efb01559f14a707ff86447"><td class="memItemLeft" align="right" valign="top">ManualResetEvent&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a0d27eb1a38efb01559f14a707ff86447">waitEvent</a> = new ManualResetEvent(false)</td></tr>
  153. <tr class="separator:a0d27eb1a38efb01559f14a707ff86447"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a39c2c03f93b309e65a45ac91c6eb39bd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#a39c2c03f93b309e65a45ac91c6eb39bd">waitForAcknowledge</a> = false</td></tr>
  155. <tr class="memdesc:a39c2c03f93b309e65a45ac91c6eb39bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag to tell rogram to wait for an acknowledge from server <a href="#a39c2c03f93b309e65a45ac91c6eb39bd">More...</a><br /></td></tr>
  156. <tr class="separator:a39c2c03f93b309e65a45ac91c6eb39bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:aa610e72e8f23f0d26388f204c848ed57"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#aa610e72e8f23f0d26388f204c848ed57">messageReceived</a> = null</td></tr>
  158. <tr class="memdesc:aa610e72e8f23f0d26388f204c848ed57"><td class="mdescLeft">&#160;</td><td class="mdescRight">received message <a href="#aa610e72e8f23f0d26388f204c848ed57">More...</a><br /></td></tr>
  159. <tr class="separator:aa610e72e8f23f0d26388f204c848ed57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:aea039cd0f99f5193c307b805077669db"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_command_manager.html#aea039cd0f99f5193c307b805077669db">isBusy</a> = false</td></tr>
  161. <tr class="memdesc:aea039cd0f99f5193c307b805077669db"><td class="mdescLeft">&#160;</td><td class="mdescRight">flag indicating command manager is currently busy waiting an acknowledge <a href="#aea039cd0f99f5193c307b805077669db">More...</a><br /></td></tr>
  162. <tr class="separator:aea039cd0f99f5193c307b805077669db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. </table>
  164. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  165. <div class="textblock"><p>Command Manager. Use for timeout managment during reception of data Used as intermediate layer between TCP client class (<a class="el" href="classmonitor_1_1_client.html" title="Static class for TCP client ">Client</a>) and application level managment of command and answers </p>
  166. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00031">31</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  167. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  168. <a id="ac8ca53031468acc8be05c37586671a9b"></a>
  169. <h2 class="memtitle"><span class="permalink"><a href="#ac8ca53031468acc8be05c37586671a9b">&#9670;&nbsp;</a></span>CommandManagerStatus</h2>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="mlabels">
  173. <tr>
  174. <td class="mlabels-left">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname">enum <a class="el" href="classmonitor_1_1_command_manager.html#ac8ca53031468acc8be05c37586671a9b">monitor.CommandManager.CommandManagerStatus</a></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">strong</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Available status when sending command </p>
  187. <table class="fieldtable">
  188. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac8ca53031468acc8be05c37586671a9bae3e095863e3b99e11e8c18efb3901da3"></a>AnswerReceived&#160;</td><td class="fielddoc"></td></tr>
  189. <tr><td class="fieldname"><a id="ac8ca53031468acc8be05c37586671a9bac85a251cc457840f1e032f1b733e9398"></a>Timeout&#160;</td><td class="fielddoc"></td></tr>
  190. <tr><td class="fieldname"><a id="ac8ca53031468acc8be05c37586671a9bad8a942ef2b04672adfafef0ad817a407"></a>Busy&#160;</td><td class="fielddoc"></td></tr>
  191. </table>
  192. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00063">63</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  193. </div>
  194. </div>
  195. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  196. <a id="ac2248c90d3a59bc2bf376cd876cece72"></a>
  197. <h2 class="memtitle"><span class="permalink"><a href="#ac2248c90d3a59bc2bf376cd876cece72">&#9670;&nbsp;</a></span>CommandManager()</h2>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">monitor.CommandManager.CommandManager </td>
  203. <td>(</td>
  204. <td class="paramtype"><a class="el" href="classmonitor_1_1_command_manager.html#a5afd16036cc3d0e69554f69dacad0bcc">CommandReceivedEvent</a>&#160;</td>
  205. <td class="paramname"><em>callback</em></td><td>)</td>
  206. <td></td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <p>Initializes a new instance of the T:monitor.CommandManager class. </p>
  211. <dl class="params"><dt>Parameters</dt><dd>
  212. <table class="params">
  213. <tr><td class="paramname">callback</td><td>Callback used when new message are received</td></tr>
  214. </table>
  215. </dd>
  216. </dl>
  217. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00074">74</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  218. </div>
  219. </div>
  220. <a id="ad2a8eb1139a5a25a6993887c55b3da4e"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#ad2a8eb1139a5a25a6993887c55b3da4e">&#9670;&nbsp;</a></span>~CommandManager()</h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">monitor.CommandManager.~CommandManager </td>
  230. <td>(</td>
  231. <td class="paramname"></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Releases unmanaged resources and performs other cleanup operations before the T:monitor.CommandManager is reclaimed by garbage collection. </p>
  242. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00086">86</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  243. </div>
  244. </div>
  245. <h2 class="groupheader">Member Function Documentation</h2>
  246. <a id="ab28b0e5a2641391e655aaaaa05a1fdf6"></a>
  247. <h2 class="memtitle"><span class="permalink"><a href="#ab28b0e5a2641391e655aaaaa05a1fdf6">&#9670;&nbsp;</a></span>Close()</h2>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname">void monitor.CommandManager.Close </td>
  253. <td>(</td>
  254. <td class="paramname"></td><td>)</td>
  255. <td></td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. <p>Close connection to server </p>
  260. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00115">115</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  261. </div>
  262. </div>
  263. <a id="a5afd16036cc3d0e69554f69dacad0bcc"></a>
  264. <h2 class="memtitle"><span class="permalink"><a href="#a5afd16036cc3d0e69554f69dacad0bcc">&#9670;&nbsp;</a></span>CommandReceivedEvent()</h2>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">delegate void monitor.CommandManager.CommandReceivedEvent </td>
  270. <td>(</td>
  271. <td class="paramtype">string&#160;</td>
  272. <td class="paramname"><em>msg</em>, </td>
  273. </tr>
  274. <tr>
  275. <td class="paramkey"></td>
  276. <td></td>
  277. <td class="paramtype">byte []&#160;</td>
  278. <td class="paramname"><em>buffer</em>&#160;</td>
  279. </tr>
  280. <tr>
  281. <td></td>
  282. <td>)</td>
  283. <td></td><td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <p>Callback for sending received data to upper level </p>
  288. </div>
  289. </div>
  290. <a id="a92e5d42afb61f29d9a4746b4446c2a65"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#a92e5d42afb61f29d9a4746b4446c2a65">&#9670;&nbsp;</a></span>OnMessageReception()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="mlabels">
  295. <tr>
  296. <td class="mlabels-left">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">void monitor.CommandManager.OnMessageReception </td>
  300. <td>(</td>
  301. <td class="paramtype">string&#160;</td>
  302. <td class="paramname"><em>message</em>, </td>
  303. </tr>
  304. <tr>
  305. <td class="paramkey"></td>
  306. <td></td>
  307. <td class="paramtype">byte []&#160;</td>
  308. <td class="paramname"><em>buffer</em>&#160;</td>
  309. </tr>
  310. <tr>
  311. <td></td>
  312. <td>)</td>
  313. <td></td><td></td>
  314. </tr>
  315. </table>
  316. </td>
  317. <td class="mlabels-right">
  318. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. <p>Callback called by <a class="el" href="classmonitor_1_1_client.html" title="Static class for TCP client ">Client</a> class after reception of new message </p>
  323. <dl class="params"><dt>Parameters</dt><dd>
  324. <table class="params">
  325. <tr><td class="paramname">message</td><td>Message received from server</td></tr>
  326. <tr><td class="paramname">buffer</td><td>Raw buffer reived from server</td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00125">125</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  331. </div>
  332. </div>
  333. <a id="a2f91bb775ba25855be007886b994a5df"></a>
  334. <h2 class="memtitle"><span class="permalink"><a href="#a2f91bb775ba25855be007886b994a5df">&#9670;&nbsp;</a></span>OnMessageTimeout()</h2>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="mlabels">
  338. <tr>
  339. <td class="mlabels-left">
  340. <table class="memname">
  341. <tr>
  342. <td class="memname">void monitor.CommandManager.OnMessageTimeout </td>
  343. <td>(</td>
  344. <td class="paramtype">object&#160;</td>
  345. <td class="paramname"><em>sender</em>, </td>
  346. </tr>
  347. <tr>
  348. <td class="paramkey"></td>
  349. <td></td>
  350. <td class="paramtype">System.Timers.ElapsedEventArgs&#160;</td>
  351. <td class="paramname"><em>e</em>&#160;</td>
  352. </tr>
  353. <tr>
  354. <td></td>
  355. <td>)</td>
  356. <td></td><td></td>
  357. </tr>
  358. </table>
  359. </td>
  360. <td class="mlabels-right">
  361. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <p>Callback called by stopwatch on timeout </p>
  366. <dl class="params"><dt>Parameters</dt><dd>
  367. <table class="params">
  368. <tr><td class="paramname">sender</td><td>Sender object</td></tr>
  369. <tr><td class="paramname">e</td><td>Information on elapsed condition</td></tr>
  370. </table>
  371. </dd>
  372. </dl>
  373. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00156">156</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  374. </div>
  375. </div>
  376. <a id="a7329cbf8008bcb8a0280aa7ffa6aa43c"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#a7329cbf8008bcb8a0280aa7ffa6aa43c">&#9670;&nbsp;</a></span>Open() <span class="overload">[1/2]</span></h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">bool monitor.CommandManager.Open </td>
  383. <td>(</td>
  384. <td class="paramtype">string&#160;</td>
  385. <td class="paramname"><em>hostname</em></td><td>)</td>
  386. <td></td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>Open the specified hostname server, using default port number. </p>
  391. <dl class="section return"><dt>Returns</dt><dd>true if connection succeded, false otherwise</dd></dl>
  392. <dl class="params"><dt>Parameters</dt><dd>
  393. <table class="params">
  394. <tr><td class="paramname">hostname</td><td>Hostname to connect to</td></tr>
  395. </table>
  396. </dd>
  397. </dl>
  398. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00096">96</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  399. </div>
  400. </div>
  401. <a id="a0a0054ee87d293577fa39af1fcd5ffee"></a>
  402. <h2 class="memtitle"><span class="permalink"><a href="#a0a0054ee87d293577fa39af1fcd5ffee">&#9670;&nbsp;</a></span>Open() <span class="overload">[2/2]</span></h2>
  403. <div class="memitem">
  404. <div class="memproto">
  405. <table class="memname">
  406. <tr>
  407. <td class="memname">bool monitor.CommandManager.Open </td>
  408. <td>(</td>
  409. <td class="paramtype">string&#160;</td>
  410. <td class="paramname"><em>hostname</em>, </td>
  411. </tr>
  412. <tr>
  413. <td class="paramkey"></td>
  414. <td></td>
  415. <td class="paramtype">int&#160;</td>
  416. <td class="paramname"><em>port</em>&#160;</td>
  417. </tr>
  418. <tr>
  419. <td></td>
  420. <td>)</td>
  421. <td></td><td></td>
  422. </tr>
  423. </table>
  424. </div><div class="memdoc">
  425. <p>Open connection to server "host", with port number "port" </p>
  426. <dl class="section return"><dt>Returns</dt><dd>true if connection succeded, false otherwise</dd></dl>
  427. <dl class="params"><dt>Parameters</dt><dd>
  428. <table class="params">
  429. <tr><td class="paramname">hostname</td><td>Hostname to connect to</td></tr>
  430. <tr><td class="paramname">port</td><td>Port number for connection</td></tr>
  431. </table>
  432. </dd>
  433. </dl>
  434. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00107">107</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  435. </div>
  436. </div>
  437. <a id="a3cd1f2303e47e5148fd3e927a7957363"></a>
  438. <h2 class="memtitle"><span class="permalink"><a href="#a3cd1f2303e47e5148fd3e927a7957363">&#9670;&nbsp;</a></span>SendCommand()</h2>
  439. <div class="memitem">
  440. <div class="memproto">
  441. <table class="memname">
  442. <tr>
  443. <td class="memname"><a class="el" href="classmonitor_1_1_command_manager.html#ac8ca53031468acc8be05c37586671a9b">CommandManagerStatus</a> monitor.CommandManager.SendCommand </td>
  444. <td>(</td>
  445. <td class="paramtype">string&#160;</td>
  446. <td class="paramname"><em>cmd</em>, </td>
  447. </tr>
  448. <tr>
  449. <td class="paramkey"></td>
  450. <td></td>
  451. <td class="paramtype">out string&#160;</td>
  452. <td class="paramname"><em>answer</em>, </td>
  453. </tr>
  454. <tr>
  455. <td class="paramkey"></td>
  456. <td></td>
  457. <td class="paramtype">double&#160;</td>
  458. <td class="paramname"><em>timeout</em>&#160;</td>
  459. </tr>
  460. <tr>
  461. <td></td>
  462. <td>)</td>
  463. <td></td><td></td>
  464. </tr>
  465. </table>
  466. </div><div class="memdoc">
  467. <p>Sends a command to TCP server </p>
  468. <dl class="section return"><dt>Returns</dt><dd>status that is part of CommandManagerStatus enumerate</dd></dl>
  469. <dl class="params"><dt>Parameters</dt><dd>
  470. <table class="params">
  471. <tr><td class="paramname">cmd</td><td>Command message to send to server</td></tr>
  472. <tr><td class="paramname">answer</td><td>Answer from server, in case of acknowledge</td></tr>
  473. <tr><td class="paramname">timeout</td><td>Timeout (ms) waiting an acknowledge, 0 if no acknowledge needed</td></tr>
  474. </table>
  475. </dd>
  476. </dl>
  477. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00171">171</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  478. </div>
  479. </div>
  480. <h2 class="groupheader">Member Data Documentation</h2>
  481. <a id="ab90d68a3d3a9b3935fa9f1a57e8dabfa"></a>
  482. <h2 class="memtitle"><span class="permalink"><a href="#ab90d68a3d3a9b3935fa9f1a57e8dabfa">&#9670;&nbsp;</a></span>commandReceivedEvent</h2>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="memname">
  486. <tr>
  487. <td class="memname"><a class="el" href="classmonitor_1_1_command_manager.html#a5afd16036cc3d0e69554f69dacad0bcc">CommandReceivedEvent</a> monitor.CommandManager.commandReceivedEvent = null</td>
  488. </tr>
  489. </table>
  490. </div><div class="memdoc">
  491. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00037">37</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  492. </div>
  493. </div>
  494. <a id="aea039cd0f99f5193c307b805077669db"></a>
  495. <h2 class="memtitle"><span class="permalink"><a href="#aea039cd0f99f5193c307b805077669db">&#9670;&nbsp;</a></span>isBusy</h2>
  496. <div class="memitem">
  497. <div class="memproto">
  498. <table class="mlabels">
  499. <tr>
  500. <td class="mlabels-left">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname">bool monitor.CommandManager.isBusy = false</td>
  504. </tr>
  505. </table>
  506. </td>
  507. <td class="mlabels-right">
  508. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  509. </tr>
  510. </table>
  511. </div><div class="memdoc">
  512. <p>flag indicating command manager is currently busy waiting an acknowledge </p>
  513. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00058">58</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  514. </div>
  515. </div>
  516. <a id="aa610e72e8f23f0d26388f204c848ed57"></a>
  517. <h2 class="memtitle"><span class="permalink"><a href="#aa610e72e8f23f0d26388f204c848ed57">&#9670;&nbsp;</a></span>messageReceived</h2>
  518. <div class="memitem">
  519. <div class="memproto">
  520. <table class="mlabels">
  521. <tr>
  522. <td class="mlabels-left">
  523. <table class="memname">
  524. <tr>
  525. <td class="memname">string monitor.CommandManager.messageReceived = null</td>
  526. </tr>
  527. </table>
  528. </td>
  529. <td class="mlabels-right">
  530. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  531. </tr>
  532. </table>
  533. </div><div class="memdoc">
  534. <p>received message </p>
  535. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00053">53</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  536. </div>
  537. </div>
  538. <a id="a0d27eb1a38efb01559f14a707ff86447"></a>
  539. <h2 class="memtitle"><span class="permalink"><a href="#a0d27eb1a38efb01559f14a707ff86447">&#9670;&nbsp;</a></span>waitEvent</h2>
  540. <div class="memitem">
  541. <div class="memproto">
  542. <table class="mlabels">
  543. <tr>
  544. <td class="mlabels-left">
  545. <table class="memname">
  546. <tr>
  547. <td class="memname">ManualResetEvent monitor.CommandManager.waitEvent = new ManualResetEvent(false)</td>
  548. </tr>
  549. </table>
  550. </td>
  551. <td class="mlabels-right">
  552. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  553. </tr>
  554. </table>
  555. </div><div class="memdoc">
  556. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00043">43</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  557. </div>
  558. </div>
  559. <a id="a39c2c03f93b309e65a45ac91c6eb39bd"></a>
  560. <h2 class="memtitle"><span class="permalink"><a href="#a39c2c03f93b309e65a45ac91c6eb39bd">&#9670;&nbsp;</a></span>waitForAcknowledge</h2>
  561. <div class="memitem">
  562. <div class="memproto">
  563. <table class="mlabels">
  564. <tr>
  565. <td class="mlabels-left">
  566. <table class="memname">
  567. <tr>
  568. <td class="memname">bool monitor.CommandManager.waitForAcknowledge = false</td>
  569. </tr>
  570. </table>
  571. </td>
  572. <td class="mlabels-right">
  573. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  574. </tr>
  575. </table>
  576. </div><div class="memdoc">
  577. <p>Flag to tell rogram to wait for an acknowledge from server </p>
  578. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00048">48</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  579. </div>
  580. </div>
  581. <a id="a07639cd39445a379667a2450e78001b0"></a>
  582. <h2 class="memtitle"><span class="permalink"><a href="#a07639cd39445a379667a2450e78001b0">&#9670;&nbsp;</a></span>waitTimer</h2>
  583. <div class="memitem">
  584. <div class="memproto">
  585. <table class="mlabels">
  586. <tr>
  587. <td class="mlabels-left">
  588. <table class="memname">
  589. <tr>
  590. <td class="memname">System.Timers.Timer monitor.CommandManager.waitTimer = new System.Timers.Timer()</td>
  591. </tr>
  592. </table>
  593. </td>
  594. <td class="mlabels-right">
  595. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  596. </tr>
  597. </table>
  598. </div><div class="memdoc">
  599. <p>Timer for managing timeout </p>
  600. <p class="definition">Definition at line <a class="el" href="_command_manager_8cs_source.html#l00042">42</a> of file <a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a>.</p>
  601. </div>
  602. </div>
  603. <hr/>The documentation for this class was generated from the following file:<ul>
  604. <li><a class="el" href="_command_manager_8cs_source.html">CommandManager.cs</a></li>
  605. </ul>
  606. </div><!-- contents -->
  607. </div><!-- doc-content -->
  608. <!-- start footer part -->
  609. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  610. <ul>
  611. <li class="navelem"><a class="el" href="namespacemonitor.html">monitor</a></li><li class="navelem"><a class="el" href="classmonitor_1_1_command_manager.html">CommandManager</a></li>
  612. <li class="footer">Generated by
  613. <a href="http://www.doxygen.org/index.html">
  614. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  615. </ul>
  616. </div>
  617. </body>
  618. </html>