class_remote_debugger_bridge.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: RemoteDebuggerBridge 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="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-types">Public Types</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  75. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  76. <a href="class_remote_debugger_bridge-members.html">List of all members</a> </div>
  77. <div class="headertitle"><div class="title">RemoteDebuggerBridge Class Reference</div></div>
  78. </div><!--header-->
  79. <div class="contents">
  80. <p><code>#include &lt;RemoteDebuggerBridge.h&gt;</code></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  83. Public Types</h2></td></tr>
  84. <tr class="memitem:acdd867d72142510ce53521a63a062f9b" id="r_acdd867d72142510ce53521a63a062f9b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9b">ConnectionState</a> { <br />
  85. &#160;&#160;<a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9ba30c0b4dad1e3a3b93f822b9cef26244b">Closed</a>
  86. , <a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9bac8e6944e998ac466c3cc4a648dde8291">Open</a>
  87. , <a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9bad253364cc2926eb617b0833335fe4467">Connected</a>
  88. , <a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9baa1f2b10d8b3527c6bfe6351a64095b04">LoggedOff</a>
  89. , <br />
  90. &#160;&#160;<a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9ba29e45de29bd0303f83e48b1274fb9339">LoggedOn</a>
  91. <br />
  92. }</td></tr>
  93. <tr class="separator:acdd867d72142510ce53521a63a062f9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table><table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  96. Public Member Functions</h2></td></tr>
  97. <tr class="memitem:afc9eb76829dcdb838bfbc0a1b01ce9a5" id="r_afc9eb76829dcdb838bfbc0a1b01ce9a5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#afc9eb76829dcdb838bfbc0a1b01ce9a5">RemoteDebuggerBridge</a> ()</td></tr>
  98. <tr class="separator:afc9eb76829dcdb838bfbc0a1b01ce9a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:aa7d22c9cc2f69a54b75ceddebb5a16e0" id="r_aa7d22c9cc2f69a54b75ceddebb5a16e0"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#aa7d22c9cc2f69a54b75ceddebb5a16e0">~RemoteDebuggerBridge</a> ()</td></tr>
  100. <tr class="separator:aa7d22c9cc2f69a54b75ceddebb5a16e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table><table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  103. Static Public Member Functions</h2></td></tr>
  104. <tr class="memitem:a072a0db45345fdb7851de310d91c246a" id="r_a072a0db45345fdb7851de310d91c246a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#a072a0db45345fdb7851de310d91c246a">processCommandLine</a> (S32 argc, const char **argv)</td></tr>
  105. <tr class="memdesc:a072a0db45345fdb7851de310d91c246a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Direct bridge control. <br /></td></tr>
  106. <tr class="separator:a072a0db45345fdb7851de310d91c246a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a27c94eada48a6eb7c0e8a6b1b73143b7" id="r_a27c94eada48a6eb7c0e8a6b1b73143b7"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#a27c94eada48a6eb7c0e8a6b1b73143b7">open</a> (const S32 debuggerVersion, const S32 port, const char *pPassword)</td></tr>
  108. <tr class="separator:a27c94eada48a6eb7c0e8a6b1b73143b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:addf576577f1694a549052a7a10fc1e9b" id="r_addf576577f1694a549052a7a10fc1e9b"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#addf576577f1694a549052a7a10fc1e9b">close</a> (void)</td></tr>
  110. <tr class="separator:addf576577f1694a549052a7a10fc1e9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a1e52bfa77f2122be831f8dd92058804e" id="r_a1e52bfa77f2122be831f8dd92058804e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9b">ConnectionState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#a1e52bfa77f2122be831f8dd92058804e">getConnectionState</a> (void)</td></tr>
  112. <tr class="separator:a1e52bfa77f2122be831f8dd92058804e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:abd3b77a2401304a929ab74c527b732f6" id="r_abd3b77a2401304a929ab74c527b732f6"><td class="memItemLeft" align="right" valign="top">static StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#abd3b77a2401304a929ab74c527b732f6">getConnectionPassword</a> (void)</td></tr>
  114. <tr class="separator:abd3b77a2401304a929ab74c527b732f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  117. Static Public Attributes</h2></td></tr>
  118. <tr class="memitem:a0fb314c1f033169ec266e1039ab1d098" id="r_a0fb314c1f033169ec266e1039ab1d098"><td class="memItemLeft" align="right" valign="top">static const S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_remote_debugger_bridge.html#a0fb314c1f033169ec266e1039ab1d098">IdleWaitPeriod</a> = 100</td></tr>
  119. <tr class="separator:a0fb314c1f033169ec266e1039ab1d098"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <h2 class="groupheader">Member Enumeration Documentation</h2>
  122. <a id="acdd867d72142510ce53521a63a062f9b" name="acdd867d72142510ce53521a63a062f9b"></a>
  123. <h2 class="memtitle"><span class="permalink"><a href="#acdd867d72142510ce53521a63a062f9b">&#9670;&#160;</a></span>ConnectionState</h2>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">enum <a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9b">ConnectionState</a></td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <table class="fieldtable">
  133. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acdd867d72142510ce53521a63a062f9ba30c0b4dad1e3a3b93f822b9cef26244b" name="acdd867d72142510ce53521a63a062f9ba30c0b4dad1e3a3b93f822b9cef26244b"></a>Closed&#160;</td><td class="fielddoc"></td></tr>
  134. <tr><td class="fieldname"><a id="acdd867d72142510ce53521a63a062f9bac8e6944e998ac466c3cc4a648dde8291" name="acdd867d72142510ce53521a63a062f9bac8e6944e998ac466c3cc4a648dde8291"></a>Open&#160;</td><td class="fielddoc"></td></tr>
  135. <tr><td class="fieldname"><a id="acdd867d72142510ce53521a63a062f9bad253364cc2926eb617b0833335fe4467" name="acdd867d72142510ce53521a63a062f9bad253364cc2926eb617b0833335fe4467"></a>Connected&#160;</td><td class="fielddoc"></td></tr>
  136. <tr><td class="fieldname"><a id="acdd867d72142510ce53521a63a062f9baa1f2b10d8b3527c6bfe6351a64095b04" name="acdd867d72142510ce53521a63a062f9baa1f2b10d8b3527c6bfe6351a64095b04"></a>LoggedOff&#160;</td><td class="fielddoc"></td></tr>
  137. <tr><td class="fieldname"><a id="acdd867d72142510ce53521a63a062f9ba29e45de29bd0303f83e48b1274fb9339" name="acdd867d72142510ce53521a63a062f9ba29e45de29bd0303f83e48b1274fb9339"></a>LoggedOn&#160;</td><td class="fielddoc"></td></tr>
  138. </table>
  139. </div>
  140. </div>
  141. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  142. <a id="afc9eb76829dcdb838bfbc0a1b01ce9a5" name="afc9eb76829dcdb838bfbc0a1b01ce9a5"></a>
  143. <h2 class="memtitle"><span class="permalink"><a href="#afc9eb76829dcdb838bfbc0a1b01ce9a5">&#9670;&#160;</a></span>RemoteDebuggerBridge()</h2>
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="mlabels">
  147. <tr>
  148. <td class="mlabels-left">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname"><a class="el" href="class_remote_debugger_bridge.html">RemoteDebuggerBridge</a> </td>
  152. <td>(</td>
  153. <td class="paramname"></td><td>)</td>
  154. <td></td>
  155. </tr>
  156. </table>
  157. </td>
  158. <td class="mlabels-right">
  159. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. </div>
  164. </div>
  165. <a id="aa7d22c9cc2f69a54b75ceddebb5a16e0" name="aa7d22c9cc2f69a54b75ceddebb5a16e0"></a>
  166. <h2 class="memtitle"><span class="permalink"><a href="#aa7d22c9cc2f69a54b75ceddebb5a16e0">&#9670;&#160;</a></span>~RemoteDebuggerBridge()</h2>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="mlabels">
  170. <tr>
  171. <td class="mlabels-left">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">virtual ~<a class="el" href="class_remote_debugger_bridge.html">RemoteDebuggerBridge</a> </td>
  175. <td>(</td>
  176. <td class="paramname"></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. </div>
  187. </div>
  188. <h2 class="groupheader">Member Function Documentation</h2>
  189. <a id="addf576577f1694a549052a7a10fc1e9b" name="addf576577f1694a549052a7a10fc1e9b"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#addf576577f1694a549052a7a10fc1e9b">&#9670;&#160;</a></span>close()</h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">bool close </td>
  199. <td>(</td>
  200. <td class="paramtype">void&#160;</td>
  201. <td class="paramname"></td><td>)</td>
  202. <td></td>
  203. </tr>
  204. </table>
  205. </td>
  206. <td class="mlabels-right">
  207. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. </div>
  212. </div>
  213. <a id="abd3b77a2401304a929ab74c527b732f6" name="abd3b77a2401304a929ab74c527b732f6"></a>
  214. <h2 class="memtitle"><span class="permalink"><a href="#abd3b77a2401304a929ab74c527b732f6">&#9670;&#160;</a></span>getConnectionPassword()</h2>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="mlabels">
  218. <tr>
  219. <td class="mlabels-left">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">StringTableEntry getConnectionPassword </td>
  223. <td>(</td>
  224. <td class="paramtype">void&#160;</td>
  225. <td class="paramname"></td><td>)</td>
  226. <td></td>
  227. </tr>
  228. </table>
  229. </td>
  230. <td class="mlabels-right">
  231. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. </div>
  236. </div>
  237. <a id="a1e52bfa77f2122be831f8dd92058804e" name="a1e52bfa77f2122be831f8dd92058804e"></a>
  238. <h2 class="memtitle"><span class="permalink"><a href="#a1e52bfa77f2122be831f8dd92058804e">&#9670;&#160;</a></span>getConnectionState()</h2>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <table class="mlabels">
  242. <tr>
  243. <td class="mlabels-left">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname"><a class="el" href="class_remote_debugger_bridge.html#acdd867d72142510ce53521a63a062f9b">RemoteDebuggerBridge::ConnectionState</a> getConnectionState </td>
  247. <td>(</td>
  248. <td class="paramtype">void&#160;</td>
  249. <td class="paramname"></td><td>)</td>
  250. <td></td>
  251. </tr>
  252. </table>
  253. </td>
  254. <td class="mlabels-right">
  255. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. </div>
  260. </div>
  261. <a id="a27c94eada48a6eb7c0e8a6b1b73143b7" name="a27c94eada48a6eb7c0e8a6b1b73143b7"></a>
  262. <h2 class="memtitle"><span class="permalink"><a href="#a27c94eada48a6eb7c0e8a6b1b73143b7">&#9670;&#160;</a></span>open()</h2>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="mlabels">
  266. <tr>
  267. <td class="mlabels-left">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">bool open </td>
  271. <td>(</td>
  272. <td class="paramtype">const S32&#160;</td>
  273. <td class="paramname"><em>debuggerVersion</em>, </td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey"></td>
  277. <td></td>
  278. <td class="paramtype">const S32&#160;</td>
  279. <td class="paramname"><em>port</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">const char *&#160;</td>
  285. <td class="paramname"><em>pPassword</em>&#160;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. </div>
  300. </div>
  301. <a id="a072a0db45345fdb7851de310d91c246a" name="a072a0db45345fdb7851de310d91c246a"></a>
  302. <h2 class="memtitle"><span class="permalink"><a href="#a072a0db45345fdb7851de310d91c246a">&#9670;&#160;</a></span>processCommandLine()</h2>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="mlabels">
  306. <tr>
  307. <td class="mlabels-left">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">void processCommandLine </td>
  311. <td>(</td>
  312. <td class="paramtype">S32&#160;</td>
  313. <td class="paramname"><em>argc</em>, </td>
  314. </tr>
  315. <tr>
  316. <td class="paramkey"></td>
  317. <td></td>
  318. <td class="paramtype">const char **&#160;</td>
  319. <td class="paramname"><em>argv</em>&#160;</td>
  320. </tr>
  321. <tr>
  322. <td></td>
  323. <td>)</td>
  324. <td></td><td></td>
  325. </tr>
  326. </table>
  327. </td>
  328. <td class="mlabels-right">
  329. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Direct bridge control. </p>
  334. </div>
  335. </div>
  336. <h2 class="groupheader">Member Data Documentation</h2>
  337. <a id="a0fb314c1f033169ec266e1039ab1d098" name="a0fb314c1f033169ec266e1039ab1d098"></a>
  338. <h2 class="memtitle"><span class="permalink"><a href="#a0fb314c1f033169ec266e1039ab1d098">&#9670;&#160;</a></span>IdleWaitPeriod</h2>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <table class="mlabels">
  342. <tr>
  343. <td class="mlabels-left">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">const S32 IdleWaitPeriod = 100</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. </div>
  356. </div>
  357. <hr/>The documentation for this class was generated from the following files:<ul>
  358. <li>debug/remote/<b>RemoteDebuggerBridge.h</b></li>
  359. <li>debug/remote/<b>RemoteDebuggerBridge.cc</b></li>
  360. </ul>
  361. </div><!-- contents -->
  362. <!-- start footer part -->
  363. <hr class="footer"/><address class="footer"><small>
  364. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  365. </small></address>
  366. </body>
  367. </html>