1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
<!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.6 -->
<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_6b47ac86da6aee9115280ffa56155f66.html">llvm</a></li><li class="navelem"><a class="el" href="dir_b8cffa74dcb91bca0da221349fa85523.html">tools</a></li><li class="navelem"><a class="el" href="dir_bdcf59bf838c999fcfc3dde87d35c9f0.html">lldb</a></li><li class="navelem"><a class="el" href="dir_42333c9da4438c4e48b6683e9ba44a59.html">include</a></li><li class="navelem"><a class="el" href="dir_30e71e610673c7b74c5ccda0fc334ee9.html">lldb</a></li><li class="navelem"><a class="el" href="dir_65cab015c1f428073772d528e6a1b53d.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="line" href="classlldb_1_1SBCommunication.html"> 18</a></span> <span class="keyword">class </span>LLDB_API <a class="code" href="classlldb_1_1SBCommunication.html">SBCommunication</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classlldb_1_1SBCommunication.html#ac3ae284f827effc2193d2df4320f9a8a"> 20</a></span>  <a class="code" href="classlldb_1_1SBCommunication.html#ac3ae284f827effc2193d2df4320f9a8a">FLAGS_ANONYMOUS_ENUM</a>(){</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  eBroadcastBitDisconnected =</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  (1 << 0), <span class="comment">///< Sent when the communications connection is lost.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span> eBroadcastBitReadThreadGotBytes =</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  (1 << 1), <span class="comment">///< Sent by the read thread when bytes become available.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> eBroadcastBitReadThreadDidExit =</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  (1</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  << 2), <span class="comment">///< Sent by the read thread when it exits to inform clients.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span> eBroadcastBitReadThreadShouldExit =</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  (1 << 3), <span class="comment">///< Sent by clients that need to cancel the read thread.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span> eBroadcastBitPacketAvailable =</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  (1 << 4), <span class="comment">///< Sent when data received makes a complete packet.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span> eAllEventBits = 0xffffffff};</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classlldb_1_1SBCommunication.html#ad07a358eba73f4710760c943f208e072"> 34</a></span>  <span class="keyword">typedef</span> void (*ReadThreadBytesReceived)(<span class="keywordtype">void</span> *baton, <span class="keyword">const</span> <span class="keywordtype">void</span> *src,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">size_t</span> src_len);</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>  <a class="code" href="namespacelldb.html#a3c8aac4af10b0cecf374d1a756a1252b">SBCommunication</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="namespacelldb.html#a3c8aac4af10b0cecf374d1a756a1252b">SBCommunication</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *broadcaster_name);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  ~<a class="code" href="classlldb_1_1SBCommunication.html">SBCommunication</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">bool</span> IsValid() <span class="keyword">const</span>;</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>  <a class="code" href="classlldb_1_1SBBroadcaster.html">lldb::SBBroadcaster</a> GetBroadcaster();</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>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetBroadcasterClass();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  lldb::ConnectionStatus AdoptFileDesriptor(<span class="keywordtype">int</span> fd, <span class="keywordtype">bool</span> owns_fd);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  lldb::ConnectionStatus Connect(<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 Disconnect();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">bool</span> IsConnected() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">bool</span> GetCloseOnEOF();</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">void</span> SetCloseOnEOF(<span class="keywordtype">bool</span> b);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">size_t</span> Read(<span class="keywordtype">void</span> *dst, <span class="keywordtype">size_t</span> dst_len, uint32_t timeout_usec,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  lldb::ConnectionStatus &status);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">size_t</span> Write(<span class="keyword">const</span> <span class="keywordtype">void</span> *src, <span class="keywordtype">size_t</span> src_len, lldb::ConnectionStatus &status);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">bool</span> ReadThreadStart();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">bool</span> ReadThreadStop();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span> ReadThreadIsRunning();</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> SetReadThreadBytesReceivedCallback(ReadThreadBytesReceived callback,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">void</span> *callback_baton);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  DISALLOW_COPY_AND_ASSIGN(<a class="code" href="classlldb_1_1SBCommunication.html">SBCommunication</a>);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  lldb_private::Communication *m_opaque;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">bool</span> m_opaque_owned;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> } <span class="comment">// namespace lldb</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#endif // LLDB_SBCommunication_h_</span></div>
<div class="ttc" id="classlldb_1_1SBCommunication_html"><div class="ttname"><a href="classlldb_1_1SBCommunication.html">lldb::SBCommunication</a></div><div class="ttdef"><b>Definition:</b> <a href="SBCommunication_8h_source.html#l00018">SBCommunication.h:18</a></div></div>
<div class="ttc" id="classlldb_1_1SBBroadcaster_html"><div class="ttname"><a href="classlldb_1_1SBBroadcaster.html">lldb::SBBroadcaster</a></div><div class="ttdef"><b>Definition:</b> <a href="SBBroadcaster_8h_source.html#l00017">SBBroadcaster.h:17</a></div></div>
<div class="ttc" id="SBDefines_8h_html"><div class="ttname"><a href="SBDefines_8h.html">SBDefines.h</a></div></div>
<div class="ttc" id="classlldb_1_1SBCommunication_html_ac3ae284f827effc2193d2df4320f9a8a"><div class="ttname"><a href="classlldb_1_1SBCommunication.html#ac3ae284f827effc2193d2df4320f9a8a">lldb::SBCommunication::FLAGS_ANONYMOUS_ENUM</a></div><div class="ttdeci">FLAGS_ANONYMOUS_ENUM()</div><div class="ttdef"><b>Definition:</b> <a href="SBCommunication_8h_source.html#l00020">SBCommunication.h:20</a></div></div>
<div class="ttc" id="namespacelldb_html_a3c8aac4af10b0cecf374d1a756a1252b"><div class="ttname"><a href="namespacelldb.html#a3c8aac4af10b0cecf374d1a756a1252b">lldb::SBCommunication</a></div><div class="ttdeci">class LLDB_API SBCommunication</div><div class="ttdef"><b>Definition:</b> <a href="SBDefines_8h_source.html#l00041">SBDefines.h:41</a></div></div>
<div class="ttc" id="SBError_8h_html"><div class="ttname"><a href="SBError_8h.html">SBError.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<hr>
<p class="footer">
Generated on Fri Oct 14 2016 14:01:23 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.6</a><br>
Copyright © 2003-2013 University of Illinois at Urbana-Champaign.
All Rights Reserved.</p>
<hr>
<!--#include virtual="/attrib.incl" -->
</body>
</html>
|
