From 72773d9afaa25a83e135c344cb79b98fde40477f Mon Sep 17 00:00:00 2001 From: Paul Hollinsky Date: Tue, 25 Sep 2018 17:53:02 -0400 Subject: [PATCH] Refactor MessageFilter and MessageCallback --- communication/communication.cpp | 2 + communication/include/communication.h | 2 + .../callback/include/canmessagecallback.h | 21 ++++ .../callback/include/main51messagecallback.h | 21 ++++ .../callback}/include/messagecallback.h | 80 ++++++------ .../message/filter/include/canmessagefilter.h | 38 ++++++ .../filter/include/main51messagefilter.h | 46 +++++++ .../filter}/include/messagefilter.h | 117 +++++++----------- communication/message/include/main51message.h | 17 +++ communication/message/include/message.h | 2 +- .../message/include/serialnumbermessage.h | 24 ++++ device/device.cpp | 1 + 12 files changed, 254 insertions(+), 117 deletions(-) create mode 100644 communication/message/callback/include/canmessagecallback.h create mode 100644 communication/message/callback/include/main51messagecallback.h rename communication/{ => message/callback}/include/messagecallback.h (64%) create mode 100644 communication/message/filter/include/canmessagefilter.h create mode 100644 communication/message/filter/include/main51messagefilter.h rename communication/{ => message/filter}/include/messagefilter.h (57%) create mode 100644 communication/message/include/main51message.h create mode 100644 communication/message/include/serialnumbermessage.h diff --git a/communication/communication.cpp b/communication/communication.cpp index 3acfbd6..716076d 100644 --- a/communication/communication.cpp +++ b/communication/communication.cpp @@ -9,6 +9,8 @@ #include "communication/include/command.h" #include "communication/include/messagedecoder.h" #include "communication/include/packetizer.h" +#include "communication/message/include/serialnumbermessage.h" +#include "communication/message/filter/include/main51messagefilter.h" using namespace icsneo; diff --git a/communication/include/communication.h b/communication/include/communication.h index 53c69f2..977a7e8 100644 --- a/communication/include/communication.h +++ b/communication/include/communication.h @@ -5,6 +5,8 @@ #include "communication/include/command.h" #include "communication/include/network.h" #include "communication/include/packet.h" +#include "communication/message/callback/include/messagecallback.h" +#include "communication/message/include/serialnumbermessage.h" #include "communication/include/packetizer.h" #include "communication/include/messagedecoder.h" #include diff --git a/communication/message/callback/include/canmessagecallback.h b/communication/message/callback/include/canmessagecallback.h new file mode 100644 index 0000000..07f325b --- /dev/null +++ b/communication/message/callback/include/canmessagecallback.h @@ -0,0 +1,21 @@ +#ifndef __CANMESSAGECALLBACK_H_ +#define __CANMESSAGECALLBACK_H_ + +#include "communication/message/callback/include/messagecallback.h" +#include "communication/message/include/canmessage.h" +#include "communication/message/filter/include/canmessagefilter.h" +#include + +namespace icsneo { + +class CANMessageCallback : public MessageCallback { +public: + CANMessageCallback(fn_messageCallback cb, CANMessageFilter f = CANMessageFilter()) : MessageCallback(cb, std::make_shared(f)) {} + + // Allow the filter to be placed first if the user wants (maybe in the case of a lambda) + CANMessageCallback(CANMessageFilter f, fn_messageCallback cb) : MessageCallback(cb, std::make_shared(f)) {} +}; + +}; + +#endif \ No newline at end of file diff --git a/communication/message/callback/include/main51messagecallback.h b/communication/message/callback/include/main51messagecallback.h new file mode 100644 index 0000000..472243e --- /dev/null +++ b/communication/message/callback/include/main51messagecallback.h @@ -0,0 +1,21 @@ +#ifndef __MAIN51MESSAGECALLBACK_H_ +#define __MAIN51MESSAGECALLBACK_H_ + +#include "communication/message/callback/include/messagecallback.h" +#include "communication/message/include/main51message.h" +#include "communication/message/filter/include/main51messagefilter.h" +#include + +namespace icsneo { + +class Main51MessageCallback : public MessageCallback { +public: + Main51MessageCallback(fn_messageCallback cb, Main51MessageFilter f = Main51MessageFilter()) : MessageCallback(cb, std::make_shared(f)) {} + + // Allow the filter to be placed first if the user wants (maybe in the case of a lambda) + Main51MessageCallback(Main51MessageFilter f, fn_messageCallback cb) : MessageCallback(cb, std::make_shared(f)) {} +}; + +}; + +#endif \ No newline at end of file diff --git a/communication/include/messagecallback.h b/communication/message/callback/include/messagecallback.h similarity index 64% rename from communication/include/messagecallback.h rename to communication/message/callback/include/messagecallback.h index 20ce11c..9f80154 100644 --- a/communication/include/messagecallback.h +++ b/communication/message/callback/include/messagecallback.h @@ -1,46 +1,36 @@ -#ifndef __MESSAGECALLBACK_H_ -#define __MESSAGECALLBACK_H_ - -#include "communication/message/include/message.h" -#include "communication/include/messagefilter.h" -#include -#include -#include - -namespace icsneo { - -class MessageCallback { -public: - typedef std::function< void( std::shared_ptr ) > fn_messageCallback; - - MessageCallback(fn_messageCallback cb, std::shared_ptr f) : callback(cb), filter(f) {} - MessageCallback(fn_messageCallback cb, MessageFilter f = MessageFilter()) : callback(cb), filter(std::make_shared(f)) {} - - // Allow the filter to be placed first if the user wants (maybe in the case of a lambda) - MessageCallback(MessageFilter f, fn_messageCallback cb) { MessageCallback(cb, f); } - - virtual bool callIfMatch(const std::shared_ptr& message) const { - bool ret = filter->match(message); - if(ret) - callback(message); - return ret; - } - const MessageFilter& getFilter() const { return *filter; } - const fn_messageCallback& getCallback() const { return callback; } - -protected: - fn_messageCallback callback; - std::shared_ptr filter; -}; - -class CANMessageCallback : public MessageCallback { -public: - CANMessageCallback(fn_messageCallback cb, CANMessageFilter f = CANMessageFilter()) : MessageCallback(cb, std::make_shared(f)) {} - - // Allow the filter to be placed first if the user wants (maybe in the case of a lambda) - CANMessageCallback(CANMessageFilter f, fn_messageCallback cb) : MessageCallback(cb, std::make_shared(f)) {} -}; - -}; - +#ifndef __MESSAGECALLBACK_H_ +#define __MESSAGECALLBACK_H_ + +#include "communication/message/include/message.h" +#include "communication/message/filter/include/messagefilter.h" +#include + +namespace icsneo { + +class MessageCallback { +public: + typedef std::function< void( std::shared_ptr ) > fn_messageCallback; + + MessageCallback(fn_messageCallback cb, std::shared_ptr f) : callback(cb), filter(f) {} + MessageCallback(fn_messageCallback cb, MessageFilter f = MessageFilter()) : callback(cb), filter(std::make_shared(f)) {} + + // Allow the filter to be placed first if the user wants (maybe in the case of a lambda) + MessageCallback(MessageFilter f, fn_messageCallback cb) { MessageCallback(cb, f); } + + virtual bool callIfMatch(const std::shared_ptr& message) const { + bool ret = filter->match(message); + if(ret) + callback(message); + return ret; + } + const MessageFilter& getFilter() const { return *filter; } + const fn_messageCallback& getCallback() const { return callback; } + +protected: + fn_messageCallback callback; + std::shared_ptr filter; +}; + +}; + #endif \ No newline at end of file diff --git a/communication/message/filter/include/canmessagefilter.h b/communication/message/filter/include/canmessagefilter.h new file mode 100644 index 0000000..6e28d18 --- /dev/null +++ b/communication/message/filter/include/canmessagefilter.h @@ -0,0 +1,38 @@ +#ifndef __CANMESSAGEFILTER_H_ +#define __CANMESSAGEFILTER_H_ + +#include "communication/message/filter/include/messagefilter.h" +#include "communication/include/network.h" +#include "communication/message/include/message.h" +#include "communication/message/include/canmessage.h" +#include + +namespace icsneo { + +class CANMessageFilter : public MessageFilter { +public: + CANMessageFilter() : MessageFilter(Network::Type::CAN), arbid(INVALID_ARBID) {} + CANMessageFilter(uint32_t arbid) : MessageFilter(Network::Type::CAN), arbid(arbid) {} + + bool match(const std::shared_ptr& message) const { + if(!MessageFilter::match(message)) + return false; + const auto canMessage = std::dynamic_pointer_cast(message); + if(canMessage == nullptr || !matchArbID(canMessage->arbid)) + return false; + return true; + } + +private: + static constexpr uint32_t INVALID_ARBID = 0xffffffff; + uint32_t arbid; + bool matchArbID(uint32_t marbid) const { + if(arbid == INVALID_ARBID) + return true; + return arbid == marbid; + } +}; + +}; + +#endif \ No newline at end of file diff --git a/communication/message/filter/include/main51messagefilter.h b/communication/message/filter/include/main51messagefilter.h new file mode 100644 index 0000000..be07299 --- /dev/null +++ b/communication/message/filter/include/main51messagefilter.h @@ -0,0 +1,46 @@ +#ifndef __MAIN51MESSAGEFILTER_H_ +#define __MAIN51MESSAGEFILTER_H_ + +#include "communication/message/filter/include/messagefilter.h" +#include "communication/include/network.h" +#include "communication/include/communication.h" +#include "communication/message/include/main51message.h" +#include +#include + +namespace icsneo { + +class Main51MessageFilter : public MessageFilter { +public: + Main51MessageFilter() : MessageFilter(Network::NetID::Main51), command(INVALID_COMMAND) {} + Main51MessageFilter(Command command) : MessageFilter(Network::NetID::Main51), command(command) {} + + bool match(const std::shared_ptr& message) const { + if(!MessageFilter::match(message)) { + std::cout << "message filter did not match base for " << message->network << std::endl; + return false; + } + const auto main51Message = std::dynamic_pointer_cast(message); + if(!main51Message) + std::cout << "could not upcast " << message->network << std::endl; + if(main51Message == nullptr || !matchCommand(main51Message->command)) { + if(main51Message) + std::cout << "Could not match command " << (int)(command) << " to " << (int)(main51Message->command) << std::endl; + return false; + } + return true; + } + +private: + static constexpr Command INVALID_COMMAND = (Command)0xff; + Command command; + bool matchCommand(Command mcommand) const { + if(command == INVALID_COMMAND) + return true; + return command == mcommand; + } +}; + +}; + +#endif \ No newline at end of file diff --git a/communication/include/messagefilter.h b/communication/message/filter/include/messagefilter.h similarity index 57% rename from communication/include/messagefilter.h rename to communication/message/filter/include/messagefilter.h index 10be675..d40972d 100644 --- a/communication/include/messagefilter.h +++ b/communication/message/filter/include/messagefilter.h @@ -1,72 +1,47 @@ -#ifndef __MESSAGEFILTER_H_ -#define __MESSAGEFILTER_H_ - -#include "communication/include/network.h" -#include "communication/message/include/message.h" -#include "communication/message/include/canmessage.h" -#include - -namespace icsneo { - -class MessageFilter { -public: - MessageFilter() : matchAny(true) {} - MessageFilter(Network::Type type) : type(type) {} - MessageFilter(Network::NetID netid) : netid(netid) {} - virtual ~MessageFilter() {} - - virtual bool match(const std::shared_ptr& message) const { - if(matchAny) - return true; - if(!matchType(message->network.getType())) - return false; - if(!matchNetID(message->network.getNetID())) - return false; - return true; - } - -private: - bool matchAny = false; - - Network::Type type = Network::Type::Invalid; // Matching a type of invalid will match any - bool matchType(Network::Type mtype) const { - if(type == Network::Type::Invalid) - return true; - return type == mtype; - } - - Network::NetID netid = Network::NetID::Invalid; // Matching a netid of invalid will match any - bool matchNetID(Network::NetID mnetid) const { - if(netid == Network::NetID::Invalid) - return true; - return netid == mnetid; - } -}; - -class CANMessageFilter : public MessageFilter { -public: - CANMessageFilter() : MessageFilter(Network::Type::CAN), arbid(INVALID_ARBID) {} - CANMessageFilter(uint32_t arbid) : MessageFilter(Network::Type::CAN), arbid(arbid) {} - - bool match(const std::shared_ptr& message) const { - if(!MessageFilter::match(message)) - return false; - const auto canMessage = std::dynamic_pointer_cast(message); - if(canMessage == nullptr || !matchArbID(canMessage->arbid)) - return false; - return true; - } - -private: - static constexpr uint32_t INVALID_ARBID = 0xffffffff; - uint32_t arbid; - bool matchArbID(uint32_t marbid) const { - if(arbid == INVALID_ARBID) - return true; - return arbid == marbid; - } -}; - -}; - +#ifndef __MESSAGEFILTER_H_ +#define __MESSAGEFILTER_H_ + +#include "communication/include/network.h" +#include "communication/message/include/message.h" +#include + +namespace icsneo { + +class MessageFilter { +public: + MessageFilter() : matchAny(true) {} + MessageFilter(Network::Type type) : type(type) {} + MessageFilter(Network::NetID netid) : netid(netid) {} + virtual ~MessageFilter() {} + + virtual bool match(const std::shared_ptr& message) const { + if(matchAny) + return true; + if(!matchType(message->network.getType())) + return false; + if(!matchNetID(message->network.getNetID())) + return false; + return true; + } + +private: + bool matchAny = false; + + Network::Type type = Network::Type::Invalid; // Matching a type of invalid will match any + bool matchType(Network::Type mtype) const { + if(type == Network::Type::Invalid) + return true; + return type == mtype; + } + + Network::NetID netid = Network::NetID::Invalid; // Matching a netid of invalid will match any + bool matchNetID(Network::NetID mnetid) const { + if(netid == Network::NetID::Invalid) + return true; + return netid == mnetid; + } +}; + +}; + #endif \ No newline at end of file diff --git a/communication/message/include/main51message.h b/communication/message/include/main51message.h new file mode 100644 index 0000000..f901790 --- /dev/null +++ b/communication/message/include/main51message.h @@ -0,0 +1,17 @@ +#ifndef __MAIN51MESSAGE_H_ +#define __MAIN51MESSAGE_H_ + +#include "communication/message/include/message.h" +#include "communication/include/communication.h" + +namespace icsneo { + +class Main51Message : public Message { +public: + virtual ~Main51Message() = default; + Command command; +}; + +}; + +#endif \ No newline at end of file diff --git a/communication/message/include/message.h b/communication/message/include/message.h index 39ca828..8e1f813 100644 --- a/communication/message/include/message.h +++ b/communication/message/include/message.h @@ -8,7 +8,7 @@ namespace icsneo { class Message { public: - virtual ~Message() {} + virtual ~Message() = default; Network network; std::vector data; uint64_t timestamp; diff --git a/communication/message/include/serialnumbermessage.h b/communication/message/include/serialnumbermessage.h new file mode 100644 index 0000000..ddf956b --- /dev/null +++ b/communication/message/include/serialnumbermessage.h @@ -0,0 +1,24 @@ +#ifndef __SERIALNUMBERMESSAGE_H_ +#define __SERIALNUMBERMESSAGE_H_ + +#include "communication/message/include/main51message.h" +#include "communication/include/command.h" +#include + +namespace icsneo { + +// The response for Command::RequestSerialNumber +class SerialNumberMessage : public Main51Message { +public: + SerialNumberMessage() : Main51Message() { command = Command::RequestSerialNumber; } + virtual ~SerialNumberMessage() = default; + std::string deviceSerial; + uint8_t macAddress[6]; // This might be all zeros even if `hasMacAddress` is true + bool hasMacAddress = false; // The message might not actually be long enough to contain a MAC address, in which case we mark this + uint8_t pcbSerial[16]; + bool hasPCBSerial = false; +}; + +}; + +#endif \ No newline at end of file diff --git a/device/device.cpp b/device/device.cpp index cf03cb7..6c8155a 100644 --- a/device/device.cpp +++ b/device/device.cpp @@ -1,4 +1,5 @@ #include "include/device.h" +#include "communication/message/callback/include/messagecallback.h" #include "communication/include/command.h" #include #include