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_client.html 33KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697
  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.Client 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_client.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-methods">Public Member Functions</a> &#124;
  83. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  84. <a href="#pub-attribs">Public Attributes</a> &#124;
  85. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  86. <a href="#pri-static-methods">Static Private Member Functions</a> &#124;
  87. <a href="#pri-attribs">Private Attributes</a> &#124;
  88. <a href="#pri-static-attribs">Static Private Attributes</a> &#124;
  89. <a href="classmonitor_1_1_client-members.html">List of all members</a> </div>
  90. <div class="headertitle">
  91. <div class="title">monitor.Client Class Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <p>Static class for TCP client
  95. <a href="classmonitor_1_1_client.html#details">More...</a></p>
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  98. Public Member Functions</h2></td></tr>
  99. <tr class="memitem:ae85f4aa567a41488d5c65e470ae15378"><td class="memItemLeft" align="right" valign="top">delegate void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#ae85f4aa567a41488d5c65e470ae15378">ReadEvent</a> (string msg, byte[] <a class="el" href="classmonitor_1_1_client.html#abd5c33a23e0fab7b369b59ac296c7762">buffer</a>)</td></tr>
  100. <tr class="memdesc:ae85f4aa567a41488d5c65e470ae15378"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback to send received message to upper level <a href="#ae85f4aa567a41488d5c65e470ae15378">More...</a><br /></td></tr>
  101. <tr class="separator:ae85f4aa567a41488d5c65e470ae15378"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table><table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  104. Static Public Member Functions</h2></td></tr>
  105. <tr class="memitem:af802cd428aa08b9604e2246f11e1fe61"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#af802cd428aa08b9604e2246f11e1fe61">Open</a> (string host)</td></tr>
  106. <tr class="memdesc:af802cd428aa08b9604e2246f11e1fe61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open connection to server "host", on default port number. <a href="#af802cd428aa08b9604e2246f11e1fe61">More...</a><br /></td></tr>
  107. <tr class="separator:af802cd428aa08b9604e2246f11e1fe61"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:aee6f8f594a9496600b78c37d6da457d4"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#aee6f8f594a9496600b78c37d6da457d4">Open</a> (string host, int port)</td></tr>
  109. <tr class="memdesc:aee6f8f594a9496600b78c37d6da457d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open connection to server "host", with port number "port" <a href="#aee6f8f594a9496600b78c37d6da457d4">More...</a><br /></td></tr>
  110. <tr class="separator:aee6f8f594a9496600b78c37d6da457d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ae6c0cbe19d622b008fd1f6d01d9cb315"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#ae6c0cbe19d622b008fd1f6d01d9cb315">Close</a> ()</td></tr>
  112. <tr class="memdesc:ae6c0cbe19d622b008fd1f6d01d9cb315"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close connection to server <a href="#ae6c0cbe19d622b008fd1f6d01d9cb315">More...</a><br /></td></tr>
  113. <tr class="separator:ae6c0cbe19d622b008fd1f6d01d9cb315"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a081413295e7a96662b39b2ddec854b02"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a081413295e7a96662b39b2ddec854b02">Write</a> (string mes)</td></tr>
  115. <tr class="memdesc:a081413295e7a96662b39b2ddec854b02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a string to server <a href="#a081413295e7a96662b39b2ddec854b02">More...</a><br /></td></tr>
  116. <tr class="separator:a081413295e7a96662b39b2ddec854b02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table><table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  119. Public Attributes</h2></td></tr>
  120. <tr class="memitem:a326a20fe68a86757e16a6e45b8012640"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a326a20fe68a86757e16a6e45b8012640">defaultIP</a> = &quot;localhost&quot;</td></tr>
  121. <tr class="memdesc:a326a20fe68a86757e16a6e45b8012640"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default server name <a href="#a326a20fe68a86757e16a6e45b8012640">More...</a><br /></td></tr>
  122. <tr class="separator:a326a20fe68a86757e16a6e45b8012640"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:ad0a9bfc361ccef7443625f399e67f84a"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#ad0a9bfc361ccef7443625f399e67f84a">defaultPort</a> = 4500</td></tr>
  124. <tr class="memdesc:ad0a9bfc361ccef7443625f399e67f84a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default server port number <a href="#ad0a9bfc361ccef7443625f399e67f84a">More...</a><br /></td></tr>
  125. <tr class="separator:ad0a9bfc361ccef7443625f399e67f84a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table><table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  128. Static Public Attributes</h2></td></tr>
  129. <tr class="memitem:a01cb2a551d81fd82d2f7015e177f0f18"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmonitor_1_1_client.html#ae85f4aa567a41488d5c65e470ae15378">ReadEvent</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a01cb2a551d81fd82d2f7015e177f0f18">readEvent</a> = null</td></tr>
  130. <tr class="separator:a01cb2a551d81fd82d2f7015e177f0f18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table><table class="memberdecls">
  132. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
  133. Static Private Member Functions</h2></td></tr>
  134. <tr class="memitem:a8dd2eb26c164d0f566dd6c679ba340e0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a8dd2eb26c164d0f566dd6c679ba340e0">ReadCallback</a> (IAsyncResult ar)</td></tr>
  135. <tr class="memdesc:a8dd2eb26c164d0f566dd6c679ba340e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback call by stream.BeginRead after reception of newLength data <a href="#a8dd2eb26c164d0f566dd6c679ba340e0">More...</a><br /></td></tr>
  136. <tr class="separator:a8dd2eb26c164d0f566dd6c679ba340e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table><table class="memberdecls">
  138. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  139. Private Attributes</h2></td></tr>
  140. <tr class="memitem:acbc4cae14536eccb5297aacdadb84f29"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#acbc4cae14536eccb5297aacdadb84f29">BufferMaxSize</a> = 512</td></tr>
  141. <tr class="memdesc:acbc4cae14536eccb5297aacdadb84f29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of internal buffer used when reading data from server <a href="#acbc4cae14536eccb5297aacdadb84f29">More...</a><br /></td></tr>
  142. <tr class="separator:acbc4cae14536eccb5297aacdadb84f29"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. </table><table class="memberdecls">
  144. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
  145. Static Private Attributes</h2></td></tr>
  146. <tr class="memitem:a4867b48ebfa930a80662c552f2911430"><td class="memItemLeft" align="right" valign="top">static TcpClient&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a4867b48ebfa930a80662c552f2911430">client</a> = null</td></tr>
  147. <tr class="memdesc:a4867b48ebfa930a80662c552f2911430"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tcp client object <a href="#a4867b48ebfa930a80662c552f2911430">More...</a><br /></td></tr>
  148. <tr class="separator:a4867b48ebfa930a80662c552f2911430"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a8de2a9e4fe2c2e896849ddd33d80d759"><td class="memItemLeft" align="right" valign="top">static NetworkStream&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a8de2a9e4fe2c2e896849ddd33d80d759">stream</a> = null</td></tr>
  150. <tr class="memdesc:a8de2a9e4fe2c2e896849ddd33d80d759"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stream object used for communication <a href="#a8de2a9e4fe2c2e896849ddd33d80d759">More...</a><br /></td></tr>
  151. <tr class="separator:a8de2a9e4fe2c2e896849ddd33d80d759"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:abd5c33a23e0fab7b369b59ac296c7762"><td class="memItemLeft" align="right" valign="top">static byte []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#abd5c33a23e0fab7b369b59ac296c7762">buffer</a> = new byte[<a class="el" href="classmonitor_1_1_client.html#acbc4cae14536eccb5297aacdadb84f29">BufferMaxSize</a>]</td></tr>
  153. <tr class="memdesc:abd5c33a23e0fab7b369b59ac296c7762"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal buffer used when reading data from server <a href="#abd5c33a23e0fab7b369b59ac296c7762">More...</a><br /></td></tr>
  154. <tr class="separator:abd5c33a23e0fab7b369b59ac296c7762"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:aade32a6043e0dc629509f0e1c0112a24"><td class="memItemLeft" align="right" valign="top">static byte []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#aade32a6043e0dc629509f0e1c0112a24">receiveBuffer</a></td></tr>
  156. <tr class="memdesc:aade32a6043e0dc629509f0e1c0112a24"><td class="mdescLeft">&#160;</td><td class="mdescRight">buffer containing received message from TCP server Used to concatenate internal buffers into one <a href="#aade32a6043e0dc629509f0e1c0112a24">More...</a><br /></td></tr>
  157. <tr class="separator:aade32a6043e0dc629509f0e1c0112a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:afbbf4cf14d1a11747f6103e726dee77e"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#afbbf4cf14d1a11747f6103e726dee77e">initialReceiveBufferIndex</a> = 0</td></tr>
  159. <tr class="separator:afbbf4cf14d1a11747f6103e726dee77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a2ddb7073c4bf8a42c231939d5c21d68e"><td class="memItemLeft" align="right" valign="top">static StringBuilder&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a2ddb7073c4bf8a42c231939d5c21d68e">message</a> = new StringBuilder()</td></tr>
  161. <tr class="memdesc:a2ddb7073c4bf8a42c231939d5c21d68e"><td class="mdescLeft">&#160;</td><td class="mdescRight">String containing received message from tcp server <a href="#a2ddb7073c4bf8a42c231939d5c21d68e">More...</a><br /></td></tr>
  162. <tr class="separator:a2ddb7073c4bf8a42c231939d5c21d68e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a7083940b8fea9df2b080e3844549e805"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a7083940b8fea9df2b080e3844549e805">newLength</a> = 1</td></tr>
  164. <tr class="separator:a7083940b8fea9df2b080e3844549e805"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a7eb13840c83beb2ab191cae3ba3210c9"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmonitor_1_1_client.html#a7eb13840c83beb2ab191cae3ba3210c9">packetCounter</a> = 0</td></tr>
  166. <tr class="separator:a7eb13840c83beb2ab191cae3ba3210c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. </table>
  168. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  169. <div class="textblock"><p>Static class for TCP client </p>
  170. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00031">31</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  171. </div><h2 class="groupheader">Member Function Documentation</h2>
  172. <a id="ae6c0cbe19d622b008fd1f6d01d9cb315"></a>
  173. <h2 class="memtitle"><span class="permalink"><a href="#ae6c0cbe19d622b008fd1f6d01d9cb315">&#9670;&nbsp;</a></span>Close()</h2>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="mlabels">
  177. <tr>
  178. <td class="mlabels-left">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">static void monitor.Client.Close </td>
  182. <td>(</td>
  183. <td class="paramname"></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Close connection to server </p>
  194. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00141">141</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  195. </div>
  196. </div>
  197. <a id="af802cd428aa08b9604e2246f11e1fe61"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#af802cd428aa08b9604e2246f11e1fe61">&#9670;&nbsp;</a></span>Open() <span class="overload">[1/2]</span></h2>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="mlabels">
  202. <tr>
  203. <td class="mlabels-left">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">static bool monitor.Client.Open </td>
  207. <td>(</td>
  208. <td class="paramtype">string&#160;</td>
  209. <td class="paramname"><em>host</em></td><td>)</td>
  210. <td></td>
  211. </tr>
  212. </table>
  213. </td>
  214. <td class="mlabels-right">
  215. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>Open connection to server "host", on default port number. </p>
  220. <dl class="section return"><dt>Returns</dt><dd>true if connection succeded, false otherwise</dd></dl>
  221. <dl class="params"><dt>Parameters</dt><dd>
  222. <table class="params">
  223. <tr><td class="paramname">host</td><td>Hostname to connect to</td></tr>
  224. </table>
  225. </dd>
  226. </dl>
  227. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00089">89</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  228. </div>
  229. </div>
  230. <a id="aee6f8f594a9496600b78c37d6da457d4"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#aee6f8f594a9496600b78c37d6da457d4">&#9670;&nbsp;</a></span>Open() <span class="overload">[2/2]</span></h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="mlabels">
  235. <tr>
  236. <td class="mlabels-left">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname">static bool monitor.Client.Open </td>
  240. <td>(</td>
  241. <td class="paramtype">string&#160;</td>
  242. <td class="paramname"><em>host</em>, </td>
  243. </tr>
  244. <tr>
  245. <td class="paramkey"></td>
  246. <td></td>
  247. <td class="paramtype">int&#160;</td>
  248. <td class="paramname"><em>port</em>&#160;</td>
  249. </tr>
  250. <tr>
  251. <td></td>
  252. <td>)</td>
  253. <td></td><td></td>
  254. </tr>
  255. </table>
  256. </td>
  257. <td class="mlabels-right">
  258. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Open connection to server "host", with port number "port" </p>
  263. <dl class="section return"><dt>Returns</dt><dd>true if connection succeded, false otherwise</dd></dl>
  264. <dl class="params"><dt>Parameters</dt><dd>
  265. <table class="params">
  266. <tr><td class="paramname">host</td><td>Hostname to connect to</td></tr>
  267. <tr><td class="paramname">port</td><td>Port number for connection</td></tr>
  268. </table>
  269. </dd>
  270. </dl>
  271. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00100">100</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  272. </div>
  273. </div>
  274. <a id="a8dd2eb26c164d0f566dd6c679ba340e0"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#a8dd2eb26c164d0f566dd6c679ba340e0">&#9670;&nbsp;</a></span>ReadCallback()</h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="mlabels">
  279. <tr>
  280. <td class="mlabels-left">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">static void monitor.Client.ReadCallback </td>
  284. <td>(</td>
  285. <td class="paramtype">IAsyncResult&#160;</td>
  286. <td class="paramname"><em>ar</em></td><td>)</td>
  287. <td></td>
  288. </tr>
  289. </table>
  290. </td>
  291. <td class="mlabels-right">
  292. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Callback call by stream.BeginRead after reception of newLength data </p>
  297. <dl class="params"><dt>Parameters</dt><dd>
  298. <table class="params">
  299. <tr><td class="paramname">ar</td><td>Not sure of what is it, but needed for terminate reading</td></tr>
  300. </table>
  301. </dd>
  302. </dl>
  303. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00151">151</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  304. </div>
  305. </div>
  306. <a id="ae85f4aa567a41488d5c65e470ae15378"></a>
  307. <h2 class="memtitle"><span class="permalink"><a href="#ae85f4aa567a41488d5c65e470ae15378">&#9670;&nbsp;</a></span>ReadEvent()</h2>
  308. <div class="memitem">
  309. <div class="memproto">
  310. <table class="memname">
  311. <tr>
  312. <td class="memname">delegate void monitor.Client.ReadEvent </td>
  313. <td>(</td>
  314. <td class="paramtype">string&#160;</td>
  315. <td class="paramname"><em>msg</em>, </td>
  316. </tr>
  317. <tr>
  318. <td class="paramkey"></td>
  319. <td></td>
  320. <td class="paramtype">byte []&#160;</td>
  321. <td class="paramname"><em>buffer</em>&#160;</td>
  322. </tr>
  323. <tr>
  324. <td></td>
  325. <td>)</td>
  326. <td></td><td></td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Callback to send received message to upper level </p>
  331. </div>
  332. </div>
  333. <a id="a081413295e7a96662b39b2ddec854b02"></a>
  334. <h2 class="memtitle"><span class="permalink"><a href="#a081413295e7a96662b39b2ddec854b02">&#9670;&nbsp;</a></span>Write()</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">static void monitor.Client.Write </td>
  343. <td>(</td>
  344. <td class="paramtype">string&#160;</td>
  345. <td class="paramname"><em>mes</em></td><td>)</td>
  346. <td></td>
  347. </tr>
  348. </table>
  349. </td>
  350. <td class="mlabels-right">
  351. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>Write a string to server </p>
  356. <dl class="section return"><dt>Returns</dt><dd>Nothing</dd></dl>
  357. <dl class="params"><dt>Parameters</dt><dd>
  358. <table class="params">
  359. <tr><td class="paramname">mes</td><td>Message to send to server</td></tr>
  360. </table>
  361. </dd>
  362. </dl>
  363. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00219">219</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  364. </div>
  365. </div>
  366. <h2 class="groupheader">Member Data Documentation</h2>
  367. <a id="abd5c33a23e0fab7b369b59ac296c7762"></a>
  368. <h2 class="memtitle"><span class="permalink"><a href="#abd5c33a23e0fab7b369b59ac296c7762">&#9670;&nbsp;</a></span>buffer</h2>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="mlabels">
  372. <tr>
  373. <td class="mlabels-left">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">byte [] monitor.Client.buffer = new byte[<a class="el" href="classmonitor_1_1_client.html#acbc4cae14536eccb5297aacdadb84f29">BufferMaxSize</a>]</td>
  377. </tr>
  378. </table>
  379. </td>
  380. <td class="mlabels-right">
  381. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Internal buffer used when reading data from server </p>
  386. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00061">61</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  387. </div>
  388. </div>
  389. <a id="acbc4cae14536eccb5297aacdadb84f29"></a>
  390. <h2 class="memtitle"><span class="permalink"><a href="#acbc4cae14536eccb5297aacdadb84f29">&#9670;&nbsp;</a></span>BufferMaxSize</h2>
  391. <div class="memitem">
  392. <div class="memproto">
  393. <table class="mlabels">
  394. <tr>
  395. <td class="mlabels-left">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">const int monitor.Client.BufferMaxSize = 512</td>
  399. </tr>
  400. </table>
  401. </td>
  402. <td class="mlabels-right">
  403. <span class="mlabels"><span class="mlabel">private</span></span> </td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <p>Size of internal buffer used when reading data from server </p>
  408. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00056">56</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  409. </div>
  410. </div>
  411. <a id="a4867b48ebfa930a80662c552f2911430"></a>
  412. <h2 class="memtitle"><span class="permalink"><a href="#a4867b48ebfa930a80662c552f2911430">&#9670;&nbsp;</a></span>client</h2>
  413. <div class="memitem">
  414. <div class="memproto">
  415. <table class="mlabels">
  416. <tr>
  417. <td class="mlabels-left">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">TcpClient monitor.Client.client = null</td>
  421. </tr>
  422. </table>
  423. </td>
  424. <td class="mlabels-right">
  425. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <p>Tcp client object </p>
  430. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00046">46</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  431. </div>
  432. </div>
  433. <a id="a326a20fe68a86757e16a6e45b8012640"></a>
  434. <h2 class="memtitle"><span class="permalink"><a href="#a326a20fe68a86757e16a6e45b8012640">&#9670;&nbsp;</a></span>defaultIP</h2>
  435. <div class="memitem">
  436. <div class="memproto">
  437. <table class="memname">
  438. <tr>
  439. <td class="memname">const string monitor.Client.defaultIP = &quot;localhost&quot;</td>
  440. </tr>
  441. </table>
  442. </div><div class="memdoc">
  443. <p>Default server name </p>
  444. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00036">36</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  445. </div>
  446. </div>
  447. <a id="ad0a9bfc361ccef7443625f399e67f84a"></a>
  448. <h2 class="memtitle"><span class="permalink"><a href="#ad0a9bfc361ccef7443625f399e67f84a">&#9670;&nbsp;</a></span>defaultPort</h2>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">const int monitor.Client.defaultPort = 4500</td>
  454. </tr>
  455. </table>
  456. </div><div class="memdoc">
  457. <p>Default server port number </p>
  458. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00041">41</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  459. </div>
  460. </div>
  461. <a id="afbbf4cf14d1a11747f6103e726dee77e"></a>
  462. <h2 class="memtitle"><span class="permalink"><a href="#afbbf4cf14d1a11747f6103e726dee77e">&#9670;&nbsp;</a></span>initialReceiveBufferIndex</h2>
  463. <div class="memitem">
  464. <div class="memproto">
  465. <table class="mlabels">
  466. <tr>
  467. <td class="mlabels-left">
  468. <table class="memname">
  469. <tr>
  470. <td class="memname">int monitor.Client.initialReceiveBufferIndex = 0</td>
  471. </tr>
  472. </table>
  473. </td>
  474. <td class="mlabels-right">
  475. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  476. </tr>
  477. </table>
  478. </div><div class="memdoc">
  479. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00069">69</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  480. </div>
  481. </div>
  482. <a id="a2ddb7073c4bf8a42c231939d5c21d68e"></a>
  483. <h2 class="memtitle"><span class="permalink"><a href="#a2ddb7073c4bf8a42c231939d5c21d68e">&#9670;&nbsp;</a></span>message</h2>
  484. <div class="memitem">
  485. <div class="memproto">
  486. <table class="mlabels">
  487. <tr>
  488. <td class="mlabels-left">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname">StringBuilder monitor.Client.message = new StringBuilder()</td>
  492. </tr>
  493. </table>
  494. </td>
  495. <td class="mlabels-right">
  496. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  497. </tr>
  498. </table>
  499. </div><div class="memdoc">
  500. <p>String containing received message from tcp server </p>
  501. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00074">74</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  502. </div>
  503. </div>
  504. <a id="a7083940b8fea9df2b080e3844549e805"></a>
  505. <h2 class="memtitle"><span class="permalink"><a href="#a7083940b8fea9df2b080e3844549e805">&#9670;&nbsp;</a></span>newLength</h2>
  506. <div class="memitem">
  507. <div class="memproto">
  508. <table class="mlabels">
  509. <tr>
  510. <td class="mlabels-left">
  511. <table class="memname">
  512. <tr>
  513. <td class="memname">int monitor.Client.newLength = 1</td>
  514. </tr>
  515. </table>
  516. </td>
  517. <td class="mlabels-right">
  518. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  519. </tr>
  520. </table>
  521. </div><div class="memdoc">
  522. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00075">75</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  523. </div>
  524. </div>
  525. <a id="a7eb13840c83beb2ab191cae3ba3210c9"></a>
  526. <h2 class="memtitle"><span class="permalink"><a href="#a7eb13840c83beb2ab191cae3ba3210c9">&#9670;&nbsp;</a></span>packetCounter</h2>
  527. <div class="memitem">
  528. <div class="memproto">
  529. <table class="mlabels">
  530. <tr>
  531. <td class="mlabels-left">
  532. <table class="memname">
  533. <tr>
  534. <td class="memname">int monitor.Client.packetCounter = 0</td>
  535. </tr>
  536. </table>
  537. </td>
  538. <td class="mlabels-right">
  539. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  540. </tr>
  541. </table>
  542. </div><div class="memdoc">
  543. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00076">76</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  544. </div>
  545. </div>
  546. <a id="a01cb2a551d81fd82d2f7015e177f0f18"></a>
  547. <h2 class="memtitle"><span class="permalink"><a href="#a01cb2a551d81fd82d2f7015e177f0f18">&#9670;&nbsp;</a></span>readEvent</h2>
  548. <div class="memitem">
  549. <div class="memproto">
  550. <table class="mlabels">
  551. <tr>
  552. <td class="mlabels-left">
  553. <table class="memname">
  554. <tr>
  555. <td class="memname"><a class="el" href="classmonitor_1_1_client.html#ae85f4aa567a41488d5c65e470ae15378">ReadEvent</a> monitor.Client.readEvent = null</td>
  556. </tr>
  557. </table>
  558. </td>
  559. <td class="mlabels-right">
  560. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  561. </tr>
  562. </table>
  563. </div><div class="memdoc">
  564. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00082">82</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  565. </div>
  566. </div>
  567. <a id="aade32a6043e0dc629509f0e1c0112a24"></a>
  568. <h2 class="memtitle"><span class="permalink"><a href="#aade32a6043e0dc629509f0e1c0112a24">&#9670;&nbsp;</a></span>receiveBuffer</h2>
  569. <div class="memitem">
  570. <div class="memproto">
  571. <table class="mlabels">
  572. <tr>
  573. <td class="mlabels-left">
  574. <table class="memname">
  575. <tr>
  576. <td class="memname">byte [] monitor.Client.receiveBuffer</td>
  577. </tr>
  578. </table>
  579. </td>
  580. <td class="mlabels-right">
  581. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  582. </tr>
  583. </table>
  584. </div><div class="memdoc">
  585. <p>buffer containing received message from TCP server Used to concatenate internal buffers into one </p>
  586. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00067">67</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  587. </div>
  588. </div>
  589. <a id="a8de2a9e4fe2c2e896849ddd33d80d759"></a>
  590. <h2 class="memtitle"><span class="permalink"><a href="#a8de2a9e4fe2c2e896849ddd33d80d759">&#9670;&nbsp;</a></span>stream</h2>
  591. <div class="memitem">
  592. <div class="memproto">
  593. <table class="mlabels">
  594. <tr>
  595. <td class="mlabels-left">
  596. <table class="memname">
  597. <tr>
  598. <td class="memname">NetworkStream monitor.Client.stream = null</td>
  599. </tr>
  600. </table>
  601. </td>
  602. <td class="mlabels-right">
  603. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
  604. </tr>
  605. </table>
  606. </div><div class="memdoc">
  607. <p>Stream object used for communication </p>
  608. <p class="definition">Definition at line <a class="el" href="_client_8cs_source.html#l00051">51</a> of file <a class="el" href="_client_8cs_source.html">Client.cs</a>.</p>
  609. </div>
  610. </div>
  611. <hr/>The documentation for this class was generated from the following file:<ul>
  612. <li><a class="el" href="_client_8cs_source.html">Client.cs</a></li>
  613. </ul>
  614. </div><!-- contents -->
  615. </div><!-- doc-content -->
  616. <!-- start footer part -->
  617. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  618. <ul>
  619. <li class="navelem"><a class="el" href="namespacemonitor.html">monitor</a></li><li class="navelem"><a class="el" href="classmonitor_1_1_client.html">Client</a></li>
  620. <li class="footer">Generated by
  621. <a href="http://www.doxygen.org/index.html">
  622. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  623. </ul>
  624. </div>
  625. </body>
  626. </html>