Changeset 1372 for trunk/lib/libtrace.h.in

Timestamp:

10/24/08 09:58:02 (5 years ago)

Author:

salcock

Message:

• Renamed hideous get_*_payload_from_ethernet_payload API functions to match the get_payload_from_* naming convention
• trace_get_payload_from_vlan now returns NULL if passed something other than a vlan header or there is no header present after the vlan header, instead of returning the original header that was passed in
• trace_get_payload_from_ip* functions now check if the ip header passed in is NULL and return NULL appropriately

File:

• trunk/lib/libtrace.h.in (modified) (3 diffs)

trunk/lib/libtrace.h.in

@@ -1219 +1219 @@
 
 /** Skips over any 802.1q headers, if present.
- * @param ethernet      A pointer to the payload following an ethernet header
- * -usually the result of calling trace_get_payload_from_link
+ * @param vlan      A pointer to the vlan header
  * @param[in,out] type  The ethernet type, replaced with the vlan ether type
  * @param[in,out] remaining Updated with the number of bytes remaining
  *
  * @return a pointer to the header beyond the vlan header, if present.
- * Otherwise, returns the ethernet payload that was passed in
+ * Otherwise, returns NULL
  *
  * Remaining may be NULL. If Remaining is not NULL it must point to the number
@@ -1235 +1234 @@
  *
  */
-DLLEXPORT void *trace_get_vlan_payload_from_ethernet_payload(
-                void *ethernet_payload, uint16_t *type, uint32_t *remaining);
+DLLEXPORT void *trace_get_payload_from_vlan(
+                void *vlan, uint16_t *type, uint32_t *remaining);
 
 /** Skips over any MPLS headers, if present.
- * @param ethernet_payload      A pointer to the payload following an ethernet
- * header - usually the result of calling trace_get_payload_from_link
+ * @param mpls      A pointer to the mpls header
  * @param[in,out] type  The ethernet type, replaced by the ether type of the
  * following header - 0x0000 if an Ethernet header is deemed to be next
@@ -1261 +1259 @@
  *
  */
-DLLEXPORT void *trace_get_mpls_payload_from_ethernet_payload(
-                void *ethernet_payload, uint16_t *type, uint32_t *remaining);
+DLLEXPORT void *trace_get_payload_from_mpls(
+                void *mpls, uint16_t *type, uint32_t *remaining);
 
 /** Gets a pointer to the payload given a pointer to a tcp header