Changeset a700713 for lib

Timestamp:

05/29/06 15:06:47 (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:

889ddc3

Parents:

c2cb712

Message:

Add documentation to new function

File:

• lib/libtrace.h.in (modified) (1 diff)

lib/libtrace.h.in

@@ -793 +793 @@
                 uint32_t *remaining);
 
+
+/** Gets a pointer to the payload given a pointer to the IP header
+ * @param ip            The link pointer
+ * @param[out] type     An output variable of the ethernet type
+ * @param[in,out] remaining Updated with the number of bytes remaining
+ *
+ * @return a pointer to the transport layer header, or NULL if header isn't
+ * present.
+ *
+ * Remaining may be NULL.  If Remaining is not NULL it must point to the number
+ * of bytes captured of the linklayer and beyond.  It will be updated after
+ * this function to the number of bytes remaining after the IP header (and any
+ * IP options) have been removed.
+ *
+ * type may be NULL if not needed.
+ */
 DLLEXPORT void *trace_get_payload_from_link(void *link,
                 libtrace_linktype_t linktype,