SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity

threadedRead now const uchar *

Browse Source 
pipacketextractor Header mode now more flexible
fix splitTime mode
more refactoring
add virtual override to functions
remove piforeach
replace 0 to nullptr
iterate over pimap via iterators
replace CONNECTU to CONNECT# with compile time check
This commit is contained in:
Бычков Андрей
2022-07-26 17:18:08 +03:00
parent a4882dc054
commit d13e68c206
36 changed files with 615 additions and 623 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
libs/main/io_utils/pipacketextractor.h
View File

@@ -28,8 +28,11 @@
#include "piiodevice.h"
/// TODO: написать документацию, тут ничего не понятно
// Pass data, recHeaderPtr, received_data, recHeaderSize. Return true if packet is correct nor return false.
typedef bool (*PacketExtractorCheckFunc)(void * , uchar * , uchar * , int );
typedef int (*PacketExtractorHeaderFunc)(const uchar *, const uchar *, int);
typedef bool (*PacketExtractorPayloadFunc)(const uchar *, int );
typedef bool (*PacketExtractorFooterFunc)(const uchar *, const uchar *, int);
class PIP_EXPORT PIPacketExtractor: public PIIODevice
{
@@ -48,7 +51,7 @@ public:
};
//! Contructs extractor with child device "device_" and extract algorithm "mode"
explicit PIPacketExtractor(PIIODevice * device_ = 0, SplitMode mode = None);
explicit PIPacketExtractor(PIIODevice * device_ = nullptr, SplitMode mode = None);
virtual ~PIPacketExtractor() {stop();}
@@ -66,13 +69,13 @@ public:
//! Set buffer size to "new_size" bytes, should be at least greater than whole packet size
void setBufferSize(int new_size);
void setHeaderCheckSlot(PacketExtractorCheckFunc f) {ret_func_header = f;}
void setFooterCheckSlot(PacketExtractorCheckFunc f) {ret_func_footer = f;}
void setPayloadCheckSlot(ReadRetFunc f) {ret_func_ = f;}
void setHeaderCheckSlot(PacketExtractorHeaderFunc f) {func_header = f;}
void setPayloadCheckSlot(PacketExtractorPayloadFunc f) {func_payload = f;}
void setFooterCheckSlot(PacketExtractorFooterFunc f) {func_footer = f;}
//! Set extract algorithm
void setSplitMode(SplitMode mode) {setProperty("splitMode", int(mode)); mode_ = mode;}
void setSplitMode(SplitMode mode) {setProperty("splitMode", int(mode));}
//! Set payload size, used for PIPacketExtractor::Header and PIPacketExtractor::Footer algorithms
void setPayloadSize(int size);
@@ -84,17 +87,17 @@ public:
void setFooter(const PIByteArray & data);
//! Set packet size, used for PIPacketExtractor::Size algorithm
void setPacketSize(int size) {setProperty("packetSize", size); packetSize_ = size;}
void setPacketSize(int size) {setProperty("packetSize", size);}
//! Set timeout in milliseconds, used for PIPacketExtractor::Timeout algorithm
void setTimeout(double msecs) {setProperty("timeout", msecs); time_ = msecs;}
void setTimeout(double msecs) {setProperty("timeout", msecs);}
//! Returns current extract algorithm
SplitMode splitMode() const {return (SplitMode)(property("splitMode").toInt());}
SplitMode splitMode() const {return mode_;}
//! Returns current payload size, used for PIPacketExtractor::Header and PIPacketExtractor::Footer algorithms
int payloadSize() const {return property("payloadSize").toInt();}
int payloadSize() const {return dataSize;}
//! Returns current header data, used for PIPacketExtractor::Header and PIPacketExtractor::HeaderAndFooter algorithms
PIByteArray header() const {return src_header;}
@@ -103,10 +106,10 @@ public:
PIByteArray footer() const {return src_footer;}
//! Returns current packet size, used for PIPacketExtractor::Size algorithm
int packetSize() const {return property("packetSize").toInt();}
int packetSize() const {return packetSize_;}
//! Returns current timeout in milliseconds, used for PIPacketExtractor::Timeout algorithm
double timeout() const {return property("timeout").toDouble();}
double timeout() const {return time_;}
//! Returns missed by validating functions bytes count
@@ -122,17 +125,17 @@ public:
const ullong * missedPackets_ptr() const {return &missed_packets;}
//! Add data to extractor, raise \a packetReceived() if packet is ready
void appendData(const void * d, int s) {threadedRead(const_cast<uchar*>((const uchar *)d), s);}
void appendData(const uchar * d, int s) {threadedRead(d, s);}
//! Add data to extractor, raise \a packetReceived() if packet is ready
void appendData(const PIByteArray & data) {appendData(data.data(), data.size_s());}
void appendData(const PIByteArray & data) {threadedRead(data.data(), data.size_s());}
EVENT2(packetReceived, uchar * , data, int, size);
EVENT2(packetReceived, const uchar * , data, int, size);
//! \events
//! \{
//! \fn void packetReceived(uchar * data, int size)
//! \fn void packetReceived(const uchar * data, int size)
//! \brief Raise on successfull \a packetValidate() function
//! \}
@@ -144,35 +147,37 @@ protected:
* \param rec Received header
* \param size Header size
* \details Default implementation returns by-byte "src" with "rec" compare result */
virtual bool validateHeader(uchar * src, uchar * rec, int size) {if (ret_func_header != 0) return ret_func_header(ret_data_, src, rec, size); for (int i = 0; i < size; ++i) if (src[i] != rec[i]) return false; return true;}
virtual int validateHeader(const uchar * src, const uchar * rec, int size);
/** \brief Function to validate footer
* \param src Your footer content
* \param rec Received footer
* \param size Footer size
* \details Default implementation returns by-byte "src" with "rec" compare result */
virtual bool validateFooter(uchar * src, uchar * rec, int size) {if (ret_func_footer != 0) return ret_func_footer(ret_data_, src, rec, size); for (int i = 0; i < size; ++i) if (src[i] != rec[i]) return false; return true;}
virtual bool validateFooter(const uchar * src, const uchar * rec, int size);
/** \brief Function to validate payload
* \param rec Received payload
* \param size payload size
* \details Default implementation returns \b true */
virtual bool validatePayload(uchar * rec, int size) {if (ret_func_ != 0) return ret_func_(ret_data_, rec, size); return true;}
virtual bool validatePayload(const uchar * rec, int size);
private:
void construct();
void propertyChanged(const char *);
int readDevice(void * read_to, int max_size) {if (dev == 0) return -1; return dev->read(read_to, max_size);}
int writeDevice(const void * data, int max_size) {if (dev == 0) return -1; return dev->write(data, max_size);}
bool threadedRead(uchar * readed, int size);
PIString constructFullPathDevice() const;
bool openDevice() {if (dev == 0) return false; return dev->open();}
bool closeDevice() {if (dev == 0) return false; return dev->close();}
DeviceInfoFlags deviceInfoFlags() const {if (dev) return dev->infoFlags(); return 0;}
virtual int readDevice(void * read_to, int max_size) override;
virtual int writeDevice(const void * data, int max_size) override;
virtual bool threadedRead(const uchar * readed, int size) override;
virtual PIString constructFullPathDevice() const override;
virtual bool openDevice() override;
virtual bool closeDevice() override;
virtual DeviceInfoFlags deviceInfoFlags() const override;
PIIODevice * dev;
PIByteArray buffer, tmpbuf, src_header, src_footer, trbuf;
PacketExtractorCheckFunc ret_func_header, ret_func_footer;
PacketExtractorHeaderFunc func_header;
PacketExtractorPayloadFunc func_payload;
PacketExtractorFooterFunc func_footer;
SplitMode mode_;
int buffer_size, dataSize, packetSize_hf, footerInd, packetSize_;
double time_;