mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 17:56:16 +00:00
603 lines
31 KiB
HTML
603 lines
31 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Dash Core: TorControlConnection Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Dash Core
|
|
 <span id="projectnumber">0.12.2.1</span>
|
|
</div>
|
|
<div id="projectbrief">P2P Digital Currency</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classTorControlConnection.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classTorControlConnection-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">TorControlConnection Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a30ec1d9f7e35720dc435e555e212ad73"><td class="memItemLeft" align="right" valign="top">typedef boost::function< void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a30ec1d9f7e35720dc435e555e212ad73">ConnectionCB</a></td></tr>
|
|
<tr class="separator:a30ec1d9f7e35720dc435e555e212ad73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67d9147b8c27456cc7fe15e4d6d8e844"><td class="memItemLeft" align="right" valign="top">typedef boost::function< void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a> &, const <a class="el" href="classTorControlReply.html">TorControlReply</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a67d9147b8c27456cc7fe15e4d6d8e844">ReplyHandlerCB</a></td></tr>
|
|
<tr class="separator:a67d9147b8c27456cc7fe15e4d6d8e844"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a5850ebb205bddf1fbc97271fae8eaf78"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a5850ebb205bddf1fbc97271fae8eaf78">TorControlConnection</a> (struct event_base *<a class="el" href="classTorControlConnection.html#af68563075f85652d32cc0b6d8417699c">base</a>)</td></tr>
|
|
<tr class="separator:a5850ebb205bddf1fbc97271fae8eaf78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a323e3a8e9649a74fbf11456fe3e160d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a323e3a8e9649a74fbf11456fe3e160d3">~TorControlConnection</a> ()</td></tr>
|
|
<tr class="separator:a323e3a8e9649a74fbf11456fe3e160d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36b6359caf9a304efe310b9b7141a939"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a36b6359caf9a304efe310b9b7141a939">Connect</a> (const std::string &target, const <a class="el" href="classTorControlConnection.html#a30ec1d9f7e35720dc435e555e212ad73">ConnectionCB</a> &<a class="el" href="classTorControlConnection.html#ad8b8800db771cb4ca39efb078509bef4">connected</a>, const <a class="el" href="classTorControlConnection.html#a30ec1d9f7e35720dc435e555e212ad73">ConnectionCB</a> &<a class="el" href="classTorControlConnection.html#afa5564a2d7f80d436b92bf6eb4b38192">disconnected</a>)</td></tr>
|
|
<tr class="separator:a36b6359caf9a304efe310b9b7141a939"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addb42114063641eab12be2fc39b859d5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#addb42114063641eab12be2fc39b859d5">Disconnect</a> ()</td></tr>
|
|
<tr class="separator:addb42114063641eab12be2fc39b859d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d0292a1389bb0f78d15fe6c06a2baeb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a5d0292a1389bb0f78d15fe6c06a2baeb">Command</a> (const std::string &cmd, const <a class="el" href="classTorControlConnection.html#a67d9147b8c27456cc7fe15e4d6d8e844">ReplyHandlerCB</a> &reply_handler)</td></tr>
|
|
<tr class="separator:a5d0292a1389bb0f78d15fe6c06a2baeb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a23c206776020bd925c2da41e840cc08a"><td class="memItemLeft" align="right" valign="top">boost::signals2::signal< void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a> &, const <a class="el" href="classTorControlReply.html">TorControlReply</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a23c206776020bd925c2da41e840cc08a">async_handler</a></td></tr>
|
|
<tr class="separator:a23c206776020bd925c2da41e840cc08a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7d7e2393f19cb41c32223def3df769ea"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a7d7e2393f19cb41c32223def3df769ea">readcb</a> (struct bufferevent *bev, void *<a class="el" href="tests_8c.html#a06a3e29ada83211a695a49e8f7405842">ctx</a>)</td></tr>
|
|
<tr class="separator:a7d7e2393f19cb41c32223def3df769ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b22b26822247f8be7d739e14a045e98"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a8b22b26822247f8be7d739e14a045e98">eventcb</a> (struct bufferevent *bev, short what, void *<a class="el" href="tests_8c.html#a06a3e29ada83211a695a49e8f7405842">ctx</a>)</td></tr>
|
|
<tr class="separator:a8b22b26822247f8be7d739e14a045e98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:ad8b8800db771cb4ca39efb078509bef4"><td class="memItemLeft" align="right" valign="top">boost::function< void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#ad8b8800db771cb4ca39efb078509bef4">connected</a></td></tr>
|
|
<tr class="separator:ad8b8800db771cb4ca39efb078509bef4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa5564a2d7f80d436b92bf6eb4b38192"><td class="memItemLeft" align="right" valign="top">boost::function< void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a> &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#afa5564a2d7f80d436b92bf6eb4b38192">disconnected</a></td></tr>
|
|
<tr class="separator:afa5564a2d7f80d436b92bf6eb4b38192"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af68563075f85652d32cc0b6d8417699c"><td class="memItemLeft" align="right" valign="top">struct event_base * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#af68563075f85652d32cc0b6d8417699c">base</a></td></tr>
|
|
<tr class="separator:af68563075f85652d32cc0b6d8417699c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af110fd86126657931c7c1e44067154da"><td class="memItemLeft" align="right" valign="top">struct bufferevent * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#af110fd86126657931c7c1e44067154da">b_conn</a></td></tr>
|
|
<tr class="separator:af110fd86126657931c7c1e44067154da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c9dff9582b57ce132a1629a85e52061"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTorControlReply.html">TorControlReply</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a0c9dff9582b57ce132a1629a85e52061">message</a></td></tr>
|
|
<tr class="separator:a0c9dff9582b57ce132a1629a85e52061"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1675ac8361ca030eecd48f32120bddd7"><td class="memItemLeft" align="right" valign="top">std::deque< <a class="el" href="classTorControlConnection.html#a67d9147b8c27456cc7fe15e4d6d8e844">ReplyHandlerCB</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classTorControlConnection.html#a1675ac8361ca030eecd48f32120bddd7">reply_handlers</a></td></tr>
|
|
<tr class="separator:a1675ac8361ca030eecd48f32120bddd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Low-level handling for Tor control connection. Speaks the SMTP-like protocol as defined in torspec/control-spec.txt </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00069">69</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a30ec1d9f7e35720dc435e555e212ad73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30ec1d9f7e35720dc435e555e212ad73">◆ </a></span>ConnectionCB</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef boost::function<void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a>&)> <a class="el" href="classTorControlConnection.html#a30ec1d9f7e35720dc435e555e212ad73">TorControlConnection::ConnectionCB</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00072">72</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67d9147b8c27456cc7fe15e4d6d8e844"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67d9147b8c27456cc7fe15e4d6d8e844">◆ </a></span>ReplyHandlerCB</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef boost::function<void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a> &,const <a class="el" href="classTorControlReply.html">TorControlReply</a> &)> <a class="el" href="classTorControlConnection.html#a67d9147b8c27456cc7fe15e4d6d8e844">TorControlConnection::ReplyHandlerCB</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00073">73</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a5850ebb205bddf1fbc97271fae8eaf78"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5850ebb205bddf1fbc97271fae8eaf78">◆ </a></span>TorControlConnection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TorControlConnection::TorControlConnection </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct event_base * </td>
|
|
<td class="paramname"><em>base</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Create a new <a class="el" href="classTorControlConnection.html">TorControlConnection</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00121">121</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a323e3a8e9649a74fbf11456fe3e160d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a323e3a8e9649a74fbf11456fe3e160d3">◆ </a></span>~TorControlConnection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TorControlConnection::~TorControlConnection </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00126">126</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a5d0292a1389bb0f78d15fe6c06a2baeb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d0292a1389bb0f78d15fe6c06a2baeb">◆ </a></span>Command()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool TorControlConnection::Command </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>cmd</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classTorControlConnection.html#a67d9147b8c27456cc7fe15e4d6d8e844">ReplyHandlerCB</a> & </td>
|
|
<td class="paramname"><em>reply_handler</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Send a command, register a handler for the reply. A trailing CRLF is automatically added. Return true on success. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00231">231</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00453">TorController::auth_cb()</a>, <a class="el" href="torcontrol_8cpp_source.html#l00507">TorController::authchallenge_cb()</a>, <a class="el" href="torcontrol_8cpp_source.html#l00610">TorController::connected_cb()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00538">TorController::protocolinfo_cb()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a36b6359caf9a304efe310b9b7141a939"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36b6359caf9a304efe310b9b7141a939">◆ </a></span>Connect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool TorControlConnection::Connect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classTorControlConnection.html#a30ec1d9f7e35720dc435e555e212ad73">ConnectionCB</a> & </td>
|
|
<td class="paramname"><em>connected</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classTorControlConnection.html#a30ec1d9f7e35720dc435e555e212ad73">ConnectionCB</a> & </td>
|
|
<td class="paramname"><em>disconnected</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Connect to a Tor control port. target is address of the form host:port. connected is the handler that is called when connection is succesfully established. disconnected is a handler that is called when the connection is broken. Return true on success. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00193">193</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00636">TorController::Reconnect()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00393">TorController::TorController()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="addb42114063641eab12be2fc39b859d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#addb42114063641eab12be2fc39b859d5">◆ </a></span>Disconnect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool TorControlConnection::Disconnect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Disconnect from Tor control port. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00223">223</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00193">Connect()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8b22b26822247f8be7d739e14a045e98"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8b22b26822247f8be7d739e14a045e98">◆ </a></span>eventcb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TorControlConnection::eventcb </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct bufferevent * </td>
|
|
<td class="paramname"><em>bev</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">short </td>
|
|
<td class="paramname"><em>what</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>ctx</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00177">177</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00193">Connect()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d7e2393f19cb41c32223def3df769ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d7e2393f19cb41c32223def3df769ea">◆ </a></span>readcb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TorControlConnection::readcb </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct bufferevent * </td>
|
|
<td class="paramname"><em>bev</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>ctx</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Libevent handlers: internal </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00132">132</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00193">Connect()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a23c206776020bd925c2da41e840cc08a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23c206776020bd925c2da41e840cc08a">◆ </a></span>async_handler</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::signals2::signal<void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a> &,const <a class="el" href="classTorControlReply.html">TorControlReply</a> &)> TorControlConnection::async_handler</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Response handlers for async replies </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00101">101</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af110fd86126657931c7c1e44067154da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af110fd86126657931c7c1e44067154da">◆ </a></span>b_conn</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct bufferevent* TorControlConnection::b_conn</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Connection to control socket </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00110">110</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00231">Command()</a>, <a class="el" href="torcontrol_8cpp_source.html#l00193">Connect()</a>, <a class="el" href="torcontrol_8cpp_source.html#l00223">Disconnect()</a>, and <a class="el" href="torcontrol_8cpp_source.html#l00126">~TorControlConnection()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af68563075f85652d32cc0b6d8417699c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af68563075f85652d32cc0b6d8417699c">◆ </a></span>base</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct event_base* TorControlConnection::base</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Libevent event base </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00108">108</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00193">Connect()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad8b8800db771cb4ca39efb078509bef4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad8b8800db771cb4ca39efb078509bef4">◆ </a></span>connected</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::function<void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a>&)> TorControlConnection::connected</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Callback when ready for use </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00104">104</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00193">Connect()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa5564a2d7f80d436b92bf6eb4b38192"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa5564a2d7f80d436b92bf6eb4b38192">◆ </a></span>disconnected</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::function<void(<a class="el" href="classTorControlConnection.html">TorControlConnection</a>&)> TorControlConnection::disconnected</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Callback when connection lost </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00106">106</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00193">Connect()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c9dff9582b57ce132a1629a85e52061"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c9dff9582b57ce132a1629a85e52061">◆ </a></span>message</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classTorControlReply.html">TorControlReply</a> TorControlConnection::message</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Message being received </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00112">112</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1675ac8361ca030eecd48f32120bddd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1675ac8361ca030eecd48f32120bddd7">◆ </a></span>reply_handlers</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::deque<<a class="el" href="classTorControlConnection.html#a67d9147b8c27456cc7fe15e4d6d8e844">ReplyHandlerCB</a>> TorControlConnection::reply_handlers</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Response handlers </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="torcontrol_8cpp_source.html#l00114">114</a> of file <a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="torcontrol_8cpp_source.html#l00231">Command()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/<a class="el" href="torcontrol_8cpp_source.html">torcontrol.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="classTorControlConnection.html">TorControlConnection</a></li>
|
|
<li class="footer">Generated on Thu Dec 14 2017 13:15:13 for Dash Core by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|