Changeset 5745e78 for lib


Ignore:
Timestamp:
04/03/09 11:17:56 (12 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:
af0918a
Parents:
5865c72
Message:

Start trying to flesh out the documentation a bit more to explain our idea of how packets are
layered.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lib/libtrace.h.in

    r45b7073 r5745e78  
    10201020 * These functions locate and return a pointer to various headers inside a
    10211021 * packet
     1022 *
     1023 * A packet is divided up into several "layers.":
     1024 *
     1025 * @li Framing header -- This is the header in a tracefile, or as captured from the network.
     1026 * generally this includes capture lengths, wire lengths, timestamps, direction information and
     1027 * any other metadata that is part of the capture format. 
     1028 *
     1029 * @li Metadata header (optional) -- A header that was captured, but was not transmitted over
     1030 * the wire.  Some examples include RadioTap and Linux_sll headers.  This can be retrieved by
     1031 * trace_get_packet_meta(), or skipped using trace_get_payload_from_meta().
     1032 *
     1033 * @li Layer 2/Link layer/Datalink header -- This can be retrieved by trace_get_layer2(), or
     1034 * skipped using trace_get_payload_from_layer2().
     1035 *
     1036 * @li Layer 3/IP/IPv6 -- This can be retrieved by trace_get_layer3().  As a convenience
     1037 * trace_get_ip()/trace_get_ip6() can be used to find an IPv4/IPv6 header.
     1038 *
     1039 * @li Layer 5/transport -- These are protocols carried in IPv4/IPv6 frames.  These can be
     1040 * retrieved using trace_get_transport().
     1041 *
    10221042 * @{
    10231043 */
     
    14711491 *                      static storage.
    14721492 * @return NULL if there is no source address, or a sockaddr holding a v4 or v6
    1473  * address
     1493 * address, or on some platforms a sockaddr holding a MAC address.
    14741494 */
    14751495DLLEXPORT SIMPLE_FUNCTION
     
    14821502 *                      static storage.
    14831503 * @return NULL if there is no destination address, or a sockaddr holding a v4
    1484  * or v6 address
     1504 * or v6 address, or on some platforms a sockaddr holding a MAC address.
    14851505 */
    14861506DLLEXPORT SIMPLE_FUNCTION
Note: See TracChangeset for help on using the changeset viewer.