PIBroadcast Class Reference

Broadcast for all interfaces, including loopback. More...

Inheritance diagram for PIBroadcast:

Public Types
enum	Channel { Multicast = 0x01 , Broadcast = 0x02 , Loopback = 0x04 , All = 0xFFFF }
	PIBroadcast channels, can be used independently More...
Public Types inherited from PIThread
enum	Priority {   piLowerst , piLow , piNormal , piHigh ,   piHighest }
	Priority of thread. More...

Public Member Functions
	PIBroadcast (bool send_only=false)
void	setChannels (Channels ch)
	Set channels to "ch" and queue to reinit.
Channels	channels () const
	Returns channels.
bool	isSendOnly () const
	Returns if is send_only.
void	setMulticastGroup (const PIString &mg)
	Set multicast IP to "mg" and queue to reinit.
PIString	multicastGroup () const
	Returns multicast IP.
void	setMulticastPort (ushort port)
	Set multicast port to "port" and queue to reinit.
ushort	multicastPort () const
	Returns multicast port.
void	setMulticastAddress (const PINetworkAddress &addr)
	Set multicast address to "addr" and queue to reinit.
PINetworkAddress	multicastAddress () const
	Returns multicast address.
void	setBroadcastPort (ushort port)
	Set broadcast port to "port" and queue to reinit.
ushort	broadcastPort ()
	Returns broadcast port.
void	setLoopbackPort (ushort port)
	Set loopback start port to "port" and queue to reinit.
ushort	loopbackPort ()
	Returns loopback start port.
void	setLoopbackPortsCount (int count)
	Set loopback ports count to "count" and queue to reinit.
int	loopbackPortsCount () const
	Returns loopback ports count.
void	startRead ()
	If not send_only starts all threaded reads.
void	stopRead ()
	Stop all threaded reads.
void	reinit ()
	Reinit all PIEthernets with current PIEthernet::allAddresses()
void	send (const PIByteArray &data)
	Send packet.
Public Member Functions inherited from PIThread
	PIThread (void *data, ThreadFunc func, bool startNow=false, PISystemTime loop_delay={})
	Contructs thread with custom data "data", external function "func" and main loop delay "loop_delay".
	PIThread (std::function< void()> func, bool startNow=false, PISystemTime loop_delay={})
	Contructs thread with external function "func" and main loop delay "loop_delay".
	PIThread (bool startNow=false, PISystemTime loop_delay={})
	Contructs thread with main loop delay "loop_delay".
bool	start ()
	Start thread.
bool	start (PISystemTime loop_delay)
	Start thread.
bool	start (ThreadFunc func)
	Start thread.
bool	start (ThreadFunc func, PISystemTime loop_delay)
	Start thread.
bool	start (std::function< void()> func)
	Start thread.
bool	start (std::function< void()> func, PISystemTime loop_delay)
	Start thread.
bool	startOnce ()
	Start thread without internal loop. More...
bool	startOnce (ThreadFunc func)
	Start thread without internal loop. More...
bool	startOnce (std::function< void()> func)
	Start thread without internal loop.
bool	stopAndWait (PISystemTime timeout={})
	Stop thread and wait for finish. Returns false if timeout expired.
void	setData (void *d)
	Set common data passed to external function.
void	setSlot (ThreadFunc func)
	Set external function that will be executed after every run()
void	setSlot (std::function< void()> func)
	Set external function that will be executed after every run()
void	setPriority (PIThread::Priority prior)
	Set thread priority.
void *	data () const
	Returns common data passed to external function.
PIThread::Priority	priority () const
	Return thread priority.
bool	isRunning () const
	Return if thread is running.
bool	isStopping () const
	Return if thread is stopping.
bool	waitForStart (PISystemTime timeout={})
	Wait for thread start.
bool	waitForStart (int timeout_msecs) DEPRECATEDM("use waitForStart(PISystemTime)")
bool	waitForFinish (PISystemTime timeout={})
	Wait for thread finish. Returns false if timeout expired.
bool	waitForFinish (int timeout_msecs) DEPRECATEDM("use waitForFinish(PISystemTime)")
void	needLockRun (bool need)
	Set necessity of lock every run() with internal mutex.
PIMutex &	mutex () const
	Returns internal mutex.
llong	tid () const
	Returns thread ID.
void	stop ()
	Stop thread. More...
void	terminate ()
	Strongly stop thread. More...
void	lock () const
	Lock internal mutex.
void	unlock () const
	Unlock internal mutex.
void	started ()
	Raise on thread start.
void	stopped ()
	Raise on thread stop.
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...
Public Member Functions inherited from PIEthUtilBase
void	setCryptEnabled (bool on)
	Set crypt layer enabled.
void	cryptEnable ()
	Enable crypt layer.
void	cryptDisable ()
	Disable crypt layer.
bool	isCryptEnabled () const
	Returns if crypt layer enabled.
void	setCryptKey (const PIByteArray &k)
	Set crypt layer key to "k".
void	createCryptKey (const PIString &k)
	Generate crypt layer key by PICrypt::hash and set crypt layer enabled.
PIByteArray	cryptKey () const
	Returns crypt layer key.

Protected Member Functions
virtual void	received (PIByteArray data)
	Called when packet received.
virtual void	addressesChanged ()
	Called when addresses are changed.
Protected Member Functions inherited from PIThread
virtual void	begin ()
	Function executed once at the start of thread.
virtual void	run ()
	Function executed at every "loop_delay" msecs until thread was stopped.
virtual void	end ()
	Function executed once at the end of thread.
Protected Member Functions inherited from PIObject
PIObject *	emitter () 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.
Protected Member Functions inherited from PIEthUtilBase
PIByteArray	cryptData (const PIByteArray &data)
	Returns encrypted data if layer enabled, otherwise returns unchanged "data".
PIByteArray	decryptData (const PIByteArray &data)
	Returns decrypted data if layer enabled, otherwise returns unchanged "data". If decryption was unsuccessfull returns empty PIByteArray.

Events
void	receiveEvent (PIByteArray data)
	Raise on packet received.

Additional Inherited Members
Static Public Member Functions inherited from PIThread
static void	runOnce (PIObject *object, const char *handler, const PIString &name=PIString())
	Call event handler "handler" of object "object" in separate thread. More...
static void	runOnce (std::function< void()> func, const PIString &name=PIString())
	Call lambda expression "func" in separate thread. More...
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 PIObject *	findByName (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)
Static Public Member Functions inherited from PIEthUtilBase
static size_t	cryptSizeAddition ()
	Returns addition size for crypted data.
Related Functions inherited from PIObject
#define	piCoutObj
	Macro used for conditional (piDebug && PIObject::debug()) output to PICout(StdOut) for subclasses of PIObject.
#define	piCerrObj
	Macro used for conditional (piDebug && PIObject::debug()) output to PICout(StdErr) for subclasses of PIObject.
#define	PIOBJECT(name)
	You should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output.
#define	PIOBJECT_SUBCLASS(name, parent)
	You should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class, and scopeList()
#define	EVENT_HANDLER0(ret, name)   ret name()
	Declare event handler with name "name" and return type "ret", ret name()
#define	EVENT_HANDLER1(ret, name, type0, var0)   ret name(type0 var0)
	Declare event handler with name "name" and return type "ret", ret name(type0 var0)
#define	EVENT_HANDLER2(ret, name, type0, var0, type1, var1)   ret name(type0 var0, type1 var1)
	Declare event handler with name "name" and return type "ret", ret name(type0 var0, type1 var1)
#define	EVENT_HANDLER3(ret, name, type0, var0, type1, var1, type2, var2)   ret name(type0 var0, type1 var1, type2 var2)
	Declare event handler with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2)
#define	EVENT_HANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3)    ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	Declare event handler with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2, type3 var3)
#define	EVENT_HANDLER   EVENT_HANDLER0
	Synonym of EVENT_HANDLER0.
#define	EVENT_VHANDLER0(ret, name)   virtual ret name()
	Declare virtual event handler with name "name" and return type "ret", virtual ret name()
#define	EVENT_VHANDLER1(ret, name, type0, var0)   virtual ret name(type0 var0)
	Declare virtual event handler with name "name" and return type "ret", virtual ret name(type0 var0)
#define	EVENT_VHANDLER2(ret, name, type0, var0, type1, var1)   virtual ret name(type0 var0, type1 var1)
	Declare virtual event handler with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1)
#define	EVENT_VHANDLER3(ret, name, type0, var0, type1, var1, type2, var2)   virtual ret name(type0 var0, type1 var1, type2 var2)
	Declare virtual event handler with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2)
#define	EVENT_VHANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3)    virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	Declare virtual event handler with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)
#define	EVENT_VHANDLER   EVENT_VHANDLER0
	Synonym of EVENT_VHANDLER0.
#define	EVENT0(name)   void name();
	Declare event with name "name", void name();.
#define	EVENT1(name, type0, var0)   void name(type0 var0);
	Declare event with name "name", void name(type0 var0);.
#define	EVENT2(name, type0, var0, type1, var1)   void name(type0 var0, type1 var1);
	Declare event with name "name", void name(type0 var0, type1 var1);.
#define	EVENT3(name, type0, var0, type1, var1, type2, var2)   void name(type0 var0, type1 var1, type2 var2);
	Declare event with name "name", void name(type0 var0, type1 var1, type2 var2);.
#define	EVENT4(name, type0, var0, type1, var1, type2, var2, type3, var3)   void name(type0 var0, type1 var1, type2 var2, type3 var3);
	Declare event with name "name", void name(type0 var0, type1 var1, type2 var2, type3 var3);.
#define	EVENT   EVENT0
	Synonym of EVENT0.
#define	CONNECTU(src, event, dest, handler)
	Connect event "event" from object "src" to event handler or event "handler" of object "dest". More...
#define	CONNECTU_QUEUED(src, event, dest, handler, performer)
	Connect event "event" from object "src" to event handler or event "handler" of object "dest". More...
#define	CONNECTL(src, event, functor)
	Connect event "event" from object "src" to lambda-expression "functor". More...
#define	CONNECT0(ret, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists. More...
#define	CONNECT1(ret, type0, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists. More...
#define	CONNECT2(ret, type0, type1, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists. More...
#define	CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists. More...
#define	CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists. More...
#define	CONNECT   CONNECT0
	Synonym of CONNECT0. More...
#define	WEAK_CONNECT0(ret, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists. More...
#define	WEAK_CONNECT1(ret, type0, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists. More...
#define	WEAK_CONNECT2(ret, type0, type1, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists. More...
#define	WEAK_CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists. More...
#define	WEAK_CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	Connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists. More...
#define	WEAK_CONNECT   WEAK_CONNECT0
	Synonym of WEAK_CONNECT0. More...
#define	DISCONNECT0(ret, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"
#define	DISCONNECT1(ret, type0, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"
#define	DISCONNECT2(ret, type0, type1, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"
#define	DISCONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"
#define	DISCONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"
#define	DISCONNECT   DISCONNECT0
	Synonym of DISCONNECT0.
#define	HANDLER(handler)
	Returns pointer to events handler "handler".

Detailed Description

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().

• Multicast ethernets use multicastGroup() and multicastPort()
• Broadcast ethernets use broadcastPort()
• Loopback ethernet use loopbackPortsCount() started from loopbackPort()

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

Member Enumeration Documentation

Channel

enum PIBroadcast::Channel

PIBroadcast channels, can be used independently

Enumerator
Multicast	Use multicast addresses
Broadcast	Use broadcast addresses
Loopback	Use loopback addresses
All	Use all channels

Constructor & Destructor Documentation

PIBroadcast()

PIBroadcast::PIBroadcast

(

bool

send_only = false

)

Contructs PIBroadcast, if "send_only" not set all PIEthernets will be binded to receive data