Skip to content
Snippets Groups Projects
Commit f9855f5e authored by ovari's avatar ovari
Browse files

connectionmanager.cpp: cleanup 

{} … connections → {} … connection(s)
co → COTURN
dht → DHT
ice → ICE
id → ID
ipv6 → IPv6
needs → requires
not concluant → inconclusive
ok → OK
prefere → prefer
try → attempt
turn → TURN

Change-Id: I5edc5e507440183273e2aed28d3bfc2f872cd1c1
parent 6c5ee3a2
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
src/connectionmanager.cpp
+ 33
− 32
View file @ f9855f5e
/* /*
* Copyright (C) 2004-2023 Savoir-faire Linux Inc. * Copyright (C) 2004-2025 Savoir-faire Linux Inc.
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
...@@ -150,8 +150,10 @@ struct PendingCb { ...@@ -150,8 +150,10 @@ struct PendingCb {
std::string connType; std::string connType;
ConnectCallback cb; ConnectCallback cb;
bool requested {false}; bool requested {false};
/** Carry user preference and prevents retry mechanism to /*
* open a new connection if the channel request failed */ * Carry user preference and prevents retry mechanism to
* open a new connection if the channel request failed
*/
bool noNewSocket {false}; bool noNewSocket {false};
}; };
...@@ -227,7 +229,7 @@ struct DeviceInfo { ...@@ -227,7 +229,7 @@ struct DeviceInfo {
} else if (auto n = connecting.extract(vid)) { } else if (auto n = connecting.extract(vid)) {
ret.emplace_back(std::move(n.mapped())); ret.emplace_back(std::move(n.mapped()));
// If sock is nullptr, execute if it's the last connecting operation // If sock is nullptr, execute if it's the last connecting operation
// If accepted is false, it means that underlying socket is ok, but channel is declined // If accepted is false, it means that underlying socket is OK, but channel is declined
if (!sock && connecting.empty() && accepted) { if (!sock && connecting.empty() && accepted) {
for (auto& [vid, cb] : waiting) for (auto& [vid, cb] : waiting)
ret.emplace_back(std::move(cb)); ret.emplace_back(std::move(cb));
...@@ -240,7 +242,7 @@ struct DeviceInfo { ...@@ -240,7 +242,7 @@ struct DeviceInfo {
return ret; return ret;
} }
/** /*
* A socket failed. Return failure callbacks and reset operations that can be retried. * A socket failed. Return failure callbacks and reset operations that can be retried.
* Sets noNewSocket to true for retryable operations, because we should never open more than one socket * Sets noNewSocket to true for retryable operations, because we should never open more than one socket
* for a specific channel. * for a specific channel.
...@@ -519,11 +521,11 @@ public: ...@@ -519,11 +521,11 @@ public:
const std::shared_ptr<dht::crypto::Certificate>& cert, const std::shared_ptr<dht::crypto::Certificate>& cert,
const std::string& connType); const std::string& connType);
/** /*
* Send a ChannelRequest on the TLS socket. Triggers cb when ready * Send a ChannelRequest on the TLS socket. Triggers cb when ready
* @param sock socket used to send the request * @param sock socket used to send the request
* @param name channel's name * @param name channel's name
* @param vid channel's id * @param vid channel's ID
* @param deviceId to identify the linked ConnectCallback * @param deviceId to identify the linked ConnectCallback
*/ */
void sendChannelRequest(const std::weak_ptr<DeviceInfo>& dinfo, void sendChannelRequest(const std::weak_ptr<DeviceInfo>& dinfo,
...@@ -531,7 +533,7 @@ public: ...@@ -531,7 +533,7 @@ public:
const std::shared_ptr<MultiplexedSocket>& sock, const std::shared_ptr<MultiplexedSocket>& sock,
const std::string& name, const std::string& name,
const dht::Value::Id& vid); const dht::Value::Id& vid);
/** /*
* Triggered when a PeerConnectionRequest comes from the DHT * Triggered when a PeerConnectionRequest comes from the DHT
*/ */
void answerTo(IceTransport& ice, void answerTo(IceTransport& ice,
...@@ -541,7 +543,7 @@ public: ...@@ -541,7 +543,7 @@ public:
bool onRequestOnNegoDone(const std::weak_ptr<DeviceInfo>& dinfo, const std::shared_ptr<ConnectionInfo>& info, const PeerConnectionRequest& req); bool onRequestOnNegoDone(const std::weak_ptr<DeviceInfo>& dinfo, const std::shared_ptr<ConnectionInfo>& info, const PeerConnectionRequest& req);
void onDhtPeerRequest(const PeerConnectionRequest& req, void onDhtPeerRequest(const PeerConnectionRequest& req,
const std::shared_ptr<dht::crypto::Certificate>& cert); const std::shared_ptr<dht::crypto::Certificate>& cert);
/** /*
* Triggered when a new TLS socket is ready to use * Triggered when a new TLS socket is ready to use
* @param ok If succeed * @param ok If succeed
* @param deviceId Related device * @param deviceId Related device
...@@ -559,8 +561,8 @@ public: ...@@ -559,8 +561,8 @@ public:
void onPeerResponse(PeerConnectionRequest&& req); void onPeerResponse(PeerConnectionRequest&& req);
void onDhtConnected(const dht::crypto::PublicKey& devicePk); void onDhtConnected(const dht::crypto::PublicKey& devicePk);
/** /*
* Try reconnecting when a connection fails before a channel request is answered. * Attempt reconnecting when a connection fails before a channel request is answered.
* This ensures that every call to connectDevice() leads to a channel request when possible, * This ensures that every call to connectDevice() leads to a channel request when possible,
* even if the connection fails after sending the first request. * even if the connection fails after sending the first request.
* In conjunction with beacon messages, this allows to reconnect to a device * In conjunction with beacon messages, this allows to reconnect to a device
...@@ -575,52 +577,51 @@ public: ...@@ -575,52 +577,51 @@ public:
fileutils::IdList treatedMessages_; fileutils::IdList treatedMessages_;
/// \return true if the given DHT message identifier has been treated /// \return true if the given DHT message identifier has been treated
/// \note if message has not been treated yet this method st/ore this id and returns true at /// \note if message has not been treated yet this method stores this identifier and returns
/// further calls /// true at further calls
bool isMessageTreated(dht::Value::Id id); bool isMessageTreated(dht::Value::Id id);
const std::shared_ptr<dht::log::Logger>& logger() const { return config_->logger; } const std::shared_ptr<dht::log::Logger>& logger() const { return config_->logger; }
/** /*
* Published IPv4/IPv6 addresses, used only if defined by the user in account * Published IPv4/IPv6 addresses, used only if defined by the user in account
* configuration * configuration
*
*/ */
IpAddr publishedIp_[2] {}; IpAddr publishedIp_[2] {};
/** /*
* interface name on which this account is bound * Interface name on which this account is bound
*/ */
std::string interface_ {"default"}; std::string interface_ {"default"};
/** /*
* Get the local interface name on which this account is bound. * Get the local interface name on which this account is bound.
*/ */
const std::string& getLocalInterface() const { return interface_; } const std::string& getLocalInterface() const { return interface_; }
/** /*
* Get the published IP address, fallbacks to NAT if family is unspecified * Get the published IP address, fallbacks to NAT if family is unspecified
* Prefers the usage of IPv4 if possible. * Prefers the usage of IPv4 if possible.
*/ */
IpAddr getPublishedIpAddress(uint16_t family = PF_UNSPEC) const; IpAddr getPublishedIpAddress(uint16_t family = PF_UNSPEC) const;
/** /*
* Set published IP address according to given family * Set published IP address according to given family
*/ */
void setPublishedAddress(const IpAddr& ip_addr); void setPublishedAddress(const IpAddr& ip_addr);
/** /*
* Store the local/public addresses used to register * Store the local/public addresses used to register
*/ */
void storeActiveIpAddress(std::function<void()>&& cb = {}); void storeActiveIpAddress(std::function<void()>&& cb = {});
/** /*
* Create and return ICE options. * Create and return ICE options.
*/ */
void getIceOptions(std::function<void(IceTransportOptions&&)> cb) noexcept; void getIceOptions(std::function<void(IceTransportOptions&&)> cb) noexcept;
IceTransportOptions getIceOptions() const noexcept; IceTransportOptions getIceOptions() const noexcept;
/** /*
* Inform that a potential peer device have been found. * Inform that a potential peer device have been found.
* Returns true only if the device certificate is a valid device certificate. * Returns true only if the device certificate is a valid device certificate.
* In that case (true is returned) the account_id parameter is set to the peer account ID. * In that case (true is returned) the account_id parameter is set to the peer account ID.
...@@ -685,7 +686,7 @@ ConnectionManager::Impl::connectDeviceStartIce( ...@@ -685,7 +686,7 @@ ConnectionManager::Impl::connectDeviceStartIce(
// Prepare connection request as a DHT message // Prepare connection request as a DHT message
PeerConnectionRequest val; PeerConnectionRequest val;
val.id = vid; /* Random id for the message unicity */ val.id = vid; /* Random identifier for the message unicity */
val.ice_msg = icemsg.str(); val.ice_msg = icemsg.str();
val.connType = connType; val.connType = connType;
...@@ -913,7 +914,7 @@ ConnectionManager::Impl::connectDevice(const std::shared_ptr<dht::crypto::Certif ...@@ -913,7 +914,7 @@ ConnectionManager::Impl::connectDevice(const std::shared_ptr<dht::crypto::Certif
bool forceNewSocket, bool forceNewSocket,
const std::string& connType) const std::string& connType)
{ {
// Avoid dht operation in a DHT callback to avoid deadlocks // Avoid DHT operation in a DHT callback to avoid deadlocks
dht::ThreadPool::computation().run([w = weak_from_this(), dht::ThreadPool::computation().run([w = weak_from_this(),
name = std::move(name), name = std::move(name),
cert = std::move(cert), cert = std::move(cert),
...@@ -1088,7 +1089,7 @@ ConnectionManager::Impl::startConnection(const std::shared_ptr<DeviceInfo>& di, ...@@ -1088,7 +1089,7 @@ ConnectionManager::Impl::startConnection(const std::shared_ptr<DeviceInfo>& di,
eraseInfo(); eraseInfo();
return; return;
} }
// We need to detect any shutdown if the ice session is destroyed before going to the // We need to detect any shutdown if the ICE session is destroyed before going to the
// TLS session; // TLS session;
info->ice_->setOnShutdown([eraseInfo]() { info->ice_->setOnShutdown([eraseInfo]() {
dht::ThreadPool::io().run([eraseInfo = std::move(eraseInfo)] { eraseInfo(); }); dht::ThreadPool::io().run([eraseInfo = std::move(eraseInfo)] { eraseInfo(); });
...@@ -1291,7 +1292,7 @@ ConnectionManager::Impl::onTlsNegotiationDone(const std::shared_ptr<DeviceInfo>& ...@@ -1291,7 +1292,7 @@ ConnectionManager::Impl::onTlsNegotiationDone(const std::shared_ptr<DeviceInfo>&
lk2.unlock(); lk2.unlock();
// send beacon to existing connections for this device // send beacon to existing connections for this device
if (config_->logger and not previousConnections.empty()) if (config_->logger and not previousConnections.empty())
config_->logger->warn("[device {}] Sending beacon to {} existing connections", config_->logger->warn("[device {}] Sending beacon to {} existing connection(s)",
deviceId, deviceId,
previousConnections.size()); previousConnections.size());
for (const auto& cinfo: previousConnections) { for (const auto& cinfo: previousConnections) {
...@@ -1461,7 +1462,7 @@ ConnectionManager::Impl::onDhtPeerRequest(const PeerConnectionRequest& req, ...@@ -1461,7 +1462,7 @@ ConnectionManager::Impl::onDhtPeerRequest(const PeerConnectionRequest& req,
auto wdi = std::weak_ptr(di); auto wdi = std::weak_ptr(di);
auto winfo = std::weak_ptr(info); auto winfo = std::weak_ptr(info);
// Note: used when the ice negotiation fails to erase // Note: used when the ICE negotiation fails to erase
// all stored structures. // all stored structures.
auto eraseInfo = [w, wdi, id = req.id] { auto eraseInfo = [w, wdi, id = req.id] {
auto shared = w.lock(); auto shared = w.lock();
...@@ -1544,7 +1545,7 @@ ConnectionManager::Impl::onDhtPeerRequest(const PeerConnectionRequest& req, ...@@ -1544,7 +1545,7 @@ ConnectionManager::Impl::onDhtPeerRequest(const PeerConnectionRequest& req,
eraseInfo(); eraseInfo();
return; return;
} }
// We need to detect any shutdown if the ice session is destroyed before going to the TLS session; // We need to detect any shutdown if the ICE session is destroyed before going to the TLS session;
info->ice_->setOnShutdown([eraseInfo]() { info->ice_->setOnShutdown([eraseInfo]() {
dht::ThreadPool::io().run([eraseInfo = std::move(eraseInfo)] { eraseInfo(); }); dht::ThreadPool::io().run([eraseInfo = std::move(eraseInfo)] { eraseInfo(); });
}); });
...@@ -1662,7 +1663,7 @@ ConnectionManager::Impl::getPublishedIpAddress(uint16_t family) const ...@@ -1662,7 +1663,7 @@ ConnectionManager::Impl::getPublishedIpAddress(uint16_t family) const
assert(family == AF_UNSPEC); assert(family == AF_UNSPEC);
// If family is not set, prefere IPv4 if available. It's more // If family is not set, prefer IPv4 if available. It's more
// likely to succeed behind NAT. // likely to succeed behind NAT.
if (publishedIp_[0]) if (publishedIp_[0])
return publishedIp_[0]; return publishedIp_[0];
...@@ -1767,8 +1768,8 @@ ConnectionManager::Impl::getIceOptions() const noexcept ...@@ -1767,8 +1768,8 @@ ConnectionManager::Impl::getIceOptions() const noexcept
.setPassword(config_->turnServerPwd) .setPassword(config_->turnServerPwd)
.setRealm(config_->turnServerRealm)); .setRealm(config_->turnServerRealm));
} }
// NOTE: first test with ipv6 turn was not concluant and resulted in multiple // NOTE: The first test with IPv6 TURN was inconclusive and resulted in multiple
// co issues. So this needs some debug. for now just disable // COTURN issues. So this requires debugging. For now, just disable it.
// if (cacheTurnV6 && *cacheTurnV6) { // if (cacheTurnV6 && *cacheTurnV6) {
// opts.turnServers.emplace_back(TurnServerInfo() // opts.turnServers.emplace_back(TurnServerInfo()
// .setUri(cacheTurnV6->toString(true)) // .setUri(cacheTurnV6->toString(true))
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment