contrib/libpcap/pcap_get_tstamp_precision.3pcap.in

   1 .\"Copyright (c) 2013, Michal Sekletar
   2 .\"All rights reserved.
   3 .\"
   4 .\"Redistribution and use in source and binary forms, with or without
   5 .\"modification, are permitted provided that the following conditions
   6 .\"are met:
   7 .\"
   8 .\"  1. Redistributions of source code must retain the above copyright
   9 .\"     notice, this list of conditions and the following disclaimer.
  10 .\"  2. Redistributions in binary form must reproduce the above copyright
  11 .\"     notice, this list of conditions and the following disclaimer in
  12 .\"     the documentation and/or other materials provided with the
  13 .\"     distribution.
  14 .\"  3. The names of the authors may not be used to endorse or promote
  15 .\"     products derived from this software without specific prior
  16 .\"     written permission.
  17 .\"
  18 .\"THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  19 .\"IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  20 .\"WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  21
  22 .TH PCAP_GET_TSTAMP_PRECISION 3PCAP "18 December 2013"
  23 .SH NAME
  24 pcap_get_tstamp_precision \- get the time stamp precision returned in
  25 captures
  26 .SH SYNOPSIS
  27 .nf
  28 .ft B
  29 #include <pcap/pcap.h>
  30 .ft
  31 .LP
  32 .ft B
  33 int pcap_get_tstamp_precision(pcap_t *p);
  34 .ft
  35 .fi
  36 .SH DESCRIPTION
  37 .B pcap_get_tstamp_precision()
  38 returns the precision of the time stamp returned in packet captures on the pcap
  39 descriptor.
  40 .SH RETURN VALUE
  41 .B pcap_get_tstamp_precision()
  42 returns
  43 .B PCAP_TSTAMP_PRECISION_MICRO
  44 or
  45 .BR PCAP_TSTAMP_PRECISION_NANO ,
  46 which indicates
  47 that pcap captures contains time stamps in microseconds or nanoseconds
  48 respectively.
  49 .SH BACKWARD COMPATIBILITY
  50 This function became available in libpcap release 1.5.1.  In previous
  51 releases, time stamps from a capture device or savefile are always given
  52 in seconds and microseconds.
  53 .SH SEE ALSO
  54 pcap(3PCAP),
  55 pcap_set_tstamp_precision(3PCAP),
  56 pcap-tstamp(@MAN_MISC_INFO@)