Add missing documentation.

[stg.git] / include / stg / rs_packets.h

diff --git a/include/stg/rs_packets.h b/include/stg/rs_packets.h
index 1a038be7f1a68f07e20b7344d9f03481fd09c43a..503fe91d7584522d9280c760eabc9f55eda7fa3f 100644 (file)
--- a/include/stg/rs_packets.h
+++ b/include/stg/rs_packets.h
@@ -1,3 +1,24 @@
+/*
+ *    This program is free software; you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation; either version 2 of the License, or
+ *    (at your option) any later version.
+ *
+ *    This program is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with this program; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+/*
+ *    Author : Boris Mikhailenko <stg34@stargazer.dp.ua>
+ *    Author : Maxim Mamontov <faust@stargazer.dp.ua>
+ */
+

 #ifndef RS_PACKETSH
 #define RS_PACKETSH
 
 #ifndef RS_PACKETSH
 #define RS_PACKETSH
 


@@ -15,7 +36,10 @@
 
 #include "os_int.h"
 
 
 #include "os_int.h"
 

-struct RS_PACKET_HEADER
+namespace RS
+{
+
+struct PACKET_HEADER

 {
 int8_t              magic[RS_MAGIC_LEN];
 int8_t              protoVer[RS_PROTO_VER_LEN];
 {
 int8_t              magic[RS_MAGIC_LEN];
 int8_t              protoVer[RS_PROTO_VER_LEN];


@@ -26,11 +50,13 @@ int8_t              login[RS_LOGIN_LEN];
 int8_t              padding[7];
 } __attribute__((__packed__)); // 48 bytes, 6 blocks
 
 int8_t              padding[7];
 } __attribute__((__packed__)); // 48 bytes, 6 blocks
 

-struct RS_PACKET_TAIL
+struct PACKET_TAIL

 {
 int8_t              magic[RS_MAGIC_LEN];
 int8_t              params[RS_PARAMS_LEN];
 int8_t              padding[7];
 } __attribute__((__packed__)); // 992 bytes, 124 blocks
 
 {
 int8_t              magic[RS_MAGIC_LEN];
 int8_t              params[RS_PARAMS_LEN];
 int8_t              padding[7];
 } __attribute__((__packed__)); // 992 bytes, 124 blocks
 

+} // namespace RS
+

 #endif
 #endif