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

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;