forked from OSchip/llvm-project
145 lines
19 KiB
HTML
145 lines
19 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
|
|
<html><head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
|
||
|
|
<meta name="keywords" content="LLDB,C++,doxygen,API,documentation"/>
|
||
|
|
<meta name="description" content="C++ source code API documentation for LLDB."/>
|
||
|
|
<title>LLVM: SBCommunication.h Source File</title>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
||
|
|
</head><body>
|
||
|
|
<p class="title">LLDB API Documentation</p>
|
||
|
|
<!-- Generated by Doxygen 1.8.1.2 -->
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="navrow2" class="tabs2">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="dir_217b186c19a2bb8bc0ee0f71fb72d4e8.html">tools</a></li><li class="navelem"><a class="el" href="dir_fa64c3fa8a988674a1a867b97ca9a790.html">lldb</a></li><li class="navelem"><a class="el" href="dir_9d4b8469db156c557ab1d649b027ec2e.html">include</a></li><li class="navelem"><a class="el" href="dir_c02e3ff158c3064d7b78c6aa6fc411e6.html">lldb</a></li><li class="navelem"><a class="el" href="dir_36ad4ea5df2b352cce0512435d34c8a4.html">API</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">SBCommunication.h</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<a href="SBCommunication_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//===-- SBCommunication.h ---------------------------------------*- C++ -*-===//</span></div>
|
||
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div>
|
||
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// The LLVM Compiler Infrastructure</span></div>
|
||
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div>
|
||
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// This file is distributed under the University of Illinois Open Source</span></div>
|
||
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// License. See LICENSE.TXT for details.</span></div>
|
||
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
|
||
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//===----------------------------------------------------------------------===//</span></div>
|
||
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
|
||
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef LLDB_SBCommunication_h_</span></div>
|
||
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define LLDB_SBCommunication_h_</span></div>
|
||
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div>
|
||
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="SBDefines_8h.html">lldb/API/SBDefines.h</a>"</span></div>
|
||
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="SBError_8h.html">lldb/API/SBError.h</a>"</span></div>
|
||
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
||
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span>lldb {</div>
|
||
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
||
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommunication.html"> 18</a></span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBCommunication.html">SBCommunication</a></div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div>
|
||
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div>
|
||
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">enum</span> {</div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a10e4887dd35116e8ac097b20cda440b4"> 22</a></span>  <a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a10e4887dd35116e8ac097b20cda440b4" title="Sent when the communications connection is lost.">eBroadcastBitDisconnected</a> = (1 << 0), <span class="comment">///< Sent when the communications connection is lost.</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a0f482c64abdd477de9df8afc4a1078cb"> 23</a></span> <span class="comment"></span> <a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a0f482c64abdd477de9df8afc4a1078cb" title="Sent by the read thread when bytes become available.">eBroadcastBitReadThreadGotBytes</a> = (1 << 1), <span class="comment">///< Sent by the read thread when bytes become available.</span></div>
|
||
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a554b212d9591c624847c15e035c1f3fc"> 24</a></span> <span class="comment"></span> <a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a554b212d9591c624847c15e035c1f3fc" title="Sent by the read thread when it exits to inform clients.">eBroadcastBitReadThreadDidExit</a> = (1 << 2), <span class="comment">///< Sent by the read thread when it exits to inform clients.</span></div>
|
||
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a7aaf636aab623833d3d3541dd74ca4c4"> 25</a></span> <span class="comment"></span> <a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a7aaf636aab623833d3d3541dd74ca4c4" title="Sent by clients that need to cancel the read thread.">eBroadcastBitReadThreadShouldExit</a> = (1 << 3), <span class="comment">///< Sent by clients that need to cancel the read thread.</span></div>
|
||
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24aa742f87f608eae9eed2756433f6d8d7b"> 26</a></span> <span class="comment"></span> <a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24aa742f87f608eae9eed2756433f6d8d7b" title="Sent when data received makes a complete packet.">eBroadcastBitPacketAvailable</a> = (1 << 4), <span class="comment">///< Sent when data received makes a complete packet.</span></div>
|
||
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a9408507cb4af14a627054e299d02962e"> 27</a></span> <span class="comment"></span> <a class="code" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a9408507cb4af14a627054e299d02962e">eAllEventBits</a> = 0xffffffff</div>
|
||
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  };</div>
|
||
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
|
||
|
|
<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCommunication.html#ad07a358eba73f4710760c943f208e072"> 30</a></span>  <span class="keyword">typedef</span> void (*<a class="code" href="classlldb_1_1SBCommunication.html#ad07a358eba73f4710760c943f208e072">ReadThreadBytesReceived</a>) (<span class="keywordtype">void</span> *baton, <span class="keyword">const</span> <span class="keywordtype">void</span> *src, <span class="keywordtype">size_t</span> src_len);</div>
|
||
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
|
||
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a7cb85c673867e63fac1350a815b5cdb8">SBCommunication</a> ();</div>
|
||
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a7cb85c673867e63fac1350a815b5cdb8">SBCommunication</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * broadcaster_name);</div>
|
||
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classlldb_1_1SBCommunication.html#af192a76b5cf136f36939dbac4425584b">~SBCommunication</a> ();</div>
|
||
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
|
||
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
|
||
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">bool</span></div>
|
||
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a3159b3af4c33fa27b057aa2810aaa7a2">IsValid</a> () <span class="keyword">const</span>;</div>
|
||
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
||
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classlldb_1_1SBBroadcaster.html">lldb::SBBroadcaster</a></div>
|
||
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classlldb_1_1SBCommunication.html#abd27f73fbc5bdfc6373c1ca67ac91e7f">GetBroadcaster</a> ();</div>
|
||
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
||
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classlldb_1_1SBCommunication.html#a3924231f38ad0bcb25c9d9b0027a3428">GetBroadcasterClass</a>();</div>
|
||
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
|
||
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  lldb::ConnectionStatus</div>
|
||
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a3f7ac6e63989b1c85db0bf918b32dc3e">AdoptFileDesriptor</a> (<span class="keywordtype">int</span> fd, <span class="keywordtype">bool</span> owns_fd);</div>
|
||
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
|
||
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  lldb::ConnectionStatus</div>
|
||
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a7d9b670ea00515ae87203754238f5399">Connect</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *url);</div>
|
||
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
|
||
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  lldb::ConnectionStatus</div>
|
||
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classlldb_1_1SBCommunication.html#adf990fcd6cfcc113438fef8fae674d07">Disconnect</a> ();</div>
|
||
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
|
||
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">bool</span></div>
|
||
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a1e018a3a596670e740b8226ae058808d">IsConnected</a> () <span class="keyword">const</span>;</div>
|
||
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
|
||
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">bool</span></div>
|
||
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classlldb_1_1SBCommunication.html#acf203ffd8066819069491e12846a4113">GetCloseOnEOF</a> ();</div>
|
||
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
|
||
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span></div>
|
||
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a6bab0e67b2467789125f9f903b353d46">SetCloseOnEOF</a> (<span class="keywordtype">bool</span> b);</div>
|
||
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
|
||
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">size_t</span></div>
|
||
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classlldb_1_1SBCommunication.html#af40a4ad9f2f4a8bef704fa6f20756fd8">Read</a> (<span class="keywordtype">void</span> *dst,</div>
|
||
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">size_t</span> dst_len,</div>
|
||
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  uint32_t timeout_usec,</div>
|
||
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  lldb::ConnectionStatus &status);</div>
|
||
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
|
||
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">size_t</span></div>
|
||
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a5e95d57662c88378ad25f4d02d32b1e4">Write</a> (<span class="keyword">const</span> <span class="keywordtype">void</span> *src,</div>
|
||
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">size_t</span> src_len,</div>
|
||
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  lldb::ConnectionStatus &status);</div>
|
||
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
||
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">bool</span></div>
|
||
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a69bed79b9f866e5508e29d41d85f188b">ReadThreadStart</a> ();</div>
|
||
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
|
||
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">bool</span></div>
|
||
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classlldb_1_1SBCommunication.html#aec744b634df7cf656a675162447f6727">ReadThreadStop</a> ();</div>
|
||
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
|
||
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span></div>
|
||
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classlldb_1_1SBCommunication.html#ae69b67ed32dcf8e19febab317fa2a36c">ReadThreadIsRunning</a> ();</div>
|
||
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
|
||
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">bool</span></div>
|
||
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classlldb_1_1SBCommunication.html#a1e0f406e60bc684dba5a520dd3e618fd">SetReadThreadBytesReceivedCallback</a> (<a class="code" href="classlldb_1_1SBCommunication.html#ad07a358eba73f4710760c943f208e072">ReadThreadBytesReceived</a> callback,</div>
|
||
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> *callback_baton);</div>
|
||
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
||
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
|
||
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">private</span>:</div>
|
||
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
|
||
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  DISALLOW_COPY_AND_ASSIGN (<a class="code" href="classlldb_1_1SBCommunication.html">SBCommunication</a>);</div>
|
||
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
|
||
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  lldb_private::Communication *m_opaque;</div>
|
||
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">bool</span> m_opaque_owned;</div>
|
||
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</div>
|
||
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
|
||
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
|
||
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } <span class="comment">// namespace lldb</span></div>
|
||
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
|
||
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif // LLDB_SBCommunication_h_</span></div>
|
||
|
|
</div><!-- fragment --></div><!-- contents -->
|
||
|
|
<hr>
|
||
|
|
<p class="footer">
|
||
|
|
Generated on Fri Jul 19 2013 13:25:55 for <a href="http://lldb.llvm.org/">LLVM</a> by
|
||
|
|
<a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
|
||
|
|
align="middle" border="0"/>1.8.1.2</a><br>
|
||
|
|
Copyright © 2003-2013 University of Illinois at Urbana-Champaign.
|
||
|
|
All Rights Reserved.</p>
|
||
|
|
<hr>
|
||
|
|
<!--#include virtual="/attrib.incl" -->
|
||
|
|
</body>
|
||
|
|
</html>
|