Changeset 988e253


Ignore:
Timestamp:
10/01/07 14:16:56 (14 years ago)
Author:
Shane Alcock <salcock@…>
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:
049e277
Parents:
d4a6783
Message:
  • Clarified that trace_get_*_length functions return a value in bytes, also updated trace_set_capture_length docs to say the same thing
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lib/libtrace.h.in

    re696e87 r988e253  
    14241424 * @{
    14251425 */
    1426 /** Get the size of the packet in the trace
     1426/** Get the size of the packet in the trace (in bytes)
    14271427 * @param packet        the packet opaque pointer
    14281428 * @return the size of the packet in the trace
     
    14411441size_t trace_get_capture_length(const libtrace_packet_t *packet);
    14421442
    1443 /** Get the size of the packet as it was seen on the wire.
     1443/** Get the size of the packet as it was seen on the wire (in bytes).
    14441444 * @param packet        the packet opaque pointer
    14451445 * @return the size of the packet as it was on the wire.
     
    14561456size_t trace_get_wire_length(const libtrace_packet_t *packet);
    14571457
    1458 /** Get the length of the capture framing headers.
     1458/** Get the length of the capture framing headers (in bytes).
    14591459 * @param packet        the packet opaque pointer
    14601460 * @return the size of the packet as it was on the wire.
     
    14671467/** Truncate ("snap") the packet at the suggested length
    14681468 * @param packet        the packet opaque pointer
    1469  * @param size          the new length of the packet
     1469 * @param size          the new length of the packet (in bytes)
    14701470 * @return the new capture length of the packet, or the original capture
    14711471 * length of the packet if unchanged
Note: See TracChangeset for help on using the changeset viewer.