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

src_main/io_utils/pibroadcast.h

@@ -31,43 +31,98 @@ class PIBroadcast: public PIThread, public PIEthUtilBase {
 	PIOBJECT_SUBCLASS(PIBroadcast, PIThread)
 public:
 
+	//! %PIBroadcast channels, can be used independently
 	enum Channel {
-		Multicast = 0x01,
-		Broadcast = 0x02,
-		Loopback  = 0x04,
-		All = 0xFFFF,
+		Multicast /** Use multicast addresses */ = 0x01,
+		Broadcast /** Use broadcast addresses */ = 0x02,
+		Loopback  /** Use loopback addresses */ = 0x04,
+		All /** Use all channels */ = 0xFFFF,
 	};
+
 	typedef PIFlags<Channel> Channels;
 
+	/** Contructs %PIBroadcast, if \"send_only\" not set
+	 * all PIEthernets will be binded to receive data
+	 * */
 	PIBroadcast(bool send_only = false);
+
 	~PIBroadcast();
 
+	//! Set channels to \"ch\" and queue to reinit
 	void setChannels(Channels ch);
+
+	//! Returns channels
 	Channels channels() const {return _channels;}
 
+	//! Returns if is send_only
+	bool isSendOnly() const {return _send_only;}
+
+
+	//! Set multicast IP to \"mg\" and queue to reinit
 	void setMulticastGroup(const PIString & mg);
+
+	//! Returns multicast IP
 	PIString multicastGroup() const {return mcast_address.ipString();}
+
+	//! Set multicast port to \"port\" and queue to reinit
 	void setMulticastPort(ushort port);
+
+	//! Returns multicast port
 	ushort multicastPort() const {return mcast_address.port();}
+
+	//! Set multicast address to \"addr\" and queue to reinit
 	void setMulticastAddress(const PIEthernet::Address & addr);
+
+	//! Returns multicast address
 	PIEthernet::Address multicastAddress() const {return mcast_address;}
 
+
+	//! Set broadcast port to \"port\" and queue to reinit
 	void setBroadcastPort(ushort port);
+
+	//! Returns broadcast port
 	ushort broadcastPort() {return bcast_port;}
 
+
+	//! Set loopback start port to \"port\" and queue to reinit
 	void setLoopbackPort(ushort port);
+
+	//! Returns loopback start port
 	ushort loopbackPort() {return lo_port;}
+
+	//! Set loopback ports count to \"count\" and queue to reinit
 	void setLoopbackPortsCount(int count);
+
+	//! Returns loopback ports count
 	int loopbackPortsCount() const {return lo_pcnt;}
 
+
+	//! If not send_only starts all threaded reads
 	void startRead();
+
+	//! Stop all threaded reads
 	void stopRead();
+
+	//! Reinit all PIEthernets with current \a PIEthernet::allAddresses()
 	void reinit();
 
+
+	//! Send packet
 	void send(const PIByteArray & data);
+
 	EVENT1(receiveEvent, PIByteArray, data)
 
+	//! \events
+	//! \{
+
+		//! \fn void receiveEvent(PIByteArray data)
+		//! \brief Raise on packet received
+
+	//! \}
+
 protected:
+
+	//! Called when packet received
 	virtual void received(PIByteArray data) {}
 
 private:

src_main/io_utils/piethutilbase.h

@@ -30,17 +30,38 @@ public:
 	PIEthUtilBase();
 	~PIEthUtilBase();
 
+	//! Set crypt layer enabled
 	void setCryptEnabled(bool on) {_crypt = on;}
+
+	//! Enable crypt layer
 	void cryptEnable() {setCryptEnabled(true);}
+
+	//! Disable crypt layer
 	void cryptDisable() {setCryptEnabled(false);}
+
+	//! Returns if crypt layer enabled
 	bool isCryptEnabled() const {return _crypt;}
 
+
+	//! Set crypt layer key to \"k\"
 	void setCryptKey(const PIByteArray & k) {_key = k;}
+
+	//! Generate crypt layer key by \a PICrypt::hash and
+	//! set crypt layer enabled
 	void createCryptKey(const PIString & k);
+
+	//! Returns crypt layer key
 	PIByteArray cryptKey() const {return _key;}
 
 protected:
+
+	/*! \brief Returns encrypted data if layer enabled,
+	 *  otherwise returns unchanged \"data\" */
 	PIByteArray   cryptData(const PIByteArray & data);
+
+	/*! \brief Returns decrypted data if layer enabled,
+	 *  otherwise returns unchanged \"data\". If decryption
+	 *  was unsuccessfull returns empty %PIByteArray. */
 	PIByteArray decryptData(const PIByteArray & data);
 
 private:

src_main/io_utils/pistreampacker.h

@@ -32,24 +32,61 @@ class PIIODevice;
 class PIStreamPacker: public PIObject, public PIEthUtilBase {
 	PIOBJECT(PIStreamPacker)
 public:
+	//! Contructs packer and try to assign \"dev\"
 	PIStreamPacker(PIIODevice * dev = 0);
 
-	int maxPacketSize() {return max_packet_size;}
+	//! Set maximum size of single packet
 	void setMaxPacketSize(int max_size) {max_packet_size = max_size;}
 
-	ushort packetSign() {return packet_sign;}
+	//! Returns maximum size of single packet, default 1400 bytes
+	int maxPacketSize() {return max_packet_size;}
+
+
+	//! Set packet sinature
 	void setPacketSign(ushort sign_) {packet_sign = sign_;}
 
+	//! Returns packet sinature, default 0xAFBE
+	ushort packetSign() {return packet_sign;}
+
+
+	//! Prepare data for send and raise \a sendRequest() events
 	void send(const PIByteArray & data);
+
+	//! Receive data part. If packet is ready, raise \a received() event
 	void received(const PIByteArray & data);
+
 	EVENT_HANDLER2(void, received, uchar * , readed, int, size) {received(PIByteArray(readed, size));}
 
+	//! Connect \"dev\" \a PIIODevice::threadedReadEvent() event to \a received() handler
+	//! and \a sendRequest() event to \"dev\" \a PIIODevice::write() handler
 	void assignDevice(PIIODevice * dev);
 
 	EVENT1(packetReceiveEvent, PIByteArray, data)
 	EVENT1(sendRequest, PIByteArray, data)
 
-protected:
+	//! \handlers
+	//! \{
+
+		//! \fn void received(uchar * readed, int size)
+		//! \brief Handler to receive data. \a PIIODevice::threadedReadEvent()
+		//! can be connected to this handler
+
+	//! \}
+
+	//! \events
+	//! \{
+
+		//! \fn void packetReceiveEvent(PIByteArray data)
+		//! \brief Raise on packet successfully received
+
+		//! \fn void sendRequest(PIByteArray data)
+		//! \brief Raise from \a send() function. This data should
+		//! be directly sended to your device. You can
+		//! connect this event to \a PIIODevice::write() handler
+
+	//! \}
+
+private:
 	PIByteArray stream, packet;
 	int packet_size;
 	ushort packet_sign;