Changeset 850630f


Ignore:
Timestamp:
02/16/05 17:36:52 (16 years ago)
Author:
Daniel Lawson <dlawson@…>
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:
fb1de29
Parents:
1cea750
Message:

updates for doxygen

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lib/trace.c

    r1cea750 r850630f  
    798798
    799799/** get a pointer to the link layer
    800  * @param libtrace      a pointer to the trace object returned from gettrace
    801  * @param buffer        a pointer to a filled in buffer
    802  * @param buflen        a pointer to the size of the buffer
     800 * @param packet        a pointer to a libtrace_packet structure
    803801 *
    804802 * @returns a pointer to the link layer, or NULL if there is no link layer
     
    848846
    849847/** get a pointer to the IP header (if any)
    850  * @param libtrace      a pointer to the trace object returned from gettrace
    851  * @param buffer        a pointer to a filled in buffer
    852  * @param buflen        a pointer to the size of the buffer
     848 * @param packet        a pointer to a libtrace_packet structure
    853849 *
    854850 * @returns a pointer to the IP header, or NULL if there is not an IP packet
     
    912908
    913909/** get a pointer to the TCP header (if any)
    914  * @param libtrace      a pointer to the trace object returned from gettrace
    915  * @param buffer        a pointer to a filled in buffer
    916  * @param buflen        a pointer to the size of the buffer
     910 * @param packet        a pointer to a libtrace_packet structure
    917911 *
    918912 * @returns a pointer to the TCP header, or NULL if there is not a TCP packet
     
    932926
    933927/** get a pointer to the UDP header (if any)
    934  * @param libtrace      a pointer to the trace object returned from gettrace
    935  * @param buffer        a pointer to a filled in buffer
    936  * @param buflen        a pointer to the size of the buffer
     928 * @param packet        a pointer to a libtrace_packet structure
    937929 *
    938930 * @returns a pointer to the UDP header, or NULL if this is not a UDP packet
     
    952944
    953945/** get a pointer to the ICMP header (if any)
    954  * @param libtrace      a pointer to the trace object returned from gettrace
    955  * @param buffer        a pointer to a filled in buffer
    956  * @param buflen        a pointer to the size of the buffer
     946 * @param packet        a pointer to a libtrace_packet structure
    957947 *
    958948 * @returns a pointer to the ICMP header, or NULL if this is not a ICMP packet
     
    972962
    973963/** Get the current time in DAG time format
    974  * @param libtrace the libtrace opaque pointer
    975  * @param buffer a pointer to a filled in buffer
    976  * @param buflen the length of the buffer
     964 * @param packet        a pointer to a libtrace_packet structure
    977965 * @returns a 64 bit timestamp in DAG ERF format (upper 32 bits are the seconds
    978966 * past 1970-01-01, the lower 32bits are partial seconds)
     
    10151003
    10161004/** Get the current time in struct timeval
    1017  * @param libtrace the libtrace opaque pointer
    1018  * @param buffer a pointer to a filled in buffer
    1019  * @param buflen the length of the buffer
     1005 * @param packet        a pointer to a libtrace_packet structure
     1006 *
    10201007 * @returns time that this packet was seen in a struct timeval
    10211008 * @author Daniel Lawson
     
    10591046
    10601047/** Get the current time in floating point seconds
    1061  * @param libtrace the libtrace opaque pointer
    1062  * @param buffer a pointer to a filled in buffer
    1063  * @param buflen the length of the buffer
     1048 * @param packet        a pointer to a libtrace_packet structure
    10641049 * @returns time that this packet was seen in 64bit floating point seconds
    10651050 * @author Perry Lorier
     
    11201105       
    11211106/** Get the size of the packet as it was seen on the wire.
    1122  * @param libtrace the libtrace opaque pointer
    1123  * @param buffer a pointer to a filled in buffer
    1124  * @param buflen the length of the buffer
     1107 * @param packet        a pointer to a libtrace_packet structure
     1108 *
    11251109 * @returns the size of the packet as it was on the wire.
    11261110 * @author Perry Lorier
     
    11641148
    11651149/** Get the type of the link layer
    1166  * @param libtrace the libtrace opaque pointer
    1167  * @param buffer a pointer to a filled in buffer
    1168  * @param buflen the length of the buffer
     1150 * @param packet        a pointer to a libtrace_packet structure
    11691151 * @returns libtrace_linktype_t
    11701152 * @author Perry Lorier
     
    12131195
    12141196/** Get the source MAC addres
    1215  * @param libtrace the libtrace opaque pointer
    1216  * @param buffer a pointer to a filled in buffer
    1217  * @param buflen the length of the buffer
     1197 * @param packet        a pointer to a libtrace_packet structure
    12181198 * @returns a pointer to the source mac, (or NULL if there is no source MAC)
    12191199 * @author Perry Lorier
     
    12371217
    12381218/** Get the destination MAC addres
    1239  * @param libtrace the libtrace opaque pointer
    1240  * @param buffer a pointer to a filled in buffer
    1241  * @param buflen the length of the buffer
     1219 * @param packet a libtrace_packet pointer
    12421220 * @returns a pointer to the destination mac, (or NULL if there is no
    12431221 * destination MAC)
     
    12651243 * @param trace the libtrace opaque pointer
    12661244 * @param packet the libtrace_packet opaque pointer
    1267  * @param fd a pointer to a file descriptor to listen on
    1268  * @param seconds a pointer the time in seconds since to the next event
    12691245 * @returns
    12701246 *  TRACE_EVENT_IOWAIT  Waiting on I/O on <fd>
     
    13811357
    13821358/** apply a BPF filter
    1383  * @param libtrace the libtrace opaque pointer
    13841359 * @param filter the filter opaque pointer
    1385  * @param buffer a pointer to a filled buffer
    1386  * @param buflen the length of the buffer
     1360 * @param packet the packet opaque pointer
    13871361 * @returns 0 if the filter fails, 1 if it succeeds
    13881362 * @author Daniel Lawson
     
    14591433
    14601434/** Get the direction flag, if it has one
    1461  * @param libtrace the libtrace opaque pointer
    1462  * @param buffer a point to a fille in buffer
    1463  * @param buflen the length of the buffer
     1435 * @param packet a pointer to a libtrace_packet structure
    14641436 * @returns a signed value containing the direction flag, or -1 if this is not supported
    14651437 * @author Daniel Lawson
     
    16051577/** Truncate the packet at the suggested length
    16061578 * @param packet        the packet opaque pointer
    1607  * @param len           the new length of the packet
     1579 * @param size          the new length of the packet
    16081580 * @returns the new length of the packet, or the original length of the
    16091581 * packet if unchanged
Note: See TracChangeset for help on using the changeset viewer.