TimeFilter Element Documentation

TimeFilter -- Click element; filter packets by timestamp

TimeFilter(keywords START, START_AFTER, START_DELAY, END, END_AFTER, END_DELAY, INTERVAL, STOP, END_CALL)

Ports: 1 input, 1-2 outputs
Processing: agnostic, but output 1 is push
Package: analysis (core)

TimeFilter passes packets through only if they lie within a timestamp range. You can specify that range absolutely or relative to the first timestamp TimeFilter sees. Keyword arguments are:

START

T is absolute time in seconds since the epoch. Output packets with timestamps at least T.

START_AFTER

T is relative time in seconds (or use suffixes like `ms', `hr'). Output packets with timestamps at least T seconds after the first packet seen.

START_DELAY

T is relative time. Output packets with timestamps at least T seconds after initialize time.

END

T is absolute time. Output packets with timestamps up to T.

END_AFTER

T is relative time. Output packets with timestamps up to T seconds after the first packet seen.

END_DELAY

T is relative time. Output packets with timestamps up to T seconds after initialize time.

INTERVAL

T is relative time. Output packets for T seconds after the start time, as specified by START or START_AFTER.

STOP

Boolean. If true, stop the driver once the end time is exceeded. Default is false.

END_CALL

Specifies a write handler to call when the first packet after END is seen. STOP and END_CALL are mutually exclusive. Supply at most one of START, START_AFTER, and START_DELAY, and at most one of END, END_AFTER, END_DELAY, and INTERVAL.

SetTimestamp

Generated by 'click-elem2man' from '../elements/analysis/timefilter.hh' on 24/May/2007.