Changeset a700713


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

Legend:

Unmodified
Added
Removed
  • lib/libtrace.h.in

    rc2cb712 ra700713  
    793793                uint32_t *remaining);
    794794
     795
     796/** Gets a pointer to the payload given a pointer to the IP header
     797 * @param ip            The link pointer
     798 * @param[out] type     An output variable of the ethernet type
     799 * @param[in,out] remaining Updated with the number of bytes remaining
     800 *
     801 * @return a pointer to the transport layer header, or NULL if header isn't
     802 * present.
     803 *
     804 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
     805 * of bytes captured of the linklayer and beyond.  It will be updated after
     806 * this function to the number of bytes remaining after the IP header (and any
     807 * IP options) have been removed.
     808 *
     809 * type may be NULL if not needed.
     810 */
    795811DLLEXPORT void *trace_get_payload_from_link(void *link,
    796812                libtrace_linktype_t linktype,
Note: See TracChangeset for help on using the changeset viewer.