Changeset 1769 for pjproject/trunk/pjlib-util/include/pjlib-util/pcap.h

Timestamp:

Feb 2, 2008 9:12:13 AM (16 years ago)

Author:

bennylp

Message:

More ticket #465: option to return UDP header in pj_pcap_read_udp(), and better RTP packet handling in pcaputil sample

File:

• pjproject/trunk/pjlib-util/include/pjlib-util/pcap.h (modified) (4 diffs)

pjproject/trunk/pjlib-util/include/pjlib-util/pcap.h

@@ -61 +61 @@
 
 /**
+ * This describes UDP header, which may optionally be returned in
+ * #pj_pcap_read_udp() function. All fields are in network byte order.
+ */
+typedef struct pj_pcap_udp_hdr
+{
+    pj_uint16_t src_port;   /**< Source port.       */
+    pj_uint16_t dst_port;   /**< Destination port   */
+    pj_uint16_t len;        /**< Length.            */
+    pj_uint16_t csum;       /**< Checksum.          */
+} pj_pcap_udp_hdr;
+
+
+/**
  * This structure describes the filter to be used when reading packets from
- * a PCAP file. The filter is used to select what packets can be returned
- * to a read operation.
+ * a PCAP file. When a filter is configured, only packets matching all the
+ * filter specifications will be read from PCAP file.
  */
 typedef struct pj_pcap_filter
@@ -143 +156 @@
 
 /**
- * Configure filter for reading the file.
+ * Configure filter for reading the file. When filter is configured,
+ * only packets matching all the filter settings will be returned.
  *
  * @param file      PCAP file handle.
@@ -154 +168 @@
 
 /**
- * Read UDP payload from the next packet in the PCAP file.
+ * Read UDP payload from the next packet in the PCAP file. Optionally it
+ * can return the UDP header, if caller supplies it.
  *
  * @param file              PCAP file handle.
+ * @param udp_hdr           Optional buffer to receive UDP header.
  * @param udp_payload       Buffer to receive the UDP payload.
  * @param udp_payload_size  On input, specify the size of the buffer.
@@ -165 +181 @@
  */
 PJ_DECL(pj_status_t) pj_pcap_read_udp(pj_pcap_file *file,
+                                      pj_pcap_udp_hdr *udp_hdr,
                                       pj_uint8_t *udp_payload,
                                       pj_size_t *udp_payload_size);