Device: Refactor supportsNetworkMutex

device/device.cpp

@@ -560,7 +560,7 @@ bool Device::goOnline() {
 			return false;
 	}
 
-	if(supportsNetworkMutex()) {
+	if(supportsNetworkMutex) {
 		assignedClientId = com->getClientIDSync();
 		if(assignedClientId) {
 			std::set<Network::NetID> nets;
@@ -3927,7 +3927,7 @@ std::shared_ptr<DiskDetails> Device::getDiskDetails(std::chrono::milliseconds ti
 
 [[nodiscard]] std::optional<int> Device::lockNetworks(const std::set<Network::NetID>& networks, uint32_t priority, uint32_t ttlMs, NetworkMutexType type, std::function<void(std::shared_ptr<Message>)>&& on_event)
 {
-	if(!supportsNetworkMutex()) {
+	if(!supportsNetworkMutex) {
 		report(APIEvent::Type::NotSupported, APIEvent::Severity::Error);
 		return std::nullopt;
 	}
@@ -3977,7 +3977,7 @@ std::shared_ptr<DiskDetails> Device::getDiskDetails(std::chrono::milliseconds ti
 
 bool Device::unlockNetworks(const std::set<Network::NetID>& networks)
 {
-	if(!supportsNetworkMutex()) {
+	if(!supportsNetworkMutex) {
 		report(APIEvent::Type::NotSupported, APIEvent::Severity::Error);
 		return false;
 	}
@@ -4017,7 +4017,7 @@ bool Device::unlockNetworks(const std::set<Network::NetID>& networks)
 
 std::shared_ptr<NetworkMutexMessage> Device::getNetworkMutexStatus(Network::NetID network)
 {
-	if(!supportsNetworkMutex()) {
+	if(!supportsNetworkMutex) {
 		report(APIEvent::Type::NotSupported, APIEvent::Severity::Error);
 		return nullptr;
 	}
@@ -4039,7 +4039,7 @@ std::shared_ptr<NetworkMutexMessage> Device::getNetworkMutexStatus(Network::NetI
 
 [[nodiscard]] std::optional<int> Device::lockAllNetworks(uint32_t priority, uint32_t ttlMs, NetworkMutexType type, std::function<void(std::shared_ptr<Message>)>&& on_event)
 {
-	if(!supportsNetworkMutex()) {
+	if(!supportsNetworkMutex) {
 		report(APIEvent::Type::NotSupported, APIEvent::Severity::Error);
 		return std::nullopt;
 	}
@@ -4086,7 +4086,7 @@ std::shared_ptr<NetworkMutexMessage> Device::getNetworkMutexStatus(Network::NetI
 
 bool Device::unlockAllNetworks() 
 {
-	if(!supportsNetworkMutex()) {
+	if(!supportsNetworkMutex) {
 		report(APIEvent::Type::NotSupported, APIEvent::Severity::Error);
 		return false;
 	}

docs/index.rst

@@ -14,3 +14,18 @@ communication library. The source code for libicsneo can be found on GitHub:
    icsneopy/index
    icsneoc/index
    icsneoc2/index
+
+Linux Installation
+==================
+
+Applications that use raw Ethernet device discovery, such as PCAP-backed
+discovery, need permission to open raw network sockets. Instead of running your
+application with ``sudo``, grant the installed executable the required Linux
+capabilities:
+
+.. code-block:: bash
+
+   sudo setcap cap_net_raw,cap_net_admin=eip /usr/bin/your-app
+
+Replace ``/usr/bin/your-app`` with the full path to the application executable.
+

include/icsneo/device/device.h

@@ -878,8 +878,6 @@ public:
 	bool unlockNetworks(const std::set<Network::NetID>& networks);
 	bool unlockAllNetworks();
 	std::shared_ptr<NetworkMutexMessage> getNetworkMutexStatus(Network::NetID network);
-	
-	virtual bool supportsNetworkMutex() const { return false; }
 
 protected:
 	bool online = false;
@@ -998,6 +996,8 @@ protected:
 
 	std::optional<HardwareInfo::Version> bootloaderVersion = std::nullopt;
 
+	bool supportsNetworkMutex = false;
+
 private:
 	neodevice_t data;
 	std::shared_ptr<ResetStatusMessage> latestResetStatus;

include/icsneo/device/tree/neovifire3/neovifire3.h

@@ -81,6 +81,7 @@ public:
 	}
 protected:
 	NeoVIFIRE3(neodevice_t neodevice, const driver_factory_t& makeDriver) : Device(neodevice) {
+		supportsNetworkMutex = true;
 		initialize<NeoVIFIRE3Settings, Disk::ExtExtractorDiskReadDriver, Disk::NeoMemoryDiskDriver>(makeDriver);
 	}
 
@@ -123,8 +124,6 @@ protected:
 	size_t getDiskCount() const override {
 		return 2;
 	}
-
-	bool supportsNetworkMutex() const override { return true; }
 };
 
 }

include/icsneo/device/tree/neovifire3flexray/neovifire3flexray.h

@@ -86,6 +86,7 @@ public:
 	}
 protected:
 	NeoVIFIRE3FlexRay(neodevice_t neodevice, const driver_factory_t& makeDriver) : Device(neodevice) {
+		supportsNetworkMutex = true;
 		initialize<NeoVIFIRE3FlexRaySettings, Disk::ExtExtractorDiskReadDriver, Disk::NeoMemoryDiskDriver>(makeDriver);
 	}
 
@@ -150,8 +151,6 @@ protected:
 	size_t getDiskCount() const override { 
 		return 2; 
 	}
-
-	bool supportsNetworkMutex() const override { return true; }
 };
 
 }

include/icsneo/device/tree/neovifire3t1slin/neovifire3t1slin.h

@@ -89,6 +89,7 @@ public:
 	}
 protected:
 	NeoVIFIRE3T1SLIN(neodevice_t neodevice, const driver_factory_t& makeDriver) : Device(neodevice) {
+		supportsNetworkMutex = true;
 		initialize<NeoVIFIRE3T1SLINSettings, Disk::ExtExtractorDiskReadDriver, Disk::NeoMemoryDiskDriver>(makeDriver);
 	}
 
@@ -132,10 +133,6 @@ protected:
 		return 2;
 	}
 
-	bool supportsNetworkMutex() const override { 
-		return true; 
-	}
-
 };
 
 }

include/icsneo/device/tree/neovired2/neovired2.h

@@ -64,6 +64,7 @@ public:
 	}
 protected:
 	NeoVIRED2(neodevice_t neodevice, const driver_factory_t& makeDriver) : Device(neodevice) {
+		supportsNetworkMutex = true;
 		initialize<NeoVIRED2Settings, Disk::ExtExtractorDiskReadDriver, Disk::NeoMemoryDiskDriver>(makeDriver);
 	}
 
@@ -104,8 +105,6 @@ protected:
 	size_t getDiskCount() const override {
 		return 2;
 	}
-
-	bool supportsNetworkMutex() const override { return true; }
 };
 
 }