timestamp.h File Reference

#include "ws_symbol_export.h"
#include <wsutil/nstime.h>

Go to the source code of this file.

Enumerations
enum	ts_type {   TS_RELATIVE , TS_RELATIVE_CAP , TS_ABSOLUTE , TS_ABSOLUTE_WITH_YMD ,   TS_ABSOLUTE_WITH_YDOY , TS_DELTA , TS_DELTA_DIS , TS_EPOCH ,   TS_UTC , TS_UTC_WITH_YMD , TS_UTC_WITH_YDOY , TS_NOT_SET }
	Format used to display packet timestamps in the summary packet list. More...
enum	ts_precision {   TS_PREC_AUTO = -1 , TS_PREC_FIXED_SEC = WS_TSPREC_SEC , TS_PREC_FIXED_100_MSEC = WS_TSPREC_100_MSEC , TS_PREC_FIXED_10_MSEC = WS_TSPREC_10_MSEC ,   TS_PREC_FIXED_MSEC = WS_TSPREC_MSEC , TS_PREC_FIXED_100_USEC = WS_TSPREC_100_USEC , TS_PREC_FIXED_10_USEC = WS_TSPREC_10_USEC , TS_PREC_FIXED_USEC = WS_TSPREC_USEC ,   TS_PREC_FIXED_100_NSEC = WS_TSPREC_100_NSEC , TS_PREC_FIXED_10_NSEC = WS_TSPREC_10_NSEC , TS_PREC_FIXED_NSEC = WS_TSPREC_NSEC , TS_PREC_NOT_SET = -2 }
	Sub-second precision used when formatting packet timestamps. More...
enum	ts_seconds_type { TS_SECONDS_DEFAULT , TS_SECONDS_HOUR_MIN_SEC , TS_SECONDS_NOT_SET }
	Controls how the seconds component of a timestamp is formatted for display. More...

Functions
WS_DLL_PUBLIC ts_type	timestamp_get_type (void)
	Get the current timestamp type.
WS_DLL_PUBLIC void	timestamp_set_type (ts_type ts_t)
	Set the timestamp type.
WS_DLL_PUBLIC int	timestamp_get_precision (void)
	Get the current timestamp precision.
WS_DLL_PUBLIC void	timestamp_set_precision (int tsp)
	Set the timestamp precision.
WS_DLL_PUBLIC ts_seconds_type	timestamp_get_seconds_type (void)
	Get the current timestamp seconds type.
WS_DLL_PUBLIC void	timestamp_set_seconds_type (ts_seconds_type ts_t)
	Set the timestamp seconds type.

Detailed Description

Defines for packet timestamps

Wireshark - Network traffic analyzer By Gerald Combs geral.nosp@m.d@wi.nosp@m.resha.nosp@m.rk.o.nosp@m.rg Copyright 1998 Gerald Combs

SPDX-License-Identifier: GPL-2.0-or-later

Enumeration Type Documentation

ts_precision

enum ts_precision

Sub-second precision used when formatting packet timestamps.

Enumerator
TS_PREC_AUTO	Use the precision specified by the capture file
TS_PREC_FIXED_SEC	Display timestamps with whole-second precision
TS_PREC_FIXED_100_MSEC	Display timestamps with 100-millisecond precision
TS_PREC_FIXED_10_MSEC	Display timestamps with 10-millisecond precision
TS_PREC_FIXED_MSEC	Display timestamps with millisecond (1 ms) precision
TS_PREC_FIXED_100_USEC	Display timestamps with 100-microsecond precision
TS_PREC_FIXED_10_USEC	Display timestamps with 10-microsecond precision
TS_PREC_FIXED_USEC	Display timestamps with microsecond (1 µs) precision
TS_PREC_FIXED_100_NSEC	Display timestamps with 100-nanosecond precision
TS_PREC_FIXED_10_NSEC	Display timestamps with 10-nanosecond precision
TS_PREC_FIXED_NSEC	Display timestamps with nanosecond (1 ns) precision Sentinel indicating that no precision has been set via the command line

ts_seconds_type

enum ts_seconds_type

Controls how the seconds component of a timestamp is formatted for display.

Enumerator
TS_SECONDS_DEFAULT	Display seconds as a plain decimal value (default/recent preference)
TS_SECONDS_HOUR_MIN_SEC	Display seconds in HH:MM:SS format (recent preference) Sentinel indicating that no seconds format has been set via the command line

ts_type

enum ts_type

Format used to display packet timestamps in the summary packet list.

Enumerator
TS_RELATIVE	Time elapsed since the first captured frame
TS_RELATIVE_CAP	Time elapsed since the start of the capture session
TS_ABSOLUTE	Local wall-clock time, without date
TS_ABSOLUTE_WITH_YMD	Local wall-clock time, with date in YYYY-MM-DD form
TS_ABSOLUTE_WITH_YDOY	Local wall-clock time, with date in YYYY DOY (day-of-year) form
TS_DELTA	Time elapsed since the previous captured packet
TS_DELTA_DIS	Time elapsed since the previous displayed packet
TS_EPOCH	Seconds (and fractional seconds) since the Unix epoch
TS_UTC	UTC absolute time, without date
TS_UTC_WITH_YMD	UTC absolute time, with date in YYYY-MM-DD form
TS_UTC_WITH_YDOY	UTC absolute time, with date in YYYY DOY (day-of-year) form Sentinel indicating that no timestamp format has been set via the command line

Function Documentation

timestamp_get_precision()

WS_DLL_PUBLIC int timestamp_get_precision

(

void

)

Get the current timestamp precision.

Returns

The current timestamp precision.

timestamp_get_seconds_type()

WS_DLL_PUBLIC ts_seconds_type timestamp_get_seconds_type

(

void

)

Get the current timestamp seconds type.

Returns

ts_seconds_type The current timestamp seconds type.

timestamp_get_type()

WS_DLL_PUBLIC ts_type timestamp_get_type

(

void

)

Get the current timestamp type.

Returns

ts_type The current timestamp type.

timestamp_set_precision()

WS_DLL_PUBLIC void timestamp_set_precision

(

int

tsp

)

Set the timestamp precision.

Parameters

tsp	The timestamp precision to set.

timestamp_set_seconds_type()

WS_DLL_PUBLIC void timestamp_set_seconds_type

(

ts_seconds_type

ts_t

)

Set the timestamp seconds type.

Parameters

ts_t	The timestamp seconds type to set.

timestamp_set_type()

WS_DLL_PUBLIC void timestamp_set_type

(

ts_type

ts_t

)

Set the timestamp type.

Parameters

ts_t	The timestamp type to set.