Changeset 7f32bb5

Timestamp:

02/10/06 11:08:49 (15 years ago)

Author:

Perry Lorier <perry@…>

Branches:

4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, getfragoff, help, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes

Children:

7068467

Parents:

37195b4

Message:

Add sections to make finding documentation easier

File:

• lib/libtrace.h (modified) (10 diffs)

lib/libtrace.h

@@ -277 +277 @@
 void trace_perror(const char *caller);
 
+/** @name Creation and destruction of traces
+ * These members deal with creating, configuring and cleaning up a trace object
+ */
+//@{
+
 /** Create a trace file from a URI
  * 
@@ -357 +362 @@
  */
 void trace_destroy_output(struct libtrace_out_t *trace);
+//@}
+
+/** @name Reading/Writing packets
+ * These members deal with creating, reading and writing packets
+ */
+//@{
 
 /** Create a new packet object
@@ -387 +398 @@
  */
 int trace_write_packet(struct libtrace_out_t *trace, const struct libtrace_packet_t *packet);
+//@}
+
+/** @name Headers
+ * These functions locate and return a pointer to various headers inside a packet
+ */
+//@{
 
 /** get a pointer to the link layer
@@ -483 +500 @@
 SIMPLE_FUNCTION
 struct libtrace_icmp *trace_get_icmp_from_ip(const struct libtrace_ip *ip,int *skipped);
+//@}
 
 /** parse an ip or tcp option
@@ -507 +525 @@
 
 
+/** @name Time
+ * These functions deal with time that a packet arrived and return it
+ * in various formats
+ */
+//@{
 /** Get the current time in DAG time format 
  * @param packet        the packet opaque pointer
@@ -536 +559 @@
 SIMPLE_FUNCTION
 double trace_get_seconds(const struct libtrace_packet_t *packet);
-
+//@}
+
+/** @name Sizes
+ * This section deals with finding or setting the various different lengths
+ * a packet can have
+ */
+//@{
 /** Get the size of the packet in the trace
  * @param packet        the packet opaque pointer
@@ -572 +601 @@
 SIMPLE_FUNCTION
 int trace_get_framing_length(const struct libtrace_packet_t *packet);
+
+/** Truncate the packet at the suggested length
+ * @param packet        the packet opaque pointer
+ * @param size          the new length of the packet
+ * @returns the new length of the packet, or the original length of the 
+ * packet if unchanged
+ * @author Daniel Lawson
+ */
+size_t trace_set_capture_length(struct libtrace_packet_t *packet, size_t size);
+
+//@}
 
 
@@ -619 +659 @@
 uint8_t *trace_get_source_mac(const struct libtrace_packet_t *packet);
 
-/** Truncate the packet at the suggested length
- * @param packet        the packet opaque pointer
- * @param size          the new length of the packet
- * @returns the new length of the packet, or the original length of the 
- * packet if unchanged
- * @author Daniel Lawson
- */
-size_t trace_set_capture_length(struct libtrace_packet_t *packet, size_t size);
-
 /** Set the direction flag, if it has one
  * @param packet        the packet opaque pointer
@@ -681 +712 @@
                 struct libtrace_packet_t *packet);
 
+/** @name BPF
+ * This section deals with using Berkley Packet Filters
+ */
+//@{
 /** setup a BPF filter
  * @param filterstring a char * containing the bpf filter string
@@ -703 +738 @@
 int trace_bpf_filter(struct libtrace_filter_t *filter,
                 const struct libtrace_packet_t *packet);
-
+//@}
 
 /** Which port is the server port */