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 PIEthernet::Address &addr)
	Set multicast address to "addr" and queue to reinit.
PIEthernet::Address	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, int loop_delay=-1)
	Contructs thread with custom data "data", external function "func" and main loop delay "loop_delay".
	PIThread (bool startNow=false, int loop_delay=-1)
	Contructs thread with main loop delay "loop_delay".
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	setPriority (PIThread::Priority prior)
	Set priority of thread.
void *	data () const
	Returns common data passed to external function.
PIThread::Priority	priority () const
	Return priority of thread.
bool	isRunning () const
	Return true if thread is running.
void	needLockRun (bool need)
	Set necessity of lock every run with internal mutex.
PIMutex &	mutex ()
	Returns internal mutex.
llong	tid () const
	Returns thread ID.
bool	start (int timer_delay)
	Start thread. More...
bool	startOnce ()
	Start thread without internal loop. More...
bool	startOnce (ThreadFunc func)
	Start thread without internal loop. More...
void	stop (bool wait)
	Stop thread. More...
void	terminate ()
	Strongly stop thread. More...
bool	waitForStart (int timeout_msecs)
	Wait for thread start. More...
bool	waitForFinish (int timeout_msecs)
	Wait for thread finish. More...
void	lock ()
	Lock internal mutex.
void	unlock ()
	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 object class name.
bool	debug () const
	Return if debug of this object is active.
void	setName (const PIString &name)
	Set object name.
void	setDebug (bool debug)
	Set object debug active.
const PIMap< PIString, PIVariant > &	properties () const
	Returns properties of the object.
int	propertiesCount () const
	Returns properties count of the object.
PIVariant	property (const PIString &name) const
	Returns property with name "name".
void	setProperty (const PIString &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 PIString &name) const
	Returns if property with name "name" exists.
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)
PIByteArray	cryptKey () const
	Returns crypt layer key.

Protected Member Functions
virtual void	received (PIByteArray data)
	Called when packet received.
Protected Member Functions inherited from PIThread
virtual void	begin ()
	Function executed once at the start of thread.
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 PIString &name)
	Virtual function executes after property with name "name" has been changed.
void	deleted ()
	Raise before object delete. More...
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 PIObject
static void	piDisconnect (PIObject *src, const PIString &sig)
	Disconnect object "src" from all connections with event name "sig".
static void	piDisconnect (PIObject *src)
	Disconnect object "src" from all connections, i.e. all connections where object "src" is emitter.
static PIObject *	findByName (const PIString &name)
	Returns PIObject* with name "name" or 0, if there is no object found.
Related Functions inherited from PIObject
#define	piCoutObj
	Macro used for conditional (piDebug and PIObject::debug()) output to PICout 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 "event" with name "name" and return type "ret", ret name()
#define	EVENT_HANDLER1(ret, name, type0, var0)   ret name(type0 var0)
	declare event handler "event" 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 "event" 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 "event" 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 "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2, type3 var3)
#define	EVENT_HANDLER   EVENT_HANDLER0
	EVENT_HANDLER is synonym of EVENT_HANDLER0.
#define	EVENT_VHANDLER0(ret, name)   virtual ret name()
	declare virtual event handler "event" 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 "event" 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 "event" 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 "event" 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 "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)
#define	EVENT_VHANDLER   EVENT_VHANDLER0
	EVENT_VHANDLER is synonym of EVENT_VHANDLER0.
#define	EVENT0(name)   void name();
	declare event "event" with name "name", void name();
#define	EVENT1(name, type0, var0)   void name(type0 var0);
	declare event "event" with name "name", void name(type0 var0);
#define	EVENT2(name, type0, var0, type1, var1)   void name(type0 var0, type1 var1);
	declare event "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 "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 "event" with name "name", void name(type0 var0, type1 var1, type2 var2, type3 var3);
#define	EVENT   EVENT0
	EVENT is synonym of EVENT0.
#define	CONNECTU(src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler". "Event" and "handler" must has equal argument lists.
#define	CONNECTU_QUEUED(src, event, dest, handler, performer)
	connect event "event" from object "src" to event handler "handler". Event handler will be executed by "performer". "Event" and "handler" must has equal argument lists.
#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
#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
#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
#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
#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
#define	CONNECT   CONNECT0
	CONNECT is synonym of CONNECT0.
#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
#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
#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
#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
#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
#define	WEAK_CONNECT   WEAK_CONNECT0
	WEAK_CONNECT is synonym of WEAK_CONNECT0.
#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
	DISCONNECT is 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