Skip to content

Commit e3f0785

Browse files
committed
refactor: Rename TorController::target to m_tor_control_center
`target` is a proper name for the onion service target address and port. This change is required for the following commit.
1 parent fdd3ae4 commit e3f0785

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

src/torcontrol.cpp

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@ class TorControlConnection
8181

8282
/**
8383
* Connect to a Tor control port.
84-
* target is address of the form host:port.
84+
* tor_control_center is address of the form host:port.
8585
* connected is the handler that is called when connection is successfully established.
8686
* disconnected is a handler that is called when the connection is broken.
8787
* Return true on success.
8888
*/
89-
bool Connect(const std::string &target, const ConnectionCB& connected, const ConnectionCB& disconnected);
89+
bool Connect(const std::string& tor_control_center, const ConnectionCB& connected, const ConnectionCB& disconnected);
9090

9191
/**
9292
* Disconnect from Tor control port.
@@ -193,16 +193,16 @@ void TorControlConnection::eventcb(struct bufferevent *bev, short what, void *ct
193193
}
194194
}
195195

196-
bool TorControlConnection::Connect(const std::string &target, const ConnectionCB& _connected, const ConnectionCB& _disconnected)
196+
bool TorControlConnection::Connect(const std::string& tor_control_center, const ConnectionCB& _connected, const ConnectionCB& _disconnected)
197197
{
198198
if (b_conn)
199199
Disconnect();
200-
// Parse target address:port
200+
// Parse tor_control_center address:port
201201
struct sockaddr_storage connect_to_addr;
202202
int connect_to_addrlen = sizeof(connect_to_addr);
203-
if (evutil_parse_sockaddr_port(target.c_str(),
203+
if (evutil_parse_sockaddr_port(tor_control_center.c_str(),
204204
(struct sockaddr*)&connect_to_addr, &connect_to_addrlen)<0) {
205-
LogPrintf("tor: Error parsing socket address %s\n", target);
205+
LogPrintf("tor: Error parsing socket address %s\n", tor_control_center);
206206
return false;
207207
}
208208

@@ -215,9 +215,9 @@ bool TorControlConnection::Connect(const std::string &target, const ConnectionCB
215215
this->connected = _connected;
216216
this->disconnected = _disconnected;
217217

218-
// Finally, connect to target
218+
// Finally, connect to tor_control_center
219219
if (bufferevent_socket_connect(b_conn, (struct sockaddr*)&connect_to_addr, connect_to_addrlen) < 0) {
220-
LogPrintf("tor: Error connecting to address %s\n", target);
220+
LogPrintf("tor: Error connecting to address %s\n", tor_control_center);
221221
return false;
222222
}
223223
return true;
@@ -410,7 +410,7 @@ static bool WriteBinaryFile(const fs::path &filename, const std::string &data)
410410
class TorController
411411
{
412412
public:
413-
TorController(struct event_base* base, const std::string& target);
413+
TorController(struct event_base* base, const std::string& tor_control_center);
414414
~TorController();
415415

416416
/** Get name of file to store private key in */
@@ -420,7 +420,7 @@ class TorController
420420
void Reconnect();
421421
private:
422422
struct event_base* base;
423-
std::string target;
423+
const std::string m_tor_control_center;
424424
TorControlConnection conn;
425425
std::string private_key;
426426
std::string service_id;
@@ -450,18 +450,18 @@ class TorController
450450
static void reconnect_cb(evutil_socket_t fd, short what, void *arg);
451451
};
452452

453-
TorController::TorController(struct event_base* _base, const std::string& _target):
453+
TorController::TorController(struct event_base* _base, const std::string& tor_control_center):
454454
base(_base),
455-
target(_target), conn(base), reconnect(true), reconnect_ev(0),
455+
m_tor_control_center(tor_control_center), conn(base), reconnect(true), reconnect_ev(0),
456456
reconnect_timeout(RECONNECT_TIMEOUT_START)
457457
{
458458
reconnect_ev = event_new(base, -1, 0, reconnect_cb, this);
459459
if (!reconnect_ev)
460460
LogPrintf("tor: Failed to create event for reconnection: out of memory?\n");
461461
// Start connection attempts immediately
462-
if (!conn.Connect(_target, std::bind(&TorController::connected_cb, this, std::placeholders::_1),
462+
if (!conn.Connect(m_tor_control_center, std::bind(&TorController::connected_cb, this, std::placeholders::_1),
463463
std::bind(&TorController::disconnected_cb, this, std::placeholders::_1) )) {
464-
LogPrintf("tor: Initiating connection to Tor control port %s failed\n", _target);
464+
LogPrintf("tor: Initiating connection to Tor control port %s failed\n", m_tor_control_center);
465465
}
466466
// Read service private key if cached
467467
std::pair<bool,std::string> pkf = ReadBinaryFile(GetPrivateKeyFile());
@@ -696,7 +696,7 @@ void TorController::disconnected_cb(TorControlConnection& _conn)
696696
if (!reconnect)
697697
return;
698698

699-
LogPrint(BCLog::TOR, "tor: Not connected to Tor control port %s, trying to reconnect\n", target);
699+
LogPrint(BCLog::TOR, "tor: Not connected to Tor control port %s, trying to reconnect\n", m_tor_control_center);
700700

701701
// Single-shot timer for reconnect. Use exponential backoff.
702702
struct timeval time = MillisToTimeval(int64_t(reconnect_timeout * 1000.0));
@@ -710,9 +710,9 @@ void TorController::Reconnect()
710710
/* Try to reconnect and reestablish if we get booted - for example, Tor
711711
* may be restarting.
712712
*/
713-
if (!conn.Connect(target, std::bind(&TorController::connected_cb, this, std::placeholders::_1),
713+
if (!conn.Connect(m_tor_control_center, std::bind(&TorController::connected_cb, this, std::placeholders::_1),
714714
std::bind(&TorController::disconnected_cb, this, std::placeholders::_1) )) {
715-
LogPrintf("tor: Re-initiating connection to Tor control port %s failed\n", target);
715+
LogPrintf("tor: Re-initiating connection to Tor control port %s failed\n", m_tor_control_center);
716716
}
717717
}
718718

0 commit comments

Comments
 (0)