This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.

ICMPPingSource Element Documentation

NAME

ICMPPingSource -- Click element; periodically sends ICMP echo requests

SYNOPSIS

ICMPPingSource(SRC, DST [, keywords INTERVAL, IDENTIFIER, LIMIT, DATA, ACTIVE])

Ports: at most 1 input, 1 output
Package: icmp (core)

DESCRIPTION

Periodically emits ping packets with source IP address SRC and destination address DST. Advances the "sequence" field by one each time. (The sequence field is stored in network byte order in the packet.) When its output is pull, generates a ping packet on every pull. ICMPPingSource's optional input accepts replies to the pings it sends. If you send replies to this input, ICMPPingSource will print reply reports and keep loss and RTT statistics like the ping(1) program. You can access those stistics with the "summary" handler. Keyword arguments are:

INTERVAL
Amount of time between pings, in seconds. Default is 1.
IDENTIFIER
Integer. Determines the ICMP identifier field in emitted pings. Default is 0.
LIMIT
Integer. The number of pings to send; but if LIMIT is negative, sends pings forever. Default is -1.
DATA
String. Extra data in emitted pings. Default is the empty string (nothing).
ACTIVE
Boolean. Whether ICMPPingSource is active. Default is true.
VERBOSE
Boolean. Whether ICMPPingSource should print reports when echo replies arrive. Default is true.

ELEMENT HANDLERS

active (read/write)
Returns or sets the ACTIVE argument.
count (read-only)
Reports the number of packets sent so far.
limit (write-only)
Sets the LIMIT argument.
interval (write-only)
Sets the INTERVAL argument.
reset_counts (write-only)
Resets all counters to zero.
src (read/write)
Returns or sets the SRC argument.
dst (read/write)
Returns or sets the DST argument.
summary (read-only)
Returns ping(1)-style summary information: number of packets sent and received, loss rate, and RTT statistics. Only available if ICMPPingSource had an input.
rtt_min (read-only)
Returns the minimum RTT observed, or 0 if no RTTs have been observed. Only available if ICMPPingSource had an input.
rtt_max (read-only)
Returns the maximum RTT observed, or 0 if no RTTs have been observed. Only available if ICMPPingSource had an input.
rtt_avg (read-only)
Returns the average RTT observed, or 0 if no RTTs have been observed. Only available if ICMPPingSource had an input.

SEE ALSO

ICMPPingEncap, ICMPPingResponder, ICMPPingRewriter

Generated by 'click-elem2man' from '../elements/icmp/icmpsendpings.hh' on 7/Mar/2009.

COMMENTS

 
elements/icmppingsource.txt · Last modified: 2009/03/07 17:24 (external edit)
 
Recent changes RSS feed Driven by DokuWiki