Changeset c37ab9f

Timestamp:

05/02/06 00:58:09 (16 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:

998bee5

Parents:

ca2887e

Message:

More documentation, add some enum's documenting the convention for directions

Location:

lib

Files:

• libtrace.h (modified) (4 diffs)
• trace.c (modified) (2 diffs)

lib/libtrace.h

@@ -194 +194 @@
 } libtrace_dlt_t ;
 
+/** Link layer types
+ * This enumates the various different link types that libtrace understands
+ */
+typedef enum { 
+       TRACE_TYPE_HDLC_POS = 1, 
+       TRACE_TYPE_ETH,                  /**< 802.3 style Ethernet */
+       TRACE_TYPE_ATM,
+       TRACE_TYPE_AAL5,
+       TRACE_TYPE_80211,                /**< 802.11 frames */
+       TRACE_TYPE_NONE,                 /**< Raw IP frames */
+       TRACE_TYPE_LINUX_SLL,            /**< Linux "null" framing */
+       TRACE_TYPE_PFLOG,                /**< FreeBSD's PFlug */
+       TRACE_TYPE_POS,
+       TRACE_TYPE_80211_PRISM = 12
+     } libtrace_linktype_t;
+
+/** Trace directions 
+ * Note that these are the directions used by convention, more directions 
+ * are possible, not just these 3, and that they may not conform to this
+ * convention.
+ */
+typedef enum {
+        TRACE_DIR_OUTGOING = 0,         /**< Packets originating "outside" */
+        TRACE_DIR_INCOMING = 1,         /**< Packets originating "inside" */
+        TRACE_DIR_OTHER    = 2          /**< Packets with an unknown direction, or one that's unknown */
+} libtrace_direction_t;
 
 /** @name Protocol structures
@@ -1054 +1080 @@
 
 
-/** Link layer types
- * This enumates the various different link types that libtrace understands
- */
-typedef enum { 
-       TRACE_TYPE_HDLC_POS = 1, 
-       TRACE_TYPE_ETH,                  /**< 802.3 style Ethernet */
-       TRACE_TYPE_ATM,
-       TRACE_TYPE_AAL5,
-       TRACE_TYPE_80211,                /**< 802.11 frames */
-       TRACE_TYPE_NONE,
-       TRACE_TYPE_LINUX_SLL,            /**< Linux "null" framing */
-       TRACE_TYPE_PFLOG,                /**< FreeBSD's PFlug */
-       TRACE_TYPE_POS,
-       TRACE_TYPE_80211_PRISM = 12
-     } libtrace_linktype_t;
-
 /** Get the type of the link layer
  * @param packet        the packet opaque pointer
@@ -1081 +1091 @@
 /** Set the direction flag, if it has one
  * @param packet        the packet opaque pointer
- * @param direction     the new direction (0,1,2,3)
- * @return a signed value containing the direction flag, or -1 if this is not supported
- * @author Daniel Lawson
- */
-DLLEXPORT int8_t trace_set_direction(libtrace_packet_t *packet, int8_t direction);
+ * @param direction     the new direction 
+ * @returns -1 on error, or the direction that was set.
+ */
+DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet, libtrace_direction_t direction);
 
 /** Get the direction flag, if it has one
  * @param packet        the packet opaque pointer
- * @return a signed value containing the direction flag, or -1 if this is not supported
+ * @return a value containing the direction flag, or -1 if this is not supported
  * The direction is defined as 0 for packets originating locally (ie, outbound)
  * and 1 for packets originating remotely (ie, inbound).
@@ -1097 +1106 @@
  */
 DLLEXPORT SIMPLE_FUNCTION
-int8_t trace_get_direction(const libtrace_packet_t *packet);
+libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet);
 
 /** @name BPF

lib/trace.c

@@ -1031 +1031 @@
  * @param direction the new direction (0,1,2,3)
  * @returns a signed value containing the direction flag, or -1 if this is not supported
- * @author Daniel Lawson
- */
-DLLEXPORT int8_t trace_set_direction(libtrace_packet_t *packet, int8_t direction) {
+ */
+DLLEXPORT libtrace_direction_t trace_set_direction(libtrace_packet_t *packet, 
+                libtrace_direction_t direction) 
+{
         assert(packet);
         assert(packet->size>0 && packet->size<65536);
@@ -1051 +1052 @@
  * @author Daniel Lawson
  */
-DLLEXPORT int8_t trace_get_direction(const libtrace_packet_t *packet) {
+DLLEXPORT libtrace_direction_t trace_get_direction(const libtrace_packet_t *packet) 
+{
         assert(packet);
         assert(packet->size>0 && packet->size<65536);