Changeset 1506 for trunk/lib/daglegacy.h

Timestamp:

02/03/10 14:29:43 (3 years ago)

Author:

salcock

Message:

• Added nice doxygen documentation to daglegacy.h
• Also slapped a GPL licence on the front of the code

File:

• trunk/lib/daglegacy.h (modified) (1 diff, 1 prop)

trunk/lib/daglegacy.h

@@ +1 @@
+/*
+ * This file is part of libtrace
+ *
+ * Copyright (c) 2007,2008,2009,2010 The University of Waikato, Hamilton, 
+ * New Zealand.
+ *
+ * Authors: Daniel Lawson 
+ *          Perry Lorier
+ *          Shane Alcock 
+ *          
+ * All rights reserved.
+ *
+ * This code has been developed by the University of Waikato WAND 
+ * research group. For further information please see http://www.wand.net.nz/
+ *
+ * libtrace 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.
+ *
+ * libtrace 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 libtrace; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * $Id$
+ *
+ */
+
 #ifndef DAG_LEGACY_H
 #define DAG_LEGACY_H
 
+/** @file
+ *
+ * @brief Header file describing the framing formats used by old legacy DAG
+ * implementations.
+ *
+ * @author Daniel Lawson
+ * @author Perry Lorier
+ * @author Shane Alcock
+ *
+ * @version $Id$
+ *
+ */
+
+
+/** Legacy ATM cell header */
 typedef struct legacy_cell {
-        uint64_t  ts;
-        uint32_t  crc;
+        uint64_t  ts;           /**< 64-bit timestamp in the ERF format */
+        uint32_t  crc;          /**< CRC checksum */
 } PACKED legacy_cell_t;
 
+/** Legacy Ethernet header */
 typedef struct legacy_ether {
-        uint64_t  ts;
-        uint16_t  wlen;
+        uint64_t  ts;           /**< 64-bit timestamp in the ERF format */
+        uint16_t  wlen;         /**< Wire length */
 } PACKED legacy_ether_t;
 
+/** Legacy Packet-over-SONET header */
 typedef struct legacy_pos {
-        uint64_t  ts;
-        uint32_t  slen;
-        uint32_t  wlen;
+        uint64_t  ts;           /**< 64-bit timestamp in the ERF format */
+        uint32_t  slen;         /**< Capture length */
+        uint32_t  wlen;         /**< Wire length */
 } PACKED legacy_pos_t;
 
+/** ATM cell header capture, a la Auckland VII */
 typedef struct atmhdr {
-        uint32_t ts_fraction;
-        uint32_t ts_sec;
+        uint32_t ts_fraction;   /**< Partial seconds portion of the timestamp */
+        uint32_t ts_sec;        /**< Seconds portion of the timestamp */
 } PACKED atmhdr_t;
 
+/** Legacy header format used for capturing the NZIX-I trace set */
 typedef struct legacy_nzix {
-        uint32_t ts;
-        uint32_t crc;
-        uint32_t len;
+        uint32_t ts;            /**< Time elapsed since the last packet in
+                                     microseconds */
+        uint32_t crc;           /**< CRC checksum */
+        uint32_t len;           /**< Wire length */
+
         /* The padding has actually been placed in the middle of the IP
          * header - when we read in the packet, we will move various bits
          * of the packet around until the padding ends up here and the 
          * IP header is undivided */
-        uint8_t pad[2];         
+        uint8_t pad[2];         /**< Padding */
 } PACKED legacy_nzix_t;
 #endif