<!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: lldb::SBCommunication Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelldb.html">lldb</a></li><li class="navelem"><a class="el" href="classlldb_1_1SBCommunication.html">SBCommunication</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classlldb_1_1SBCommunication-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">lldb::SBCommunication Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="SBCommunication_8h_source.html">SBCommunication.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a243c1e015e1252221caaad8d59a13a24"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br/>
  <a class="el" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a10e4887dd35116e8ac097b20cda440b4">eBroadcastBitDisconnected</a> = (1 << 0),
<a class="el" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a0f482c64abdd477de9df8afc4a1078cb">eBroadcastBitReadThreadGotBytes</a> = (1 << 1),
<a class="el" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a554b212d9591c624847c15e035c1f3fc">eBroadcastBitReadThreadDidExit</a> = (1 << 2),
<a class="el" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a7aaf636aab623833d3d3541dd74ca4c4">eBroadcastBitReadThreadShouldExit</a> = (1 << 3),
<br/>
  <a class="el" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24aa742f87f608eae9eed2756433f6d8d7b">eBroadcastBitPacketAvailable</a> = (1 << 4),
<a class="el" href="classlldb_1_1SBCommunication.html#a243c1e015e1252221caaad8d59a13a24a9408507cb4af14a627054e299d02962e">eAllEventBits</a> = 0xffffffff
<br/>
}</td></tr>
<tr class="memitem:ad07a358eba73f4710760c943f208e072"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#ad07a358eba73f4710760c943f208e072">ReadThreadBytesReceived</a> )(void *baton, const void *src, size_t src_len)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7cb85c673867e63fac1350a815b5cdb8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a7cb85c673867e63fac1350a815b5cdb8">SBCommunication</a> ()</td></tr>
<tr class="memitem:a3119b917f55edbc995d69045c740dfca"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a3119b917f55edbc995d69045c740dfca">SBCommunication</a> (const char *broadcaster_name)</td></tr>
<tr class="memitem:af192a76b5cf136f36939dbac4425584b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#af192a76b5cf136f36939dbac4425584b">~SBCommunication</a> ()</td></tr>
<tr class="memitem:a3159b3af4c33fa27b057aa2810aaa7a2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a3159b3af4c33fa27b057aa2810aaa7a2">IsValid</a> () const </td></tr>
<tr class="memitem:abd27f73fbc5bdfc6373c1ca67ac91e7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlldb_1_1SBBroadcaster.html">lldb::SBBroadcaster</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#abd27f73fbc5bdfc6373c1ca67ac91e7f">GetBroadcaster</a> ()</td></tr>
<tr class="memitem:a3f7ac6e63989b1c85db0bf918b32dc3e"><td class="memItemLeft" align="right" valign="top">lldb::ConnectionStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a3f7ac6e63989b1c85db0bf918b32dc3e">AdoptFileDesriptor</a> (int fd, bool owns_fd)</td></tr>
<tr class="memitem:a7d9b670ea00515ae87203754238f5399"><td class="memItemLeft" align="right" valign="top">lldb::ConnectionStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a7d9b670ea00515ae87203754238f5399">Connect</a> (const char *url)</td></tr>
<tr class="memitem:adf990fcd6cfcc113438fef8fae674d07"><td class="memItemLeft" align="right" valign="top">lldb::ConnectionStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#adf990fcd6cfcc113438fef8fae674d07">Disconnect</a> ()</td></tr>
<tr class="memitem:a1e018a3a596670e740b8226ae058808d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a1e018a3a596670e740b8226ae058808d">IsConnected</a> () const </td></tr>
<tr class="memitem:acf203ffd8066819069491e12846a4113"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#acf203ffd8066819069491e12846a4113">GetCloseOnEOF</a> ()</td></tr>
<tr class="memitem:a6bab0e67b2467789125f9f903b353d46"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a6bab0e67b2467789125f9f903b353d46">SetCloseOnEOF</a> (bool b)</td></tr>
<tr class="memitem:af40a4ad9f2f4a8bef704fa6f20756fd8"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#af40a4ad9f2f4a8bef704fa6f20756fd8">Read</a> (void *dst, size_t dst_len, uint32_t timeout_usec, lldb::ConnectionStatus &status)</td></tr>
<tr class="memitem:a5e95d57662c88378ad25f4d02d32b1e4"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a5e95d57662c88378ad25f4d02d32b1e4">Write</a> (const void *src, size_t src_len, lldb::ConnectionStatus &status)</td></tr>
<tr class="memitem:a69bed79b9f866e5508e29d41d85f188b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a69bed79b9f866e5508e29d41d85f188b">ReadThreadStart</a> ()</td></tr>
<tr class="memitem:aec744b634df7cf656a675162447f6727"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#aec744b634df7cf656a675162447f6727">ReadThreadStop</a> ()</td></tr>
<tr class="memitem:ae69b67ed32dcf8e19febab317fa2a36c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#ae69b67ed32dcf8e19febab317fa2a36c">ReadThreadIsRunning</a> ()</td></tr>
<tr class="memitem:a1e0f406e60bc684dba5a520dd3e618fd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a1e0f406e60bc684dba5a520dd3e618fd">SetReadThreadBytesReceivedCallback</a> (<a class="el" href="classlldb_1_1SBCommunication.html#ad07a358eba73f4710760c943f208e072">ReadThreadBytesReceived</a> callback, void *callback_baton)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a3924231f38ad0bcb25c9d9b0027a3428"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommunication.html#a3924231f38ad0bcb25c9d9b0027a3428">GetBroadcasterClass</a> ()</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="SBCommunication_8h_source.html#l00018">18</a> of file <a class="el" href="SBCommunication_8h_source.html">SBCommunication.h</a>.</p>
</div><h2>Member Typedef Documentation</h2>
<a class="anchor" id="ad07a358eba73f4710760c943f208e072"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* lldb::SBCommunication::ReadThreadBytesReceived)(void *baton, const void *src, size_t src_len)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SBCommunication_8h_source.html#l00030">30</a> of file <a class="el" href="SBCommunication_8h_source.html">SBCommunication.h</a>.</p>
</div>
</div>
<h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a243c1e015e1252221caaad8d59a13a24"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a243c1e015e1252221caaad8d59a13a24a10e4887dd35116e8ac097b20cda440b4"></a>eBroadcastBitDisconnected</em> </td><td>
<p>Sent when the communications connection is lost. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a243c1e015e1252221caaad8d59a13a24a0f482c64abdd477de9df8afc4a1078cb"></a>eBroadcastBitReadThreadGotBytes</em> </td><td>
<p>Sent by the read thread when bytes become available. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a243c1e015e1252221caaad8d59a13a24a554b212d9591c624847c15e035c1f3fc"></a>eBroadcastBitReadThreadDidExit</em> </td><td>
<p>Sent by the read thread when it exits to inform clients. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a243c1e015e1252221caaad8d59a13a24a7aaf636aab623833d3d3541dd74ca4c4"></a>eBroadcastBitReadThreadShouldExit</em> </td><td>
<p>Sent by clients that need to cancel the read thread. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a243c1e015e1252221caaad8d59a13a24aa742f87f608eae9eed2756433f6d8d7b"></a>eBroadcastBitPacketAvailable</em> </td><td>
<p>Sent when data received makes a complete packet. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a243c1e015e1252221caaad8d59a13a24a9408507cb4af14a627054e299d02962e"></a>eAllEventBits</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="SBCommunication_8h_source.html#l00021">21</a> of file <a class="el" href="SBCommunication_8h_source.html">SBCommunication.h</a>.</p>
</div>
</div>
<h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7cb85c673867e63fac1350a815b5cdb8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBCommunication::SBCommunication </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3119b917f55edbc995d69045c740dfca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBCommunication::SBCommunication </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>broadcaster_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af192a76b5cf136f36939dbac4425584b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBCommunication::~SBCommunication </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a3f7ac6e63989b1c85db0bf918b32dc3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::ConnectionStatus lldb::SBCommunication::AdoptFileDesriptor </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>owns_fd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7d9b670ea00515ae87203754238f5399"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::ConnectionStatus lldb::SBCommunication::Connect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adf990fcd6cfcc113438fef8fae674d07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::ConnectionStatus lldb::SBCommunication::Disconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="abd27f73fbc5bdfc6373c1ca67ac91e7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlldb_1_1SBBroadcaster.html">lldb::SBBroadcaster</a> lldb::SBCommunication::GetBroadcaster </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3924231f38ad0bcb25c9d9b0027a3428"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const char* lldb::SBCommunication::GetBroadcasterClass </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="acf203ffd8066819069491e12846a4113"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBCommunication::GetCloseOnEOF </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e018a3a596670e740b8226ae058808d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBCommunication::IsConnected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3159b3af4c33fa27b057aa2810aaa7a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBCommunication::IsValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af40a4ad9f2f4a8bef704fa6f20756fd8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t lldb::SBCommunication::Read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>dst_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>timeout_usec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">lldb::ConnectionStatus & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae69b67ed32dcf8e19febab317fa2a36c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBCommunication::ReadThreadIsRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a69bed79b9f866e5508e29d41d85f188b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBCommunication::ReadThreadStart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aec744b634df7cf656a675162447f6727"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBCommunication::ReadThreadStop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6bab0e67b2467789125f9f903b353d46"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lldb::SBCommunication::SetCloseOnEOF </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>b</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e0f406e60bc684dba5a520dd3e618fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBCommunication::SetReadThreadBytesReceivedCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBCommunication.html#ad07a358eba73f4710760c943f208e072">ReadThreadBytesReceived</a> </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>callback_baton</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5e95d57662c88378ad25f4d02d32b1e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t lldb::SBCommunication::Write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>src_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">lldb::ConnectionStatus & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SBCommunication_8h_source.html">SBCommunication.h</a></li>
</ul>
</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>