Event: Store device as weak pointer

pull/86/merge
Kyle Schwarz 2026-06-02 15:19:43 -04:00
parent 476b5ff35c
commit bb711ae7e2
4 changed files with 25 additions and 16 deletions

View File

@ -4,10 +4,10 @@
using namespace icsneo; using namespace icsneo;
APIEvent::APIEvent(Type type, APIEvent::Severity severity, const Device* device) : eventStruct({}) { APIEvent::APIEvent(Type type, APIEvent::Severity severity, std::weak_ptr<Device> device) : eventStruct({}), device(device) {
this->device = device; auto shared = device.lock();
if(device) { if(shared) {
serial = device->getSerial(); serial = shared->getSerial();
eventStruct.serial[serial.copy(eventStruct.serial, sizeof(eventStruct.serial))] = '\0'; eventStruct.serial[serial.copy(eventStruct.serial, sizeof(eventStruct.serial))] = '\0';
} }
@ -27,9 +27,10 @@ void APIEvent::downgradeFromError() noexcept {
} }
bool APIEvent::isForDevice(std::string filterSerial) const noexcept { bool APIEvent::isForDevice(std::string filterSerial) const noexcept {
if(!device || filterSerial.length() == 0) auto shared = device.lock();
if(!shared || filterSerial.length() == 0)
return false; return false;
return device->getSerial() == filterSerial; return shared->getSerial() == filterSerial;
} }
// API Errors // API Errors
@ -467,8 +468,9 @@ const char* APIEvent::DescriptionForType(Type type) {
std::string APIEvent::describe() const noexcept { std::string APIEvent::describe() const noexcept {
std::stringstream ss; std::stringstream ss;
if(device) auto shared = device.lock();
ss << *device; // Makes use of device.describe() if(shared)
ss << *shared; // Makes use of device.describe()
else else
ss << "API"; ss << "API";

View File

@ -19,6 +19,7 @@ typedef struct {
#include <chrono> #include <chrono>
#include <string> #include <string>
#include <ostream> #include <ostream>
#include <memory>
namespace icsneo { namespace icsneo {
@ -185,19 +186,25 @@ public:
Error = 0x30 Error = 0x30
}; };
APIEvent() : eventStruct({}), serial(), timepoint(), device(nullptr) {} APIEvent() : eventStruct({}), serial(), timepoint() {}
APIEvent(APIEvent::Type event, APIEvent::Severity severity, const Device* device = nullptr); APIEvent(APIEvent::Type event, APIEvent::Severity severity, std::weak_ptr<Device> device = {});
const neoevent_t* getNeoEvent() const noexcept { return &eventStruct; } const neoevent_t* getNeoEvent() const noexcept { return &eventStruct; }
Type getType() const noexcept { return Type(eventStruct.eventNumber); } Type getType() const noexcept { return Type(eventStruct.eventNumber); }
Severity getSeverity() const noexcept { return Severity(eventStruct.severity); } Severity getSeverity() const noexcept { return Severity(eventStruct.severity); }
std::string getDescription() const noexcept { return std::string(eventStruct.description); } std::string getDescription() const noexcept { return std::string(eventStruct.description); }
const Device* getDevice() const noexcept { return device; } // Will return nullptr if this is an API-wide event const Device* getDevice() const noexcept { // Will return nullptr if this is an API-wide event
auto shared = device.lock();
return (shared) ? shared.get() : nullptr;
}
EventTimePoint getTimestamp() const noexcept { return timepoint; } EventTimePoint getTimestamp() const noexcept { return timepoint; }
void downgradeFromError() noexcept; void downgradeFromError() noexcept;
bool isForDevice(const Device* forDevice) const noexcept { return forDevice == device; } bool isForDevice(const Device* forDevice) const noexcept {
auto shared = device.lock();
return shared && (shared.get() == forDevice);
}
bool isForDevice(std::string serial) const noexcept; bool isForDevice(std::string serial) const noexcept;
// As opposed to getDescription, this will also add text such as "neoVI FIRE 2 CY2468 Error: " to fully describe the problem // As opposed to getDescription, this will also add text such as "neoVI FIRE 2 CY2468 Error: " to fully describe the problem
@ -213,7 +220,7 @@ private:
neoevent_t eventStruct; neoevent_t eventStruct;
std::string serial; std::string serial;
EventTimePoint timepoint; EventTimePoint timepoint;
const Device* device; std::weak_ptr<Device> device;
void init(APIEvent::Type event, APIEvent::Severity); void init(APIEvent::Type event, APIEvent::Severity);
}; };

View File

@ -56,7 +56,7 @@ public:
APIEvent getLastError(); APIEvent getLastError();
void add(APIEvent event); void add(APIEvent event);
void add(APIEvent::Type type, APIEvent::Severity severity, const Device* forDevice = nullptr) { void add(APIEvent::Type type, APIEvent::Severity severity, std::weak_ptr<Device> forDevice = {}) {
add(APIEvent(type, severity, forDevice)); add(APIEvent(type, severity, forDevice));
} }

View File

@ -87,7 +87,7 @@ class DeviceExtension;
typedef uint64_t MemoryAddress; typedef uint64_t MemoryAddress;
class Device { class Device : public std::enable_shared_from_this<Device> {
public: public:
virtual ~Device(); virtual ~Device();
@ -930,7 +930,7 @@ protected:
virtual device_eventhandler_t makeEventHandler() { virtual device_eventhandler_t makeEventHandler() {
return [this](APIEvent::Type type, APIEvent::Severity severity) { return [this](APIEvent::Type type, APIEvent::Severity severity) {
EventManager::GetInstance().add(type, severity, this); EventManager::GetInstance().add(type, severity, weak_from_this());
}; };
} }