Changeset 82b26ab


Ignore:
Timestamp:
08/23/07 11:08:19 (14 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:
9185dcfd
Parents:
708f9ae
Message:

Correct misleading cut and paste documentation
(trace_get_payload_from_* functions all claimed to be dealing with tcp
headers)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lib/libtrace.h.in

    r646aca1 r82b26ab  
    10791079 * @return a pointer to the tcp payload, or NULL if the payload isn't present.
    10801080 *
    1081  * Remaining may be NULL.  If Remaining is not NULL it must point to the number
    1082  * of bytes captured of the TCP header and beyond.  It will be updated after this
    1083  * function to the number of bytes remaining after the TCP header (and any TCP options)
    1084  * have been removed.
    1085  *
    1086  * @note This is similar to trace_get_transport_from_ip in libtrace2
    1087  */
    1088 DLLEXPORT void *trace_get_payload_from_tcp(libtrace_tcp_t *tcp, uint32_t *remaining);
     1081 * Remaining may be NULL.  If remaining is not NULL it must point to the number
     1082 * of bytes captured of the TCP header and beyond.  It will be updated after
     1083 * this function to the number of bytes remaining after the TCP header (and any
     1084 * TCP options) have been removed.
     1085 *
     1086 */
     1087DLLEXPORT void *trace_get_payload_from_tcp(libtrace_tcp_t *tcp,
     1088                uint32_t *remaining);
    10891089
    10901090/** Gets a pointer to the payload given a pointer to a udp header
     
    10951095 *
    10961096 * Remaining may be NULL.  If Remaining is not NULL it must point to the number
    1097  * of bytes captured of the TCP header and beyond.  It will be updated after this
    1098  * function to the number of bytes remaining after the TCP header (and any TCP options)
    1099  * have been removed.
    1100  *
    1101  * @note This is similar trace_get_transport_from_ip in libtrace2
     1097 * of bytes captured of the TCP header and beyond.  It will be updated after
     1098 * this function to the number of bytes remaining after the UDP header.
     1099 *
    11021100 */
    11031101DLLEXPORT void *trace_get_payload_from_udp(libtrace_udp_t *udp, uint32_t *remaining);
     
    11091107 * @return a pointer to the icmp payload, or NULL if the payload isn't present.
    11101108 *
    1111  * Remaining may be NULL.  If Remaining is not NULL it must point to the number
    1112  * of bytes captured of the TCP header and beyond.  It will be updated after this
    1113  * function to the number of bytes remaining after the TCP header (and any TCP options)
    1114  * have been removed.
    1115  *
    1116  * @note This is similar to trace_get_payload_from_icmp in libtrace2
    1117  */
    1118 DLLEXPORT void *trace_get_payload_from_icmp(libtrace_icmp_t *icmp, uint32_t *remaining);
     1109 * Remaining may be NULL.  If remaining is not NULL it must point to the number
     1110 * of bytes captured of the ICMP header and beyond.  It will be updated after
     1111 * this function to the number of bytes remaining after the ICMP header.
     1112 *
     1113 */
     1114DLLEXPORT void *trace_get_payload_from_icmp(libtrace_icmp_t *icmp,
     1115                uint32_t *remaining);
    11191116
    11201117/** get a pointer to the TCP header (if any)
Note: See TracChangeset for help on using the changeset viewer.