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

Многоканальный отправитель и приемник через multicast-, broadcast- и loopback-конечные точки. Подробнее...

#include <pibroadcast.h>

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

Открытые типы

enum  Channel
 Транспортные каналы, которые можно включать независимо.
 
typedef PIFlags< ChannelChannels
 Битовая маска включенных значений Channel.
 
- Открытые типы унаследованные от PIThread
enum  Priority {
  piLowerst , piLow , piNormal , piHigh ,
  piHighest
}
 Подсказка приоритета потока. Подробнее...
 

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

 PIBroadcast (bool send_only=false)
 Создает broadcaster, при необходимости в режиме только отправки. Подробнее...
 
 ~PIBroadcast ()
 Уничтожает broadcaster и принадлежащие ему транспортные конечные точки.
 
void setChannels (Channels ch)
 Устанавливает включенные каналы и планирует переинициализацию.
 
Channels channels () const
 Возвращает включенные каналы.
 
bool isSendOnly () const
 Возвращает, работает ли экземпляр только на отправку.
 
void setMulticastGroup (const PIString &mg)
 Устанавливает IP multicast-группы и планирует переинициализацию.
 
PIString multicastGroup () const
 Возвращает IP multicast-группы.
 
void setMulticastPort (ushort port)
 Устанавливает multicast-порт и планирует переинициализацию.
 
ushort multicastPort () const
 Возвращает multicast-порт.
 
void setMulticastAddress (const PINetworkAddress &addr)
 Устанавливает полный multicast-адрес и планирует переинициализацию.
 
PINetworkAddress multicastAddress () const
 Возвращает адрес multicast-конечной точки.
 
void setBroadcastPort (ushort port)
 Устанавливает broadcast-порт и планирует переинициализацию.
 
ushort broadcastPort ()
 Возвращает broadcast-порт.
 
void setLoopbackPort (ushort port)
 Устанавливает первый loopback-порт и планирует переинициализацию.
 
ushort loopbackPort ()
 Возвращает первый loopback-порт.
 
void setLoopbackPortsCount (int count)
 Устанавливает число loopback-портов и планирует переинициализацию.
 
int loopbackPortsCount () const
 Возвращает число loopback-портов.
 
void startRead ()
 Запускает прием на всех инициализированных каналах.
 
void stopRead ()
 Останавливает прием на всех инициализированных каналах.
 
void reinit ()
 Пересоздает транспортные конечные точки для текущего списка PIEthernet::allAddresses().
 
void send (const PIByteArray &data)
 Отправляет один пакет через все включенные каналы.
 
- Открытые члены унаследованные от PIThread
 PIThread (void *data, ThreadFunc func, bool startNow=false, PISystemTime loop_delay={})
 Создает поток с пользовательскими данными, обратным вызовом и необязательным немедленным запуском.
 
 PIThread (std::function< void()> func, bool startNow=false, PISystemTime loop_delay={})
 Создает поток с обратным вызовом без пользовательских данных.
 
 PIThread (bool startNow=false, PISystemTime loop_delay={})
 Создает поток для наследования с необязательной задержкой цикла.
 
virtual ~PIThread ()
 Уничтожает объект потока. Если поток еще работает, при уничтожении выполняется принудительное завершение.
 
bool start ()
 Запускает поток с сохраненными обратным вызовом и задержкой цикла.
 
bool start (PISystemTime loop_delay)
 Сохраняет новую задержку цикла и запускает поток.
 
bool start (ThreadFunc func)
 Сохраняет обратный вызов и запускает поток.
 
bool start (ThreadFunc func, PISystemTime loop_delay)
 Сохраняет обратный вызов и задержку цикла, затем запускает поток.
 
bool start (std::function< void()> func)
 Сохраняет лямбда-обратный вызов и запускает поток.
 
bool start (std::function< void()> func, PISystemTime loop_delay)
 Сохраняет лямбда-обратный вызов и задержку цикла, затем запускает поток.
 
bool startOnce ()
 Запускает одноразовый поток без повторяющегося цикла. Подробнее...
 
bool startOnce (ThreadFunc func)
 Сохраняет обратный вызов и запускает одноразовое выполнение. Подробнее...
 
bool startOnce (std::function< void()> func)
 Сохраняет лямбда-обратный вызов и запускает одноразовое выполнение.
 
bool stopAndWait (int timeout_ms) DEPRECATEDM("use stopAndWait(PISystemTime)")
 Устаревшая перегрузка stopAndWait(), принимающая миллисекунды.
 
bool stopAndWait (PISystemTime timeout={})
 Запрашивает остановку и ожидает завершения потока. Возвращает false, если таймаут истек.
 
void setData (void *d)
 Устанавливает указатель данных, передаваемый в обратные вызовы ThreadFunc.
 
void setSlot (ThreadFunc func)
 Устанавливает обратный вызов, выполняемый после каждого прохода run().
 
void setSlot (std::function< void()> func)
 Устанавливает лямбда-обратный вызов, выполняемый после каждого прохода run().
 
void setPriority (PIThread::Priority prior)
 Устанавливает подсказку приоритета. Если поток уже работает, применяет ее немедленно.
 
void * data () const
 Возвращает указатель данных, передаваемый в обратные вызовы ThreadFunc.
 
PIThread::Priority priority () const
 Возвращает настроенную подсказку приоритета.
 
bool isRunning () const
 Возвращает, выполняется ли поток в данный момент.
 
bool isStopping () const
 Возвращает, был ли запрошен останов и поток еще завершает работу.
 
bool waitForStart (PISystemTime timeout={})
 Ожидает запуска потока. Возвращает false, если таймаут истек раньше.
 
bool waitForStart (int timeout_msecs) DEPRECATEDM("use waitForStart(PISystemTime)")
 Устаревшая перегрузка waitForStart(), принимающая миллисекунды. Подробнее...
 
bool waitForFinish (PISystemTime timeout={})
 Ожидает завершения потока. Возвращает false, если таймаут истек раньше.
 
bool waitForFinish (int timeout_msecs) DEPRECATEDM("use waitForFinish(PISystemTime)")
 Устаревшая перегрузка waitForFinish(), принимающая миллисекунды. Подробнее...
 
void needLockRun (bool need)
 Включает блокировку внутреннего мьютекса вокруг begin(), run(), обратных вызовов и end().
 
PIMutexmutex () const
 Возвращает внутренний мьютекс, используемый lock(), unlock() и needLockRun().
 
llong tid () const
 Возвращает системный идентификатор потока, либо -1 когда поток не запущен.
 
void stop ()
 Запрашивает корректное завершение потока. Подробнее...
 
void terminate ()
 Принудительно прерывает поток. Используйте только как крайнюю меру. Подробнее...
 
void lock () const
 Блокирует внутренний мьютекс.
 
void unlock () const
 Разблокирует внутренний мьютекс.
 
void started ()
 Вызывается после запуска потока.
 
void stopped ()
 Вызывается при начале завершения потока.
 
- Открытые члены унаследованные от 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)
 Вызывается непосредственно перед уничтожением объекта. Подробнее...
 
- Открытые члены унаследованные от 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 received (PIByteArray data)
 Вызывается при получении пакета.
 
virtual void addressesChanged ()
 Вызывается после изменения списка адресов локальных интерфейсов.
 
- Защищенные члены унаследованные от PIThread
virtual void begin ()
 Виртуальный метод, выполняемый один раз после запуска системного потока и до started().
 
virtual void run ()
 Виртуальный метод, выполняемый на каждой итерации цикла, пока не запрошен останов.
 
virtual void end ()
 Виртуальный метод, выполняемый один раз при завершении потока после stopped().
 
- Защищенные члены унаследованные от PIObject
PIObjectemitter () const
 Возвращает объект-источник, который вызвал текущее событие. Подробнее...
 
virtual void propertyChanged (const char *name)
 Виртуальный метод, вызываемый после изменения свойства "name" через setProperty().
 
- Защищенные члены унаследованные от PIEthUtilBase
PIByteArray cryptData (const PIByteArray &data)
 Шифрует "data", если слой шифрования включен.
 
PIByteArray decryptData (const PIByteArray &data)
 Дешифрует "data", если слой шифрования включен. Подробнее...
 

Events

void receiveEvent (PIByteArray data)
 Генерируется при получении пакета на любом активном канале.
 

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

- Открытые статические члены унаследованные от PIThread
static void runOnce (PIObject *object, const char *handler, const PIString &name=PIString())
 Создает временный поток и вызывает в нем обработчик handler объекта object. Подробнее...
 
static void runOnce (std::function< void()> func, const PIString &name=PIString())
 Создает временный поток и выполняет в нем лямбда-выражение func. Подробнее...
 
- Открытые статические члены унаследованные от 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 ()
 Возвращает дополнительный размер, добавляемый шифрованием.
 

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

Многоканальный отправитель и приемник через multicast-, broadcast- и loopback-конечные точки.

Broadcast for all interfaces, including loopback.

Synopsis

PIBroadcast used as multichannel IO device. It can use multicast, broadcast and loopback ethernet channels to send/receive packets. send() function send packet to all initialized ethernets. receiveEvent() raised on packet received by any ethernet. All multi/broadcast ethernets created for all current addresses, obtained by PIEthernets::allAddresses().

PIBroadcast starts thread, which every 3 seconds check if current PIEthernet::allAddresses() was changed and call reinit() if it necessary.

Конструктор(ы)

◆ PIBroadcast()

PIBroadcast::PIBroadcast ( bool  send_only = false)

Создает broadcaster, при необходимости в режиме только отправки.

Если "send_only" равно false, также инициализируются приемные сокеты.