Changeset 58e9e02 for lib/libtrace.h

Timestamp:

04/28/05 15:22:40 (17 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:

a6badc2

Parents:

48cfaed

Message:

Added trace_get_{source,destination}_port
Added an API version #define
Consitification fixes

File:

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

lib/libtrace.h

@@ -34 +34 @@
 #include <sys/types.h>
 #include <netinet/in.h>
+
+/** API version as 3 byte hex digits */
+#define LIBTRACE_API_VERSION 0x010010
 
 #ifdef __cplusplus 
@@ -239 +242 @@
  * @returns a pointer to the IP header, or NULL if there is not an IP packet
  */
-struct libtrace_ip *trace_get_ip(struct libtrace_packet_t *packet);
+struct libtrace_ip *trace_get_ip(const struct libtrace_packet_t *packet);
 
 /** get a pointer to the TCP header (if any)
@@ -246 +249 @@
  * @returns a pointer to the TCP header, or NULL if there is not a TCP packet
  */
-struct libtrace_tcp *trace_get_tcp(struct libtrace_packet_t *packet);
+struct libtrace_tcp *trace_get_tcp(const struct libtrace_packet_t *packet);
 
 /** get a pointer to the TCP header (if any) given a pointer to the IP header
@@ -265 +268 @@
  * @returns a pointer to the UDP header, or NULL if this is not a UDP packet
  */
-struct libtrace_udp *trace_get_udp(struct libtrace_packet_t *packet);
+struct libtrace_udp *trace_get_udp(const struct libtrace_packet_t *packet);
 
 /** get a pointer to the UDP header (if any) given a pointer to the IP header
@@ -282 +285 @@
  * @returns a pointer to the ICMP header, or NULL if this is not a ICMP packet
  */
-struct libtrace_icmp *trace_get_icmp(struct libtrace_packet_t *packet);
+struct libtrace_icmp *trace_get_icmp(const struct libtrace_packet_t *packet);
 
 /** get a pointer to the ICMP header (if any) given a pointer to the IP header
@@ -479 +482 @@
  */
 int trace_bpf_filter(struct libtrace_filter_t *filter,
-                struct libtrace_packet_t *packet);
+                const struct libtrace_packet_t *packet);
 
 
 typedef enum {USE_DEST, USE_SOURCE} serverport_t;
+
+/** Get the source port
+ * @param packet        the packet to read from
+ * @returns a port in \em HOST byte order, or equivilent to ports for this
+ * protocol, or 0 if this protocol has no ports.
+ * @author Perry Lorier
+ */
+uint16_t trace_get_source_port(const struct libtrace_packet_t *);
+
+/** Get the destination port
+ * @param packet        the packet to read from
+ * @returns a port in \em HOST byte order, or equivilent to ports for this
+ * protocol, or 0 if this protocol has no ports.
+ * @author Perry Lorier
+ */
+uint16_t trace_get_destination_port(const struct libtrace_packet_t *);
 
 /** hint at the server port in specified protocol