PIP 5.5.3
Platform-Independent Primitives
Public Types | Public Member Functions | Protected Member Functions | List of all members
PIPacketExtractor Class Reference

Packets extractor. More...

Inheritance diagram for PIPacketExtractor:
Inheritance graph
[legend]

Public Types

enum  SplitMode {
  None , Header , Footer , HeaderAndFooter ,
  Size , Timeout
}
 Extract algorithms. More...
 
- Public Types inherited from PIIODevice
enum  DeviceMode { ReadOnly = 0x01 , WriteOnly = 0x02 , ReadWrite = 0x03 }
 Open modes for PIIODevice. More...
 
enum  DeviceOption { BlockingRead = 0x01 , BlockingWrite = 0x02 }
 Options for PIIODevice, works with some devices. More...
 
enum  DeviceInfoFlag { Sequential = 0x01 , Reliable = 0x02 }
 Characteristics of PIIODevice channel. More...
 

Public Member Functions

 PIPacketExtractor (PIIODevice *device_=nullptr, SplitMode mode=None)
 Contructs extractor with child device "device_" and extract algorithm "mode".
 
PIIODevicedevice ()
 Returns child device.
 
void setDevice (PIIODevice *device_)
 Set child device to "device_".
 
ssize_t bytesAvailable () const override
 Returns the number of bytes that are available for reading. More...
 
void setSplitMode (SplitMode mode)
 Set extract algorithm.
 
void setPayloadSize (int size)
 Set payload size, used for PIPacketExtractor::Header and PIPacketExtractor::Footer algorithms.
 
void setHeader (const PIByteArray &data)
 Set header data, used for PIPacketExtractor::Header and PIPacketExtractor::HeaderAndFooter algorithms.
 
void setFooter (const PIByteArray &data)
 Set footer data, used for PIPacketExtractor::Footer and PIPacketExtractor::HeaderAndFooter algorithms.
 
void setTimeout (PISystemTime tm)
 Set timeout, used for PIPacketExtractor::Timeout algorithm.
 
SplitMode splitMode () const
 Returns current extract algorithm.
 
int payloadSize () const
 Returns current payload size, used for PIPacketExtractor::Header and PIPacketExtractor::Footer and PIPacketExtractor::Size algorithms.
 
PIByteArray header () const
 Returns current header data, used for PIPacketExtractor::Header and PIPacketExtractor::HeaderAndFooter algorithms.
 
PIByteArray footer () const
 Returns current footer data, used for PIPacketExtractor::Footer and PIPacketExtractor::HeaderAndFooter algorithms.
 
PISystemTime timeout () const
 Returns current timeout in milliseconds, used for PIPacketExtractor::Timeout algorithm.
 
ullong missedBytes () const
 Returns missed by validating functions bytes count.
 
void appendData (const uchar *d, int s)
 Add data to extractor, raise packetReceived() if packet is ready.
 
void appendData (const PIByteArray &data)
 Add data to extractor, raise packetReceived() if packet is ready.
 
- Public Member Functions inherited from PIIODevice
 PIIODevice ()
 Constructs a empty PIIODevice.
 
 PIIODevice (const PIString &path, DeviceMode mode=ReadWrite)
 Constructs PIIODevice with path "path" and open mode "mode".
 
DeviceMode mode () const
 Returns current open mode of device.
 
void setMode (DeviceMode m)
 Set open mode of device. Don`t reopen device.
 
DeviceOptions options () const
 Returns current device options.
 
bool isOptionSet (DeviceOption o) const
 Returns current device option "o" state.
 
void setOptions (DeviceOptions o)
 Set device options.
 
bool setOption (DeviceOption o, bool yes=true)
 Set device option "o" to "yes" and returns previous state.
 
DeviceInfoFlags infoFlags () const
 Returns device characteristic flags.
 
PIString path () const
 Returns current path of device.
 
void setPath (const PIString &path)
 Set path of device. Don`t reopen device.
 
bool isReadable () const
 Returns if mode is ReadOnly or ReadWrite.
 
bool isWriteable () const
 Returns if mode is WriteOnly or ReadWrite.
 
bool isOpened () const
 Returns if device is successfully opened.
 
bool isClosed () const
 Returns if device is closed.
 
virtual bool canRead () const
 Returns if device can read now.
 
virtual bool canWrite () const
 Returns if device can write now.
 
void setReopenEnabled (bool yes=true)
 Set calling of open() enabled while threaded read on closed device.
 
void setReopenTimeout (PISystemTime timeout)
 Set timeout between open() tryings if reopen is enabled.
 
bool isReopenEnabled () const
 Returns reopen enable.
 
PISystemTime reopenTimeout ()
 Returns reopen timeout.
 
void setThreadedReadSlot (ReadRetFunc func)
 Set threaded read callback. More...
 
void setThreadedReadData (void *d)
 Set custom data that will be passed to threaded read callback.
 
void setThreadedReadBufferSize (int new_size)
 Set size of threaded read buffer. More...
 
int threadedReadBufferSize () const
 Returns size of threaded read buffer.
 
const uchar * threadedReadBuffer () const
 Returns content of threaded read buffer.
 
void * threadedReadData () const
 Returns custom data that will be passed to threaded read callback.
 
bool isThreadedRead () const
 Returns if threaded read is started.
 
bool isThreadedReadStopping () const
 Returns if threaded read is stopping.
 
void startThreadedRead ()
 Start threaded read.
 
void startThreadedRead (ReadRetFunc func)
 Start threaded read and assign threaded read callback to "func".
 
void stopThreadedRead ()
 Stop threaded read.
 
void terminateThreadedRead ()
 Terminate threaded read. More...
 
bool waitThreadedReadFinished (PISystemTime timeout={})
 Wait for threaded read finish no longer than "timeout".
 
bool isThreadedWrite () const
 Returns if threaded write is started.
 
void startThreadedWrite ()
 Start threaded write.
 
void stopThreadedWrite ()
 Stop threaded write.
 
void terminateThreadedWrite ()
 Terminate threaded write. More...
 
bool waitThreadedWriteFinished (PISystemTime timeout={})
 Wait for threaded write finish no longer than "timeout".
 
void clearThreadedWriteQueue ()
 Clear threaded write task queue.
 
void start ()
 Start both threaded read and threaded write.
 
void stop ()
 Stop both threaded read and threaded write.
 
void stopAndWait (PISystemTime timeout={})
 Stop both threaded read and threaded write and wait for finish.
 
virtual void interrupt ()
 Interrupt blocking operation.
 
ssize_t read (void *read_to, ssize_t max_size)
 Read from device maximum "max_size" bytes to "read_to".
 
ssize_t read (PIMemoryBlock mb)
 Read from device to memory block "mb".
 
PIByteArray read (ssize_t max_size)
 Read from device maximum "max_size" bytes and returns them as PIByteArray.
 
virtual ssize_t bytesAvailable () const
 Returns the number of bytes that are available for reading. More...
 
ssize_t write (const void *data, ssize_t max_size)
 Write maximum "max_size" bytes of "data" to device.
 
PIByteArray readForTime (PISystemTime timeout)
 Read from device for "timeout" and return readed data as PIByteArray.
 
ullong writeThreaded (const void *data, ssize_t max_size)
 Add task to threaded write queue and return task ID.
 
ullong writeThreaded (const PIByteArray &data)
 Add task to threaded write queue and return task ID.
 
bool configure (const PIString &config_file, const PIString &section, bool parent_section=false)
 Configure device from section "section" of file "config_file", if "parent_section" parent section also will be read.
 
virtual PIConstChars fullPathPrefix () const
 Returns full unambiguous string prefix. Creating devices by unambiguous string.
 
PIString constructFullPath () const
 Returns full unambiguous string, describes this device, fullPathPrefix() + "://" + ...
 
void configureFromFullPath (const PIString &full_path)
 Configure device with parameters of full unambiguous string.
 
PIVariantTypes::IODevice constructVariant () const
 Returns PIVariantTypes::IODevice, describes this device.
 
void configureFromVariant (const PIVariantTypes::IODevice &d)
 Configure device from PIVariantTypes::IODevice.
 
ssize_t write (const PIMemoryBlock &mb)
 Write memory block "mb" to device.
 
bool open ()
 Open device.
 
bool open (const PIString &_path)
 Open device with path "path".
 
bool close ()
 Close device.
 
ssize_t write (PIByteArray data)
 Write "data" to device.
 
virtual void flush ()
 Immediate write all buffers.
 
void opened ()
 Raise if succesfull open.
 
void closed ()
 Raise if succesfull close.
 
void threadedReadEvent (const uchar *readed, ssize_t size)
 Raise if read thread succesfull read some data.
 
void threadedWriteEvent (ullong id, ssize_t written_size)
 Raise if write thread successfull write some data of task with ID "id".
 
- Public Member Functions inherited from PIObject
 PIObject (const PIString &name=PIString())
 Contructs PIObject with name "name".
 
PIString name () const
 Returns object name.
 
virtual const char * className () const
 Returns object class name.
 
virtual const char * parentClassName () const
 Returns parent class name.
 
bool debug () const
 Return if piCoutObj of this object is active.
 
void setName (const PIString &name)
 Set object name.
 
void setDebug (bool debug)
 Set object piCoutObj active.
 
PIVariant property (const char *name) const
 Returns property with name "name".
 
void setProperty (const char *name, const PIVariant &value)
 Set property with name "name" to "value". If there is no such property in object it will be added.
 
bool isPropertyExists (const char *name) const
 Returns if property with name "name" exists.
 
PIStringList scopeList () const
 Returns subclass scope of this object (including this class name)
 
void piDisconnect (const PIString &sig, PIObject *dest, void *ev_h)
 Disconnect object from all connections with event name "sig", connected to destination object "dest" and handler "ev_h".
 
void piDisconnect (const PIString &sig, PIObject *dest)
 Disconnect object from all connections with event name "sig", connected to destination object "dest".
 
void piDisconnect (const PIString &sig)
 Disconnect object from all connections with event name "sig".
 
bool isPIObject () const
 Returns if this is valid PIObject (check signature)
 
template<typename T >
bool isTypeOf () const
 Returns if this is valid PIObject subclass "T" (check signature and classname)
 
template<typename T >
T * cast () const
 Returns cast to T if this is valid subclass "T" (check by isTypeOf()) or "nullptr".
 
void callQueuedEvents ()
 Execute all posted events from CONNECTU_QUEUED connections.
 
bool maybeCallQueuedEvents ()
 Check if any CONNECTU_QUEUED connections to this object and execute them. More...
 
void deleteLater ()
 Mark object to delete. More...
 
void deleted (PIObject *o)
 Raise before object delete. More...
 

Protected Member Functions

virtual int validateHeader (const uchar *src, const uchar *rec, int size)
 Function to validate header. More...
 
virtual bool validateFooter (const uchar *src, const uchar *rec, int size)
 Function to validate footer. More...
 
virtual bool validatePayload (const uchar *rec, int size)
 Function to validate payload. More...
 
- Protected Member Functions inherited from PIIODevice
virtual bool configureDevice (const void *e_main, const void *e_parent=0)
 Reimplement to configure device from entries "e_main" and "e_parent", cast arguments to PIConfig::Entry*.
 
virtual bool openDevice ()=0
 Reimplement to open device, return value will be set to "opened_" variable. Don't call this function in subclass, use open()!
 
virtual bool closeDevice ()
 Reimplement to close device, inverse return value will be set to "opened_" variable.
 
virtual ssize_t readDevice (void *read_to, ssize_t max_size)
 Reimplement this function to read from your device.
 
virtual ssize_t writeDevice (const void *data, ssize_t max_size)
 Reimplement this function to write to your device.
 
virtual bool threadedRead (const uchar *readed, ssize_t size)
 Function executed when thread read some data, default implementation execute external callback "ret_func_".
 
virtual PIString constructFullPathDevice () const
 Reimplement to construct full unambiguous string, describes this device. Default implementation returns path()
 
virtual void configureFromFullPathDevice (const PIString &full_path)
 Reimplement to configure your device with parameters of full unambiguous string. Default implementation call setPath()
 
virtual PIPropertyStorage constructVariantDevice () const
 Reimplement to construct device properties. Default implementation return PIPropertyStorage with "path" entry.
 
virtual void configureFromVariantDevice (const PIPropertyStorage &d)
 Reimplement to configure your device from PIPropertyStorage. Options and mode already applied. Default implementation apply "path" entry.
 
virtual void optionsChanged ()
 Reimplement to apply new device options.
 
virtual DeviceInfoFlags deviceInfoFlags () const
 Reimplement to return correct DeviceInfoFlags. Default implementation returns 0.
 
virtual void threadedReadBufferSizeChanged ()
 Reimplement to apply new threadedReadBufferSize()
 
- Protected Member Functions inherited from PIObject
PIObjectemitter () const
 Returns PIObject* which has raised an event. This value is correct only in definition of some event handler.
 
virtual void propertyChanged (const char *name)
 Virtual function executes after property with name "name" has been changed.
 

Events

void packetReceived (const uchar *data, int size)
 Raise on successfull packetValidate() function.
 

Additional Inherited Members

- Static Public Member Functions inherited from PIIODevice
static PIIODevicecreateFromFullPath (const PIString &full_path)
 Try to create new device by prefix, configure it with configureFromFullPath() and returns it. More...
 
static PIIODevicecreateFromVariant (const PIVariantTypes::IODevice &d)
 Try to create new device by prefix, configure it with configureFromVariant() and returns it.
 
static PIStringList availablePrefixes ()
 Returns fullPath prefixes of all registered devices.
 
static PIStringList availableClasses ()
 Returns class names of all registered devices.
 
- Static Public Member Functions inherited from PIObject
static void piDisconnect (PIObject *src, const PIString &sig, PIObject *dest, void *ev_h)
 Disconnect object "src" from all connections with event name "sig", connected to destination object "dest" and handler "ev_h".
 
static void piDisconnect (PIObject *src, const PIString &sig, PIObject *dest)
 Disconnect object "src" from all connections with event name "sig", connected to destination object "dest".
 
static void piDisconnect (PIObject *src, const PIString &sig)
 Disconnect object "src" from all connections with event name "sig".
 
static PIObjectfindByName (const PIString &name)
 Returns PIObject* with name "name" or 0, if there is no object found.
 
static bool isPIObject (const PIObject *o)
 Returns if "o" is valid PIObject (check signature)
 
template<typename T >
static bool isTypeOf (const PIObject *o)
 Returns if "o" is valid PIObject subclass "T" (check signature and classname)
 
- Public Attributes inherited from PIIODevice
bool reopenEnabled
 setReopenEnabled, default "true"
 
int reopenTimeout
 setReopenTimeout, default 1_s
 
int threadedReadBufferSize
 setThreadedReadBufferSize in bytes, default 4096
 

Detailed Description

Packets extractor.

Synopsis

This class implements packet recognition by various algorithms and custom validating from data stream. Stream is formed from child PIIODevice passed from contructor or with function setDevice().

Principle of work

PIPacketExtractor works with child PIIODevice. read and write functions directly call child device functions. You should start threaded read of extractor (not child device) to proper work. Extractor read data from child device, try to detect packet from readed data and raise packetReceived() event on success.

Algorithms

There are 6 algorithms:

Control validating

There are three parameters:

Extractor can detect packet with compare your header with readed data. It is default implementation of function packetHeaderValidate(). If header validating passed, function packetValidate() will be called. If either of this function return false extractor shifts by one byte and takes next header. If both functions returns true extractor shifts by whole packet size.

Member Enumeration Documentation

◆ SplitMode

Extract algorithms.

Enumerator
None 

No data processing

Header 

Detect packets with header() and following payloadSize()

Footer 

Detect packets with footer() and leading payloadSize()

HeaderAndFooter 

Detect packets with header() and footer() without payloadSize()

Size 

Detect packets with packetSize()

Timeout 

Wait for first read, then read for timeout()

Member Function Documentation

◆ bytesAvailable()

ssize_t PIPacketExtractor::bytesAvailable ( ) const
overridevirtual

Returns the number of bytes that are available for reading.

This function is commonly used with sequential devices to determine the number of bytes to allocate in a buffer before reading. If function returns -1 it mean that number of bytes undefined.

Reimplemented from PIIODevice.

◆ validateHeader()

int PIPacketExtractor::validateHeader ( const uchar *  src,
const uchar *  rec,
int  size 
)
protectedvirtual

Function to validate header.

Parameters
srcYour header content
recReceived header
sizeHeader size

Default implementation returns by-byte "src" with "rec" compare result

◆ validateFooter()

bool PIPacketExtractor::validateFooter ( const uchar *  src,
const uchar *  rec,
int  size 
)
protectedvirtual

Function to validate footer.

Parameters
srcYour footer content
recReceived footer
sizeFooter size

Default implementation returns by-byte "src" with "rec" compare result

◆ validatePayload()

bool PIPacketExtractor::validatePayload ( const uchar *  rec,
int  size 
)
protectedvirtual

Function to validate payload.

Parameters
recReceived payload
sizepayload size

Default implementation returns true