git-svn-id: svn://db.shs.com.ru/pip@636 12ceb7fc-bf1f-11e4-8940-5bc7170c53b5

src_io_utils/pibroadcast.cpp

@@ -19,6 +19,28 @@
 
 #include "pibroadcast.h"
 
+/** \class PIBroadcast
+ * \brief Broadcast for all interfaces, including loopback
+ *
+ * \section PIBroadcast_synopsis Synopsis
+ * %PIBroadcast used as multichannel IO device. It can use
+ * multicast, broadcast and loopback ethernet channels to
+ * send/receive packets. \a send() function send packet to
+ * all initialized ethernets. \a receiveEvent() raised on
+ * packet received by any ethernet. All multi/broadcast
+ * ethernets created for all current addresses, obtained
+ * by \a PIEthernets::allAddresses().
+ *
+ * * \a Multicast ethernets use \a multicastGroup() and \a multicastPort()
+ * * \a Broadcast ethernets use \a broadcastPort()
+ * * \a Loopback ethernet use \a loopbackPortsCount() started from \a loopbackPort()
+ *
+ * %PIBroadcast starts thread , which every 3 seconds check if
+ * current \a PIEthernet::allAddresses() was changed and call
+ * \a reinit() if it necessary.
+ *
+*/
+
 #define MULTICAST_TTL   4