xref: /freebsd/contrib/libpcap/pcap_set_tstamp_precision.3pcap.in (revision e40139ff33b48b56a24c808b166b04b8ee6f5b21)
Copyright (c) 2013, Michal Sekletar
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
3. The names of the authors may not be used to endorse or promote
products derived from this software without specific prior
written permission.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
PCAP_SET_TSTAMP_PRECISION 3PCAP "5 February 2015"
NAME
pcap_set_tstamp_precision - set the time stamp precision returned in captures
SYNOPSIS
#include <pcap/pcap.h>

int pcap_set_tstamp_precision(pcap_t *p, int tstamp_precision);

DESCRIPTION
pcap_set_tstamp_precision() sets the precision of the time stamp desired for packets captured on the pcap descriptor to the type specified by tstamp_precision . It must be called on a pcap descriptor created by pcap_create(3PCAP) that has not yet been activated by pcap_activate(3PCAP) . Two time stamp precisions are supported, microseconds and nanoseconds. One can use options PCAP_TSTAMP_PRECISION_MICRO and PCAP_TSTAMP_PRECISION_NANO to request desired precision. By default, time stamps are in microseconds.
RETURN VALUE
pcap_set_tstamp_precision() returns 0 on success if the specified time stamp precision is expected to be supported by the capture device, PCAP_ERROR_TSTAMP_PRECISION_NOTSUP if the capture device does not support the requested time stamp precision, PCAP_ERROR_ACTIVATED if called on a capture handle that has been activated.
BACKWARD COMPATIBILITY
This function became available in libpcap release 1.5.1. In previous releases, time stamps from a capture device or savefile are always given in seconds and microseconds.
SEE ALSO
pcap(3PCAP), pcap_get_tstamp_precision(3PCAP), pcap-tstamp(@MAN_MISC_INFO@)