This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.
ToDump Element Documentation
NAME
ToDump -- Click element; writes packets to a tcpdump file
SYNOPSIS
ToDump(FILENAME [, keywords SNAPLEN, ENCAP, USE_ENCAP_FROM, EXTRA_LENGTH])
Ports: 1 input, at most 1 output
Processing: agnostic
Drivers: userlevel, ns
Package: userlevel (core)
DESCRIPTION
Writes incoming packets to FILENAME in `tcpdump -w' format. This file can be read by `tcpdump -r', or by FromDump on a later run. FILENAME can be `-', in which case ToDump writes to the standard output. Writes at most SNAPLEN bytes of each packet to the file. The default SNAPLEN is 2000. If SNAPLEN is 0, the whole packet will be written to the file. ENCAP specifies the first header each packet is expected to have. This information is stored in the file header, and must be correct or tcpdump won't be able to read the file correctly. It can be ETHER (Ethernet encapsulation), IP (raw IP packets), FDDI, ATM, 802_11, SLL, AIRONET, HDLC, PPP_HDLC, PPP, SUNATM, PRISM, or NULL; the default is ETHER. ToDump may have zero or one output. If it has an output, then it emits all received packets on that output. ToDump will schedule itself on the task list if it is used as a pull element with no outputs. Keyword arguments are:
- SNAPLEN
- Integer. See above.
- ENCAP
- The encapsulation type to store in the dump. See above.
- USE_ENCAP_FROM
- Argument is a space-separated list of element names. At initialization time, ToDump will check these elements' `encap' handlers, and parse them as ENCAP arguments. If all the handlers agree, ToDump will use that encapsulation type; otherwise, it will report an error. You can specify at most one of ENCAP and USE_ENCAP_FROM. FromDump and FromDevice.u have `encap' handlers.
- EXTRA_LENGTH
- Boolean. Set to true if you want ToDump to store any extra length as recorded in packets' extra length annotations. Default is true. This element is only available at user level.
NOTES
ToDump stores packets' true length annotations when available.
ELEMENT HANDLERS
- count (read-only)
- Returns the number of packets emitted so far.
- reset_counts (write-only)
- Resets "count" to 0.
- filename (read-only)
- Returns the filename.
SEE ALSO
FromDump, FromDevice.u, ToDevice.u, tcpdump(1)
Generated by 'click-elem2man' from '../elements/userlevel/todump.hh' on 24/May/2007.
