freebsd-dev/contrib/libpcap/pcap_set_tstamp_precision.3pcap.in

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

67 lines
2.4 KiB
Plaintext
Raw Normal View History

2015-01-06 18:58:31 +00:00
.\"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.
2017-02-12 07:04:44 +00:00
.TH PCAP_SET_TSTAMP_PRECISION 3PCAP "5 February 2015"
2015-01-06 18:58:31 +00:00
.SH NAME
pcap_set_tstamp_precision \- set the time stamp precision returned in
captures
.SH SYNOPSIS
.nf
.ft B
#include <pcap/pcap.h>
.ft
.LP
.ft B
int pcap_set_tstamp_precision(pcap_t *p, int tstamp_precision);
.ft
.fi
.SH DESCRIPTION
.B pcap_set_tstamp_precision()
sets the precision of the time stamp desired for packets captured on the pcap
descriptor to the type specified by
.IR tstamp_precision .
It must be called on a pcap descriptor created by
2019-10-06 04:26:37 +00:00
.B pcap_create(3PCAP)
2015-01-06 18:58:31 +00:00
that has not yet been activated by
2019-10-06 04:26:37 +00:00
.BR pcap_activate(3PCAP) .
2015-01-06 18:58:31 +00:00
Two time stamp precisions are supported, microseconds and nanoseconds. One can
use options
.B PCAP_TSTAMP_PRECISION_MICRO and
.B PCAP_TSTAMP_PRECISION_NANO
to request desired precision. By default, time stamps are in microseconds.
.SH RETURN VALUE
2017-02-12 07:04:44 +00:00
.B pcap_set_tstamp_precision()
2015-01-06 18:58:31 +00:00
returns 0 on success if the specified time stamp precision is expected to be
2019-10-06 04:26:37 +00:00
supported by the capture device,
2015-01-06 18:58:31 +00:00
.B PCAP_ERROR_TSTAMP_PRECISION_NOTSUP
2019-10-06 04:26:37 +00:00
if the capture device does not support the requested time stamp
precision,
2015-01-06 18:58:31 +00:00
.B PCAP_ERROR_ACTIVATED
if called on a capture handle that has been activated.
2019-10-06 04:26:37 +00:00
.SH 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.
2015-01-06 18:58:31 +00:00
.SH SEE ALSO
pcap(3PCAP),
pcap_get_tstamp_precision(3PCAP),
pcap-tstamp(@MAN_MISC_INFO@)