PIP 5.6.1
Platform-Independent Primitives
Открытые члены | Защищенные члены | Полный список членов класса
Класс PIStreamPacker

Простая фрагментация пакетов, использует любой PIIODevice. Подробнее...

#include <pistreampacker.h>

Граф наследования:PIStreamPacker:
Inheritance graph
[см. легенду]

Открытые члены

 PIStreamPacker (PIIODevice *dev=nullptr)
 Создает упаковщик и при необходимости привязывает его к "dev".
 
int receivePacketProgress () const
 Возвращает число байтов полезной нагрузки, собранных для текущего пакета.
 
void clear ()
 Очищает буферизованное состояние потока и данные незавершенного пакета.
 
void send (const PIByteArray &data)
 Фрагментирует данные и вызывает sendRequest() для каждого фрагмента
 
void received (const PIByteArray &data)
 Передает полученные байты в распаковщик. Подробнее...
 
void assignDevice (PIIODevice *dev)
 Связывает обратные вызовы чтения и записи устройства "dev" с этим упаковщиком. Подробнее...
 
- Открытые члены унаследованные от PIObject
 PIObject (const PIString &name=PIString())
 Создает объект и инициализирует его свойство name.
 
virtual ~PIObject ()
 Уничтожает объект, вызывает deleted() и отключает его от событийного графа.
 
PIString name () const
 Возвращает свойство name этого объекта.
 
virtual const char * className () const
 Возвращает зарегистрированное имя класса этого объекта.
 
virtual uint classNameID () const
 Возвращает хэш от className().
 
virtual const char * parentClassName () const
 Возвращает зарегистрированное имя родительского класса, либо пустую строку для корня.
 
bool debug () const
 Возвращает, включен ли вывод piCoutObj для этого объекта.
 
void setName (const PIString &name)
 Устанавливает свойство name этого объекта.
 
void setDebug (bool debug)
 Включает или отключает вывод piCoutObj для этого объекта.
 
PIVariant property (const char *name) const
 Возвращает свойство объекта по имени "name".
 
void setProperty (const char *name, const PIVariant &value)
 Устанавливает свойство "name" в значение "value" и создаёт его при необходимости. Подробнее...
 
bool isPropertyExists (const char *name) const
 Возвращает, существует ли свойство "name".
 
void setThreadSafe (bool yes)
 Включает или отключает внутренний мьютекс объекта во время выполнения обработчиков. Подробнее...
 
bool isThreadSafe () const
 Возвращает, включен ли внутренний мьютекс объекта для выполнения обработчиков.
 
bool execute (const PIString &method, const PIVector< PIVariantSimple > &vl)
 Выполняет зарегистрированный метод или метод-обработчик по имени с переданными аргументами. Подробнее...
 
bool execute (const PIString &method)
 Перегрузка execute() для метода без аргументов.
 
bool execute (const PIString &method, const PIVariantSimple &v0)
 Перегрузка execute() для одного аргумента.
 
bool execute (const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1)
 Перегрузка execute() для двух аргументов.
 
bool execute (const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1, const PIVariantSimple &v2)
 Перегрузка execute() для трёх аргументов.
 
bool execute (const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1, const PIVariantSimple &v2, const PIVariantSimple &v3)
 Перегрузка execute() для четырёх аргументов.
 
bool executeQueued (PIObject *performer, const PIString &method, const PIVector< PIVariantSimple > &vl)
 Ставит выполнение зарегистрированного метода в очередь объекта-исполнителя. Подробнее...
 
bool executeQueued (PIObject *performer, const PIString &method)
 Перегрузка executeQueued() для метода без аргументов.
 
bool executeQueued (PIObject *performer, const PIString &method, const PIVariantSimple &v0)
 Перегрузка executeQueued() для одного аргумента.
 
bool executeQueued (PIObject *performer, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1)
 Перегрузка executeQueued() для двух аргументов.
 
bool executeQueued (PIObject *performer, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1, const PIVariantSimple &v2)
 Перегрузка executeQueued() для трёх аргументов.
 
bool executeQueued (PIObject *performer, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1, const PIVariantSimple &v2, const PIVariantSimple &v3)
 Перегрузка executeQueued() для четырёх аргументов.
 
void dump (const PIString &line_prefix=PIString()) const
 Выводит диагностическую информацию об объекте в проектный поток вывода.
 
PIStringList scopeList () const
 Возвращает зарегистрированную цепочку наследования объекта, включая его собственный класс.
 
PIStringList methodsEH () const
 Возвращает полные сигнатуры всех зарегистрированных событий и обработчиков для области этого класса.
 
bool isMethodEHContains (const PIString &name) const
 Возвращает, существует ли зарегистрированное событие или обработчик с таким именем.
 
PIString methodEHArguments (const PIString &name) const
 Возвращает список типов аргументов зарегистрированного метода через запятую.
 
PIString methodEHFullFormat (const PIString &name) const
 Возвращает полную зарегистрированную сигнатуру метода.
 
PIString methodEHFromAddr (const void *addr) const
 Возвращает имя зарегистрированного метода для указанного адреса точки входа.
 
void piDisconnect (const PIString &sig, PIObject *dest, void *ev_h)
 Разрывает соединения этого объекта-источника с конкретным обработчиком объекта-приемника для события "sig".
 
void piDisconnect (const PIString &sig, PIObject *dest)
 Разрывает все соединения этого объекта-источника от события "sig" к объекту-приемнику "dest".
 
void piDisconnect (const PIString &sig)
 Разрывает все соединения этого объекта-источника от события "sig".
 
bool isPIObject () const
 Возвращает, указывает ли этот указатель на ещё существующий экземпляр PIObject.
 
template<typename T >
bool isTypeOf () const
 Возвращает, принадлежит ли этот объект классу "T" или одному из его зарегистрированных потомков.
 
template<typename T >
T * cast () const
 Возвращает этот объект, приведённый к типу "T", если isTypeOf<T>() успешно, иначе nullptr.
 
void callQueuedEvents ()
 Выполняет все отложенные доставки, поставленные в очередь этому объекту-исполнителю.
 
bool maybeCallQueuedEvents ()
 Выполняет отложенные доставки только если этот объект использовался как исполнитель. Подробнее...
 
void deleteLater ()
 Планирует отложенное удаление объекта. Подробнее...
 
void deleted (PIObject *o)
 Вызывается непосредственно перед уничтожением объекта. Подробнее...
 
- Открытые члены унаследованные от PIStreamPackerConfig
 PIStreamPackerConfig ()
 Создает конфигурацию с параметрами пакетирования по умолчанию.
 
void setMaxPacketSize (int max_size)
 Устанавливает максимальный размер одного отправляемого фрагмента.
 
int maxPacketSize () const
 Возвращает максимальный размер одного отправляемого фрагмента.
 
void setPacketSign (ushort sign_)
 Устанавливает сигнатуру пакета для поиска границ кадра.
 
ushort packetSign () const
 Возвращает сигнатуру пакета.
 
void setaAggressiveOptimization (bool yes)
 Включает более быструю ресинхронизацию при неверных данных в потоке. Подробнее...
 
bool aggressiveOptimization () const
 Возвращает, включена ли агрессивная ресинхронизация.
 
bool cryptSizeEnabled () const
 Возвращает, шифруется ли также поле размера пакета.
 
void setCryptSizeEnabled (bool on)
 Включает или выключает шифрование поля размера пакета.
 
const PIStreamPackerConfigconfiguration () const
 Возвращает конфигурацию как константную ссылку на себя.
 
PIStreamPackerConfigconfiguration ()
 Возвращает конфигурацию как изменяемую ссылку на себя.
 
void setConfiguration (const PIStreamPackerConfig &config)
 Заменяет текущую конфигурацию пакетирования на "config".
 
- Открытые члены унаследованные от PIEthUtilBase
 PIEthUtilBase ()
 Создает помощник с выключенным слоем шифрования.
 
 ~PIEthUtilBase ()
 Уничтожает помощник шифрования.
 
void setCryptEnabled (bool on)
 Включает или выключает слой шифрования.
 
void cryptEnable ()
 Включает слой шифрования.
 
void cryptDisable ()
 Выключает слой шифрования.
 
bool isCryptEnabled () const
 Возвращает, включен ли слой шифрования.
 
void setCryptKey (const PIByteArray &k)
 Устанавливает ключ шифрования "k" и включает слой шифрования.
 
void createCryptKey (const PIString &k)
 Генерирует ключ шифрования из парольной фразы "k" и включает слой шифрования.
 
PIByteArray cryptKey () const
 Возвращает текущий ключ шифрования.
 

Защищенные члены

virtual void packetReceived (PIByteArray data)
 Вызывается после восстановления полезной нагрузки пакета.
 
- Защищенные члены унаследованные от PIObject
PIObjectemitter () const
 Возвращает объект-источник, который вызвал текущее событие. Подробнее...
 
virtual void propertyChanged (const char *name)
 Виртуальный метод, вызываемый после изменения свойства "name" через setProperty().
 
- Защищенные члены унаследованные от PIEthUtilBase
PIByteArray cryptData (const PIByteArray &data)
 Шифрует "data", если слой шифрования включен.
 
PIByteArray decryptData (const PIByteArray &data)
 Дешифрует "data", если слой шифрования включен. Подробнее...
 

Handlers

void received (const uchar *readed, ssize_t size)
 Перегрузка обработчика для сырых буферов байтов из PIIODevice::threadedReadEvent().
 

Events

void packetReceiveEvent (PIByteArray &data)
 Генерируется, когда пакет полностью принят.
 
void startPacketReceive (int size)
 Генерируется при начале приема нового пакета с размером полезной нагрузки "size".
 
void endPacketReceive ()
 Генерируется после полного приема текущего пакета.
 
void sendRequest (PIByteArray data)
 Генерируется методом send() для каждого готового к записи во устройство фрагмента.
 

Дополнительные унаследованные члены

- Открытые статические члены унаследованные от PIObject
static bool execute (PIObject *o, const PIString &method, const PIVector< PIVariantSimple > &vl)
 Статическая удобная обёртка над execute().
 
static bool execute (PIObject *o, const PIString &method)
 Статическая перегрузка execute() без аргументов.
 
static bool execute (PIObject *o, const PIString &method, const PIVariantSimple &v0)
 Статическая перегрузка execute() для одного аргумента.
 
static bool execute (PIObject *o, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1)
 Статическая перегрузка execute() для двух аргументов.
 
static bool execute (PIObject *o, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1, const PIVariantSimple &v2)
 Статическая перегрузка execute() для трёх аргументов.
 
static bool execute (PIObject *o, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1, const PIVariantSimple &v2, const PIVariantSimple &v3)
 Статическая перегрузка execute() для четырёх аргументов.
 
static bool executeQueued (PIObject *o, PIObject *performer, const PIString &method, const PIVector< PIVariantSimple > &vl)
 Статическая удобная обёртка над executeQueued().
 
static bool executeQueued (PIObject *o, PIObject *performer, const PIString &method)
 Статическая перегрузка executeQueued() без аргументов.
 
static bool executeQueued (PIObject *o, PIObject *performer, const PIString &method, const PIVariantSimple &v0)
 Статическая перегрузка executeQueued() для одного аргумента.
 
static bool executeQueued (PIObject *o, PIObject *performer, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1)
 Статическая перегрузка executeQueued() для двух аргументов.
 
static bool executeQueued (PIObject *o, PIObject *performer, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1, const PIVariantSimple &v2)
 Статическая перегрузка executeQueued() для трёх аргументов.
 
static bool executeQueued (PIObject *o, PIObject *performer, const PIString &method, const PIVariantSimple &v0, const PIVariantSimple &v1, const PIVariantSimple &v2, const PIVariantSimple &v3)
 Статическая перегрузка executeQueued() для четырёх аргументов.
 
static PIObject::Connection piConnect (PIObject *src, const PIString &sig, PIObject *dest_o, void *dest, void *ev_h, void *e_h, int args, const char *loc)
 Низкоуровневый помощник прямого соединения, лежащий под устаревшими макросами CONNECT*.
 
static PIObject::Connection piConnectU (PIObject *src, const PIString &sig, PIObject *dest_o, void *dest, const PIString &hname, const char *loc, PIObject *performer=0)
 Низкоуровневый помощник соединения по имени, лежащий под CONNECTU() и CONNECTU_QUEUED().
 
static PIObject::Connection piConnectLS (PIObject *src, const PIString &sig, std::function< void()> *f, const char *loc)
 Низкоуровневый помощник, который соединяет событие с лямбдой или обёрткой функтора.
 
static void piDisconnect (PIObject *src, const PIString &sig, PIObject *dest, void *ev_h)
 Разрывает соединения объекта-источника "src" с конкретным обработчиком объекта-приемника для события "sig".
 
static void piDisconnect (PIObject *src, const PIString &sig, PIObject *dest)
 Разрывает все соединения объекта-источника "src" от события "sig" к объекту-приемнику "dest".
 
static void piDisconnect (PIObject *src, const PIString &sig)
 Разрывает все соединения объекта-источника "src" от события "sig".
 
static void raiseEvent (PIObject *sender, const uint eventID)
 Внутренний помощник доставки для зарегистрированных событий без аргументов.
 
template<typename T0 >
static void raiseEvent (PIObject *sender, const uint eventID, const T0 &v0=T0())
 Внутренний помощник доставки для зарегистрированных событий с одним аргументом.
 
template<typename T0 , typename T1 >
static void raiseEvent (PIObject *sender, const uint eventID, const T0 &v0=T0(), const T1 &v1=T1())
 Внутренний помощник доставки для зарегистрированных событий с двумя аргументами.
 
template<typename T0 , typename T1 , typename T2 >
static void raiseEvent (PIObject *sender, const uint eventID, const T0 &v0=T0(), const T1 &v1=T1(), const T2 &v2=T2())
 Внутренний помощник доставки для зарегистрированных событий с тремя аргументами.
 
template<typename T0 , typename T1 , typename T2 , typename T3 >
static void raiseEvent (PIObject *sender, const uint eventID, const T0 &v0=T0(), const T1 &v1=T1(), const T2 &v2=T2(), const T3 &v3=T3())
 Внутренний помощник доставки для зарегистрированных событий с четырьмя аргументами.
 
static PIObjectfindByName (const PIString &name)
 Возвращает первый живой объект с именем "name", либо nullptr.
 
static bool isPIObject (const PIObject *o)
 Возвращает, указывает ли "o" на ещё существующий экземпляр PIObject.
 
static bool isPIObject (const void *o)
 Перегрузка isPIObject() для нетипизированного указателя.
 
template<typename T >
static bool isTypeOf (const PIObject *o)
 Возвращает, принадлежит ли "o" классу "T" или одному из его зарегистрированных потомков.
 
template<typename T >
static bool isTypeOf (const void *o)
 Перегрузка isTypeOf() для нетипизированного указателя.
 
static PIString simplifyType (const char *a, bool readable=true)
 Упрощает запись типа C++ для метаданных зарегистрированных методов.
 
- Открытые статические члены унаследованные от PIEthUtilBase
static size_t cryptSizeAddition ()
 Возвращает дополнительный размер, добавляемый шифрованием.
 

Подробное описание

Простая фрагментация пакетов, использует любой PIIODevice.

Simple packet wrap aroud any PIIODevice.

Предоставляет фрагментацию и дефрагментацию пакетов для передачи данных через любую реализацию PIIODevice

Synopsis

PIStreamPacker provides simple pack/unpack logic for any data packets.

When you call send() function data splited into several parts, packetSign() prepended to first part and sendRequest() event raised several times.

When your device receive some data, call received() function. packetReceiveEvent() event will be raised when packet will be collected.

Use assignDevice() to connect device to this PIStreamPacker.

Методы

◆ received()

void PIStreamPacker::received ( const PIByteArray data)

Передает полученные байты в распаковщик.

Вызывает packetReceived() и генерирует packetReceiveEvent(), когда пакет собран полностью.

◆ assignDevice()

void PIStreamPacker::assignDevice ( PIIODevice dev)

Связывает обратные вызовы чтения и записи устройства "dev" с этим упаковщиком.

Подключает PIIODevice::threadedReadEvent() к received(), а sendRequest() к PIIODevice::write().