Warning: filemtime() [function.filemtime]: stat failed for /home/www/click-dokuwiki/data/pages/elements/elements-clickpackagename.txt in /home/www/click-dokuwiki/feed.php on line 203
http://www.read.cs.ucla.edu/click/ 2009-11-20T23:25:40-08:00 http://www.read.cs.ucla.edu/click/ http://www.read.cs.ucla.edu/click/lib/images/favicon.ico text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/ackresponder?rev=1140460872 This is automatically generated documentation. NAME ACKResponder -- Click element; Send positive acknowledgements to unicast data packets. SYNOPSIS ACKResponder(ETH) Ports: 1 input, 2 outputs Processing: agnostic, but output 1 is push Package: grid (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ackresponder2?rev=1236475441 This is automatically generated documentation. NAME ACKResponder2 -- Click element; Send positive acknowledgements to unicast data packets. SYNOPSIS ACKResponder2(IP) Ports: 1 input, 2 outputs Processing: agnostic, but output 1 is push Package: grid (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/ackretrysender?rev=1179990969 This is automatically generated documentation. NAME ACKRetrySender -- Click element; Resend packets until a positive acknowledgement is received. SYNOPSIS ACKRetrySender(KEYWORDS) Ports: any number of inputs, any number of outputs Package: grid (core) <dl> <dt> </dt> <dd> Unsigned integer, &gt; 0. Send the packet up to this many timesbefore giving up. Default is 16. This includes the initialtransmission.</dd> </dl> <dl> <dt> </dt> <dd> Unsigned integer, &gt; 0. Milliseconds. Wait… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/ackretrysender2?rev=1179990969 This is automatically generated documentation. NAME ACKRetrySender2 -- Click element; Resend packets until a positive acknowledgement is received. SYNOPSIS ACKRetrySender2(KEYWORDS) Ports: any number of inputs, any number of outputs Package: grid (core) <dl> <dt> </dt> <dd> This node's IP address. Required argument.</dd> </dl> <dl> <dt> </dt> <dd> Unsigned integer, &gt; 0. Send the packet up to this many timesbefore giving up. Default is 16. This includes the initialtransmission.<… text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/adaptivered?rev=1190150828 This is automatically generated documentation. NAME AdaptiveRED -- Click element; drops packets according to Adaptive RED SYNOPSIS AdaptiveRED(TARGET, MAX_P [, KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: aqm (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/addressinfo?rev=1236475442 This is automatically generated documentation. NAME AddressInfo -- Click element; specifies address information SYNOPSIS AddressInfo(NAME ADDRESS [ADDRESS...], ...) Ports: None Package: standard (core) DESCRIPTION Lets you use mnemonic names for IPv4 and IPv6 addresses, IPv4 and IPv6 address prefixes, and Ethernet addresses. Each argument has the form `NAME ADDRESS [ADDRESS...]', which associates the given ADDRESSes with NAME. For example, if a configuration contains this AddressInf… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/addresstranslator?rev=1236475441 This is automatically generated documentation. NAME AddressTranslator -- Click element; translates IPv6/ICMPv6, TCP, and UDP packets' addresses and ports SYNOPSIS AddressTranslator(number_of_static_Mapping, StaticPortMapping,N<> StaticMapping1,...N<> StaticMappingm,N<> DynamicMapping,N<> DynamicPortMapping,N<> AddressAllocationDirection,N<> Mapped_IP6Address Port_s… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/aggregatecounter?rev=1179990969 This is automatically generated documentation. NAME AggregateCounter -- Click element; counts packets per aggregate annotation SYNOPSIS AggregateCounter([KEYWORDS]) Ports: 1-2 inputs, 1-2 outputs Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Boolean. If true, then count bytes, not packets. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If true, then do not count bytes from the link header. Default isfalse.</dd> </dl> <dl> <dt> <… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/aggregatefilter?rev=1140460874 This is automatically generated documentation. NAME AggregateFilter -- Click element; filters packets based on aggregate annotation SYNOPSIS AggregateFilter(ACTION_1 AGGREGATES, ..., ACTION_N AGGREGATES) Ports: 1 input, 1-254 outputs Processing: push Drivers: userlevel Package: analysis (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/aggregatefirst?rev=1179990969 This is automatically generated documentation. NAME AggregateFirst -- Click element; lets through first packet per aggregate annotation SYNOPSIS AggregateFirst([KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> The name of an AggregateNotifier element, like . If given,then AggregateFirst will prune information about old aggregates. This can savesignificant memory on long traces.</dd> </… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/aggregateip?rev=1179990969 This is automatically generated documentation. NAME AggregateIP -- Click element; sets aggregate annotation based on IP packet field SYNOPSIS AggregateIP(FIELD, KEYWORDS) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> The LENGTH bytes starting at byte OFFSET.</dd> </dl> <dl> <dt> </dt> <dd> From byte OFFSET1 to byte OFFSET2, inclusive.</dd> </dl> <dl> <dt> </dt> <dd> The single byte at OFFSET… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/aggregateipaddrpair?rev=1236475442 This is automatically generated documentation. NAME AggregateIPAddrPair -- Click element; sets aggregate annotation based on IP source/destination address pair SYNOPSIS AggregateIPAddrPair(KEYWORDS) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> The timeout for active address pairs, in seconds. Default is no timeout(address pairs never expire). If a timeout is specified, then informationabout… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/aggregateipflows?rev=1236475442 This is automatically generated documentation. NAME AggregateIPFlows -- Click element; sets aggregate annotation based on flow SYNOPSIS AggregateIPFlows([KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: analysis (core) <dl> <dt> </dt> <dd> Filename. If provided, output information about each flow to that filename inan XML format. Only available at userlevel.</dd> </dl> <dl> <dt> </dt> <dd> Element. If provided, the results of that element's … text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/aggregatelast?rev=1179990969 This is automatically generated documentation. NAME AggregateLast -- Click element; lets through last packet per aggregate annotation SYNOPSIS AggregateLast([KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: push Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> The name of an AggregateNotifier element, like . If given,then AggregateLast will output a packet when the AggregateNotifier informs itthat the packet's aggregate is complete. This can save significant memor… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/aggregatelength?rev=1179990969 This is automatically generated documentation. NAME AggregateLength -- Click element; sets aggregate annotation based on packet length SYNOPSIS AggregateLength(KEYWORDS) Ports: 1 input, 1 output Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Boolean. If true, then only include length starting at the IP header. Defaultis false.</dd> </dl> text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/aggregatepacketcounter?rev=1236475442 This is automatically generated documentation. NAME AggregatePacketCounter -- Click element; counts packets per packet number and aggregate annotation SYNOPSIS AggregatePacketCounter([keywords PACKETNO]) Ports: 1 or more inputs, 1 or more outputs Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Annotation name. Defines which packet number annotation to examine. Normalchoices are PACKET_NUMBER, SEQUENCE_NUMBER, or NONE (do not examine anyannota… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/aggregatepaint?rev=1190150829 This is automatically generated documentation. NAME AggregatePaint -- Click element; sets aggregate annotation based on paint annotation SYNOPSIS AggregatePaint([BITS, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Boolean. If true, then incrementally update the aggregate annotation: given apaint annotation with value V, and an old aggregate annotation of O, the newaggregate annotation will equal (O * 2^LEN… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/airoinfo?rev=1236475441 This is automatically generated documentation. NAME AiroInfo -- Click element; SYNOPSIS AiroInfo(DEVNAME) Ports: none Drivers: userlevel Package: grid (core) DESCRIPTION This element supplies the Aironet card's statistics and information to other elements. This element requires a BSD kernel with an Aironet driver that is modified to support the required ioctls. OR, this element will work under linux using the Wireless Extensions, but the wireless card driver will still need to be … text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/align?rev=1140460876 This is automatically generated documentation. NAME Align -- Click element; aligns packet data SYNOPSIS Align(MODULUS, OFFSET) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Aligns packet data. Each input packet is aligned so that its first byte is OFFSET bytes off from a MODULUS-byte boundary. This may involve a packet copy. MODULUS must be 2, 4, or 8. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/alignmentinfo?rev=1140460876 This is automatically generated documentation. NAME AlignmentInfo -- Click element; specifies alignment information SYNOPSIS AlignmentInfo(ELEMENT [MODULUS OFFSET ...], ...) Ports: None Package: standard (core) DESCRIPTION Provides information about the packet alignment specified elements can expect. Each configuration argument has the form `ELEMENT [MODULUS0 OFFSET0 MODULUS1 OFFSET1 ...]', where there are zero or more MODULUS-OFFSET pairs. All packets arriving at ELEMENT's nth inpu… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/annotationinfo?rev=1236475441 This is automatically generated documentation. NAME AnnotationInfo -- Click element; Define names for packet annotations. SYNOPSIS AnnotationInfo(NAME OFFSET SIZE, ... [keyword CHECK_OVERLAP ANNO...]) Ports: none Package: standard (core) DESCRIPTION Defines new mnemonic names for packet annotations. Each argument has the form "NAME OFFSET [SIZE]", which defines NAME as an annotation starting at byte offset OFFSET and with byte size SIZE. The CHECK_OVERLAP argument lets you check wh… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/anonymizeipaddr?rev=1179990969 This is automatically generated documentation. NAME AnonymizeIPAddr -- Click element; anonymizes top-level IP addresses in passing packets SYNOPSIS AnonymizeIPAddr Ports: 1 input, 1-2 outputs Processing: agnostic Package: analysis (core) DESCRIPTION AnonymizeIPAddr anonymizes the source and destination IP addresses in passing IPv4 packets. (Packets must have IP header annotations.) The anonymization transformation is prefix-preserving: If two input addresses shared the same p-bit … text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/arpfaker?rev=1190150829 This is automatically generated documentation. NAME ARPFaker -- Click element; periodically generates an ARP reply SYNOPSIS ARPFaker(DSTIP, DSTETH, SRCIP, SRCETH) Ports: no inputs, 1 output Processing: push Package: ethernet (core) DESCRIPTION Every 10 seconds, sends an ARP "reply" packet to DSTIP/DSTETH claiming that SRCIP has ethernet address SRCETH. Generates the ethernet header as well as the ARP header. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/arpprint?rev=1236475442 This is automatically generated documentation. NAME ARPPrint -- Click element; pretty-prints ARP packets a la tcpdump SYNOPSIS ARPPrint([TAG, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: ethernet (core) DESCRIPTION Expects ARP packets as input. Prints out ARP packets in a human-readable tcpdump-like format, preceded by the TAG text. Keyword arguments are: <dl> <dt> </dt> <dd> Boolean. Determines whether to print each packet's timestamp in seconds since1970. De… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/arpquerier?rev=1236475441 This is automatically generated documentation. NAME ARPQuerier -- Click element; encapsulates IP packets in Ethernet headers found via ARP SYNOPSIS ARPQuerier(IP, ETH, keywords) ARPQuerier(NAME, keywords) Ports: 2 inputs, 1-2 outputs Processing: push Package: ethernet (core) <dl> <dt> </dt> <dd> Element. Names an element that holds this element's correspondingARP state. By default ARPQuerier creates its own internal and usesthat. If TABLE is specified, CAPACITY, ENTRY_CAPACITY,… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/arpresponder?rev=1236475442 This is automatically generated documentation. NAME ARPResponder -- Click element; generates responses to ARP queries SYNOPSIS ARPResponder(IP/MASK1 [IP/MASK...] ETH1, IP/MASK2 ETH2, ...) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ethernet (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/arptable?rev=1236475442 This is automatically generated documentation. NAME ARPTable -- Click element; stores IP-to-Ethernet mappings SYNOPSIS ARPTable(keywords) Ports: none Package: ethernet (core) DESCRIPTION The ARPTable element stores IP-to-Ethernet mappings, such as are useful for the ARP protocol. ARPTable is an information element, with no inputs or outputs. ARPQuerier normally encapsulates access to an ARPTable element. A separate ARPTable is useful if several ARPQuerier elements should share a … text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/associationrequester?rev=1179990969 This is automatically generated documentation. NAME AssociationRequester -- Click element; Sends 802.11 association requests when poked. SYNOPSIS AssociationRequester Ports: 1 input, 1 output Processing: push Package: wifi (core) DESCRIPTION ELEMENT HANDLERS <dl> <dt> bssid (read/write)</dt> <dd> The bssid to associate to</dd> </dl> <dl> <dt> eth (read/write)</dt> <dd> The station's ethernet address</dd> </dl> <dl> <dt> ssid (read/write)</dt> <dd> The ssid to associate to</d… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/associationresponder?rev=1236475441 This is automatically generated documentation. NAME AssociationResponder -- Click element; Respond to 802.11 association requests. SYNOPSIS AssociationResponder([, KEYWORDS]) Ports: 1 input, 1 output Processing: push Package: wifi (core) DESCRIPTION Keyword arguments are: <dl> <dt> </dt> <dd> The wireless channel it is operating on.</dd> </dl> <dl> <dt> </dt> <dd> The SSID of the access point.</dd> </dl> <dl> <dt> </dt> <dd> An Ethernet Address (usually the same as the ethernet … text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/athdescdecap?rev=1140460875 This is automatically generated documentation. NAME AthdescDecap -- Click element; Pulls the click_wifi_athdesc header from a packet and stores it in Packet::anno() SYNOPSIS AthdescDecap() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/athdescencap?rev=1140460876 This is automatically generated documentation. NAME AthdescEncap -- Click element; Pushes the click_wifi_radiotap header on a packet based on information in Packet::anno() SYNOPSIS AthdescEncap() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/autoratefallback?rev=1236475442 This is automatically generated documentation. NAME AutoRateFallback -- Click element; ARF wireless bit-rate selection algorithm SYNOPSIS AutoRateFallback([, KEYWORDS]) Ports: 2 inputs, at most 2 outputs Package: wifi (core) DESCRIPTION AutoRateFallback is based on the algorithm presented in "WaveLAN-II: A High-Performance Wireless LAN for the Unliscensed Band" by Ad Kamerman and Leo Monteban Automatically determine the txrate for a give ethernet address. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/availablerates?rev=1236475441 This is automatically generated documentation. NAME AvailableRates -- Click element; Tracks bit-rate capabilities of other stations. SYNOPSIS AvailableRates() Ports: none Package: wifi (core) DESCRIPTION Tracks a list of bitrates other stations are capable of. <dl> <dt> </dt> <dd> Inserts an ethernet address and a list of bitrates to the database.</dd> </dl> <dl> <dt> </dt> <dd> Removes an ethernet address from the database.</dd> </dl> <dl> <dt> </dt> <dd> Shows the entries in the… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/averagecounter?rev=1236475441 This is automatically generated documentation. NAME AverageCounter -- Click element; measures historical packet count and rate SYNOPSIS AverageCounter([IGNORE]) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Passes packets unchanged from its input to its output, maintaining statistics information about packet count and packet rate using a strict average. The rate covers only the time between the first and most recent packets. IGNORE, by default,… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/balancedthreadsched?rev=1236475441 This is automatically generated documentation. NAME BalancedThreadSched -- Click element; bin packing scheduler SYNOPSIS BalancedThreadSched([INTERVAL, INCREASING]) Ports: none Package: threads DESCRIPTION Bin pack tasks onto threads by minimizing variance in load. INTERVAL specifies the number of ms between each load balance. By default it is 1000 (1 second). If INCREASING is true, first sort tasks in increasing order based on cost, then binpack. Otherwise, tasks are decreasingly s… text/html 2007-05-24T00:09:20-08:00 http://www.read.cs.ucla.edu/click/elements/bandwidthmeter?rev=1179990560 This is automatically generated documentation. NAME BandwidthMeter -- Click element; classifies packet stream by arrival rate SYNOPSIS BandwidthMeter(RATE1, RATE2, ..., RATEn) Ports: 1 input, 2 or more outputs Processing: push Package: standard (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/bandwidthratedsplitter?rev=1179990969 This is automatically generated documentation. NAME BandwidthRatedSplitter -- Click element; splits flow of packets at specified bandwidth rate SYNOPSIS BandwidthRatedSplitter(RATE) Ports: 1 input, 2 outputs Processing: Push Package: standard (core) <dl> <dt> </dt> <dd> rate of splitting</dd> </dl> text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/bandwidthratedunqueue?rev=1140460875 This is automatically generated documentation. NAME BandwidthRatedUnqueue -- Click element; pull-to-push converter SYNOPSIS BandwidthRatedUnqueue(RATE) Ports: 1 input, 1 output Processing: Pull inputs, push outputs Package: standard (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/bandwidthshaper?rev=1236475442 This is automatically generated documentation. NAME BandwidthShaper -- Click element; shapes traffic to maximum rate (bytes/s) SYNOPSIS BandwidthShaper(RATE) Ports: 1 input, 1 output Processing: Pull Package: standard (core) DESCRIPTION BandwidthShaper is a pull element that allows a maximum bandwidth of RATE to pass through. That is, output traffic is shaped to RATE. If a BandwidthShaper receives a large number of evenly-spaced pull requests, then it will emit packets at the spe… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/beaconscanner?rev=1236475442 This is automatically generated documentation. NAME BeaconScanner -- Click element; Listens for 802.11 beacons and sends probe requests. SYNOPSIS BeaconScanner Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION ELEMENT HANDLERS <dl> <dt> scan read (only)</dt> <dd> Statistics about access points that the element has received beacons from.</dd> </dl> <dl> <dt> reset (read/write)</dt> <dd> Clear the list of access points.</dd> </dl> <dl> <dt> (chann… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/beaconsource?rev=1236475441 This is automatically generated documentation. NAME BeaconSource -- Click element; Send 802.11 beacons. SYNOPSIS BeaconSource([, KEYWORDS]) Ports: 1 input, 1 output Processing: push Package: wifi (core) DESCRIPTION Keyword arguments are: <dl> <dt> </dt> <dd> The wireless channel it is operating on.</dd> </dl> <dl> <dt> </dt> <dd> The SSID of the access point.</dd> </dl> <dl> <dt> </dt> <dd> An Ethernet Address (usually the same as the ethernet address of the wireless card).</dd>… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/beacontracker?rev=1179990969 This is automatically generated documentation. NAME BeaconTracker -- Click element; Tracks beacon from an Access Point SYNOPSIS BeaconTracker Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION ELEMENT HANDLERS <dl> <dt> stats read (only)</dt> <dd> The percent of probes received.</dd> </dl> <dl> <dt> reset (read/write)</dt> <dd> Clear the list of access points.</dd> </dl> text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/bighashmaptest?rev=1140460875 This is automatically generated documentation. NAME BigHashMapTest -- Click element; runs regression tests for BigHashMap SYNOPSIS BigHashMapTest() Ports: none Package: test (core) DESCRIPTION BigHashMapTest runs BigHashMap regression tests at initialization time. It does not route packets. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/biginttest?rev=1236475442 This is automatically generated documentation. NAME BigintTest -- Click element; Test multiple-precision multiply and divide with some simple tests. SYNOPSIS BigintTest() Ports: none Drivers: userlevel Package: test (core) DESCRIPTION This element routes no packets and does all its work at initialization time. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/block?rev=1236475442 This is automatically generated documentation. NAME Block -- Click element; drops packets with high rate SYNOPSIS Block(THRESH) Ports: 1 input, 2 outputs Processing: agnostic Package: standard (core) DESCRIPTION THRESH is an integer. Splits packets based on the dst rate annotation set by Monitor. If the annotation is less or equal to THRESH, the packet is pushed on output 0, otherwise on 1. Is THRESH is 0 then all packets are pushed on output 0. <dl> <dt> </dt> <dd> value of THRES… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/bottleneckmetric?rev=1236475441 This is automatically generated documentation. NAME BottleneckMetric -- Click element; SYNOPSIS BottleneckMetric(LINKSTAT) Ports: None Package: grid (core) DESCRIPTION Child class of GridGenericMetric that implements the bottleneck delivery ratio threshold metric. The bottleneck delivery ratio of a route is the minimum delivery ratio of all links in the route. Routes with larger bottleneck delivery ratios are preferred to those with smaller. The metric value is the bottleneck deli… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/bufferconverter?rev=1140460875 This is automatically generated documentation. NAME BufferConverter -- Click element; converts TCP packets to/from buffers through handlers SYNOPSIS BufferConverter(MTU) Ports: 2 inputs, 1 output Package: local (core) DESCRIPTION MTU is the maximum MTU allowed. BufferConverter takes ICMP path mtu discovery packets on input port 1. XXX - do MTU discovery etc text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/burster?rev=1236475442 This is automatically generated documentation. NAME Burster -- Click element; pull-to-push converter SYNOPSIS Burster(INTERVAL [, BURST]) Ports: 1 input, 1 output Processing: pull inputs, push outputs Package: standard (core) DESCRIPTION Burster is a variant of TimedUnqueue with a default BURST of 8, rather than 1. text/html 2006-05-19T18:00:39-08:00 http://www.read.cs.ucla.edu/click/elements/calculatetcplossevents?rev=1148086839 This is automatically generated documentation. NAME CalculateTCPLossEvents -- Click element; analyzes TCP flows for loss events SYNOPSIS CalculateTCPLossEvents([TRACEINFO, keywords TRACEINFO, TRACEINFO_FILEPOS, TRACEINFO_TRACEFILE, NOTIFIER, FLOWDUMPS, SUMMARYDUMP, IP_ID, ACK_MATCH]) <dl> <dt> </dt> <dd> Filename. If given, then output information about each aggregate to that file,in an XML format. Information includes the flow identifier, total sequencespace used on each flow, and loss cou… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/changeuid?rev=1140460872 This is automatically generated documentation. NAME ChangeUID -- Click element; relinquish root privilege SYNOPSIS ChangeUID() Ports: none Drivers: userlevel Package: userlevel (core) DESCRIPTION Sets the current process's effective user and group IDs to its real user and group IDs, respectively. This relinquishes any set-uid-root privilege. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/chattersocket?rev=1179990969 This is automatically generated documentation. NAME ChatterSocket -- Click element; reports chatter messages to connected sockets SYNOPSIS ChatterSocket("TCP", PORTNUMBER [, KEYWORDS]) ChatterSocket("UNIX", FILENAME [, KEYWORDS]) Ports: none Drivers: userlevel Package: userlevel (core) <dl> <dt> </dt> <dd> Text word. The socket outputs messages sent to this chatter channel. Defaultis the default channel, which corresponds to .Channels help you organize extensive debugging output. Fo… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/checkarpheader?rev=1179990969 This is automatically generated documentation. NAME CheckARPHeader -- Click element; checks ARP header SYNOPSIS CheckARPHeader([OFFSET, keywords OFFSET, VERBOSE, DETAILS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ethernet (core) <dl> <dt> </dt> <dd> Unsigned integer. Byte position at which the ARP header begins. Default is 0.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If it is true, then a message will be printed for every erroneouspacket, rather… text/html 2006-05-19T18:00:43-08:00 http://www.read.cs.ucla.edu/click/elements/checkaveragelength?rev=1148086843 This is automatically generated documentation. NAME CheckAverageLength -- Click element; splits a flow of packets depending on their average length. SYNOPSIS CheckAverageLength(MIN) Ports: 1 input, 2 outputs Processing: Push Drivers: linuxmodule Package: unibo_qos <dl> <dt> </dt> <dd> Minimum average length (in bytes) of packets to filter out.</dd> </dl> text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/checkcrc32?rev=1140460873 This is automatically generated documentation. NAME CheckCRC32 -- Click element; checks packet CRC32s SYNOPSIS CheckCRC32() Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Check that the CRC32 appended by SetCRC32 is OK. If so, delete the CRC from the packet. Otherwise, drop the packet. text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/checkdhcpmsg?rev=1140807056 This is automatically generated documentation. NAME CheckDHCPMsg -- Click element; Checks to see if an incoming packet is, in fact, a valid DHCP Message. SYNOPSIS CheckDHCPMsg() Ports: 1 input, 1-2 outputs Processing: agnostic Package: dhcp text/html 2006-05-19T18:00:36-08:00 http://www.read.cs.ucla.edu/click/elements/checkgreheader?rev=1148086836 This is automatically generated documentation. NAME CheckGREHeader -- Click element; checks GRE header SYNOPSIS CheckGREHeader([keywords OFFSET, CHECKSUM, KEY, SEQUENCE, VERBOSE, DETAILS]) Ports: 1 input, 1-2 outputs Processing: agnostic Package: @CLICKPACKAGENAME@ <dl> <dt> </dt> <dd> Boolean. If true, then check each header's checksum for presence andvalidity. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Unsigned. If not 0, check each header's key field for presence andvalidi… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/checkgridheader?rev=1140460876 This is automatically generated documentation. NAME CheckGridHeader -- Click element; SYNOPSIS CheckGridHeader([BADADDRS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: grid (core) DESCRIPTION Expects Grid packets as input. Checks that the packet's length is reasonable, and that the Grid header length, length, and checksum fields are valid. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/checkicmpheader?rev=1179990969 This is automatically generated documentation. NAME CheckICMPHeader -- Click element; checks ICMP header on ICMP packets SYNOPSIS CheckICMPHeader([KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: icmp (core) <dl> <dt> </dt> <dd> Boolean. If it is true, then a message will be printed for every erroneouspacket, rather than just the first. False by default.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If it is true, then CheckICMPHeader will mainta… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/checkip6header?rev=1140460876 This is automatically generated documentation. NAME CheckIP6Header -- Click element; SYNOPSIS CheckIP6Header([BADADDRS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ip6 (core) DESCRIPTION Expects IP6 packets as input. Checks that the packet's length is reasonable, and that the IP6 version, length, are valid. Checks that the IP6 source address is a legal unicast address. Shortens packets to the IP6 length, if the IP length is shorter than the no… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/checkipheader?rev=1179990969 This is automatically generated documentation. NAME CheckIPHeader -- Click element; checks IP header SYNOPSIS CheckIPHeader([OFFSET, keywords OFFSET, INTERFACES, BADSRC, GOODDST, CHECKSUM, VERBOSE, DETAILS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ip (core) <dl> <dt> </dt> <dd> Boolean. If true, then check each packet's checksum for validity; if false, donot check the checksum. Default is true.</dd> </dl> <dl> <dt> </dt… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/checkipheader2?rev=1140460874 This is automatically generated documentation. NAME CheckIPHeader2 -- Click element; checks IP header, no checksum SYNOPSIS CheckIPHeader2([OFFSET, keywords]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ip (core) text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/checklength?rev=1190150828 This is automatically generated documentation. NAME CheckLength -- Click element; drops large packets SYNOPSIS CheckLength(LENGTH) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: standard (core) DESCRIPTION CheckLength checks every packet's length against LENGTH. If the packet is no larger than LENGTH, it is sent to output 0; otherwise, it is sent to output 1 (or dropped if there is no output 1). text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/checkpacket?rev=1179990969 This is automatically generated documentation. NAME CheckPacket -- Click element; check packets against a specification SYNOPSIS CheckPacket(KEYWORDS) Ports: 1 input, 1 output Processing: agnostic Package: test (core) DESCRIPTION CheckPacket compares all received packets against a specification provided by keyword arguments. It prints error messages when incoming packets don't match the spec. Keyword arguments are as follows. Tests are performed for the keyword arguments you speci… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/checkpaint?rev=1236475441 This is automatically generated documentation. NAME CheckPaint -- Click element; checks packets' paint annotation SYNOPSIS CheckPaint(COLOR [, ANNO]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: standard (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/checksrheader?rev=1140460875 This is automatically generated documentation. NAME CheckSRHeader -- Click element; Check the Source Route header of a packet. SYNOPSIS CheckSRHeader() Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: wifi (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/checktcpheader?rev=1179990969 This is automatically generated documentation. NAME CheckTCPHeader -- Click element; checks TCP header on TCP/IP packets SYNOPSIS CheckTCPHeader([KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: tcpudp (core) <dl> <dt> </dt> <dd> Boolean. If it is true, then a message will be printed for every erroneouspacket, rather than just the first. False by default.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If it is true, then CheckTCPHeader will mainta… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/checkudpheader?rev=1179990969 This is automatically generated documentation. NAME CheckUDPHeader -- Click element; checks UDP header on UDP/IP packets SYNOPSIS CheckUDPHeader([KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: tcpudp (core) <dl> <dt> </dt> <dd> Boolean. If it is true, then a message will be printed for every erroneouspacket, rather than just the first. False by default.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If it is true, then CheckUDPHeader will mainta… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/classifier?rev=1179990969 This is automatically generated documentation. NAME Classifier -- Click element; classifies packets by contents SYNOPSIS Classifier(pattern1, ..., patternN) Ports: 1 input, any number of outputs Processing: push Package: standard (core) DESCRIPTION Classifies packets. The Classifier has N outputs, each associated with the corresponding pattern from the configuration string. A pattern is a set of clauses, where each clause is either "offset/value" or "offset/value%mask". A pattern … text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/clptest?rev=1236475442 This is automatically generated documentation. NAME CLPTest -- Click element; runs regression tests for CLP command line parser SYNOPSIS CLPTest([keywords]) Ports: none Drivers: userlevel Package: test (core) DESCRIPTION CLPTest runs regression tests for the CLP command line parsing library at initialization time. It does not route packets. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/compareblock?rev=1236475441 This is automatically generated documentation. NAME CompareBlock -- Click element; drops packets out of rate range SYNOPSIS CompareBlock(FWD_WEIGHT, REV_WEIGHT, THRESH) Ports: 1 input, 2 outputs Processing: agnostic Package: standard (core) <dl> <dt> </dt> <dd> value of FWD_WEIGHT</dd> </dl> <dl> <dt> </dt> <dd> value of REV_WEIGHT</dd> </dl> <dl> <dt> </dt> <dd> value of THRESH</dd> </dl> text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/comparepackets?rev=1179990969 This is automatically generated documentation. NAME ComparePackets -- Click element; compare packets in pairs SYNOPSIS ComparePackets([keywords TIMESTAMP]) Ports: 2 inputs, 2 outputs Processing: pull Package: test (core) DESCRIPTION ComparePackets compares packets pulled from the first input with packets pulled from the second input. Packets are considered different if they have different length, data, header offsets, or timestamp annotations. Keyword arguments are: <dl> <dt> </d… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/confparsetest?rev=1190150829 This is automatically generated documentation. NAME ConfParseTest -- Click element; runs regression tests for configuration parsing SYNOPSIS ConfParseTest() Ports: none Package: test (core) DESCRIPTION ConfParseTest runs configuration parsing regression tests at initialization time. It does not route packets. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/controlsocket?rev=1236475441 This is automatically generated documentation. NAME ControlSocket -- Click element; opens control sockets for other programs SYNOPSIS ControlSocket("TCP", PORTNUMBER [, keywords READONLY, PROXY, VERBOSE, LOCALHOST, RETRIES, RETRY_WARNINGS]) ControlSocket("UNIX", FILENAME [, keywords]) <dl> <dt> </dt> <dd> Boolean. Disallows write handlers if true (it is false bydefault).</dd> </dl> <dl> <dt> </dt> <dd> String. Specifies an element proxy. When a user requests the value of handlerE.H, Cont… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/copyflowid?rev=1140460875 This is automatically generated documentation. NAME CopyFlowID -- Click element; sets UDP/TCP flow ID SYNOPSIS CopyFlowID() Ports: 2 inputs, 2 outputs Processing: agnostic Package: local (core) DESCRIPTION remembers flow id from packets between input/output 0, tag the flow id onto packets between input/output 1. only remembers the flow id from the first packet after initialization or reset. text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/copyrxstats?rev=1140460873 This is automatically generated documentation. NAME CopyRXStats -- Click element; Copies rate, signal and noise annotations into the packet at the specified offset. SYNOPSIS CopyRXStats(OFFSET) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/copytcpseq?rev=1140460875 This is automatically generated documentation. NAME CopyTCPSeq -- Click element; sets TCP sequence number SYNOPSIS CopyTCPSeq() Ports: 2 inputs, 2 outputs Processing: agnostic Package: local (core) DESCRIPTION remembers highest sequence number from packets between input/output 0 and tag that number onto packets between input/output 1. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/counter?rev=1236475442 This is automatically generated documentation. NAME Counter -- Click element; measures packet count and rate SYNOPSIS Counter([keywords COUNT_CALL, BYTE_COUNT_CALL]) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Passes packets unchanged from its input to its output, maintaining statistics information about packet count and packet rate. Keyword arguments are: <dl> <dt> </dt> <dd> Argument is ` []'. When the packet count reaches ,call the write … text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/counterflood?rev=1140460873 This is automatically generated documentation. NAME CounterFlood -- Click element; Flood packets; Forward if you hear it less than a threshold. SYNOPSIS CounterFlood(ETHTYPE eth, IP ip, BCAST_IP ip, ETH eth, COUNT int, MAX_DELAY int, N<> [DEBUG bool], [HISTORY int]); Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) <dl> <dt> </dt> <dd> count of x indicates don't forward if you've recieved x packetsCount of 0 indicates always forwardCount of… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/cpuqueue?rev=1140460874 This is automatically generated documentation. NAME CPUQueue -- Click element; stores packets in FIFO queues. SYNOPSIS CPUQueue CPUQueue(CAPACITY) Ports: 1 input, 1 or more outputs Processing: push inputs, pull outputs Drivers: linuxmodule Package: linuxmodule (core) text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/cpuswitch?rev=1140460874 This is automatically generated documentation. NAME CPUSwitch -- Click element; classifies packets by cpu SYNOPSIS CPUSwitch() Ports: 1 input, 1 or more outputs Processing: push Drivers: linuxmodule Package: linuxmodule (core) DESCRIPTION Can have any number of outputs. Chooses the output on which to emit each packet based on the thread's cpu. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/cyclecountaccum?rev=1179990969 This is automatically generated documentation. NAME CycleCountAccum -- Click element; collects differences in cycle counters SYNOPSIS CycleCountAccum() Ports: 1 input, 1 output Processing: agnostic Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Returns the number of packets that have passed.</dd> </dl> <dl> <dt> </dt> <dd> Returns the accumulated cycles for all passing packets.</dd> </dl> <dl> <dt> </dt> <dd> Returns the number of packets with zero-valued c… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/decip6hlim?rev=1140460874 This is automatically generated documentation. NAME DecIP6HLIM -- Click element; SYNOPSIS DecIP6HLIM() Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ip6 (core) DESCRIPTION Expects IP6 packet as input. If the hlim is <= 1 (i.e. has expired), DecIP6HLIM sends the packet to output 1 (or discards it if there is no output 1). Otherwise it decrements the hlim, and sends the packet to output 0. Ordinarily output 1 is connected to an ICMP6 error packet ge… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/decipttl?rev=1140460876 This is automatically generated documentation. NAME DecIPTTL -- Click element; decrements IP time-to-live, drops dead packets SYNOPSIS DecIPTTL Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ip (core) DESCRIPTION Expects IP packet as input. If the ttl is <= 1 (i.e. has expired), DecIPTTL sends the packet to output 1 (or discards it if there is no output 1). Otherwise it decrements the ttl, re-calculates the checksum, and sends the packet to output … text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/delayshaper?rev=1179990969 This is automatically generated documentation. NAME DelayShaper -- Click element; shapes traffic to meet delay requirements SYNOPSIS DelayShaper(DELAY) Ports: 1 input, 1 output Processing: pull Package: standard (core) DESCRIPTION Pulls packets from the single input port. Delays them for at least DELAY seconds, with microsecond precision. A packet with timestamp T will be emitted no earlier than time (T + DELAY). On output, the packet's timestamp is set to the current time. Differ… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/delayunqueue?rev=1140460875 This is automatically generated documentation. NAME DelayUnqueue -- Click element; delay inducing pull-to-push converter SYNOPSIS DelayUnqueue(DELAY) Ports: 1 input, 1 output Processing: pull inputs, push outputs Package: standard (core) DESCRIPTION Pulls packets from the single input port. Delays them for at least DELAY seconds, with microsecond precision. A packet with timestamp T will be emitted no earlier than time (T + DELAY). On output, the packet's timestamp is set to the c… text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpclassifier?rev=1140807056 This is automatically generated documentation. NAME DHCPClassifier -- Click element; Classifies dhcp packets by DHCP_MESSAGE_TYPE SYNOPSIS DHCPClassifier([ discover | offer | request | deline | ack | nack | release | inform ], -) Ports: 1 input, any number of outputs Processing: push Package: dhcp text/html 2007-07-18T03:24:47-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpclient?rev=1184754287 This is automatically generated documentation. NAME DHCPClient -- Click element; The core of the DHCP Client. The state machine resides in this element. SYNOPSIS DHCPClient(etheraddress [, keywords]) Ports: 1 input, 2-3 outputs Processing: push Package: dhcp <dl> <dt> </dt> <dd> The client's current IP address, if any.</dd> </dl> <dl> <dt> </dt> <dd> A write handler to be called when the client gets a new lease, or loses itscurrent lease. The write handler is called with additional… text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpicmpencap?rev=1140807056 This is automatically generated documentation. NAME DHCPICMPEncap -- Click element; change IP addresses of ICMP packet SYNOPSIS DHCPICMPEncap(...) Ports: 1 input, 1 output Processing: agnostic Package: dhcp Generated by 'click-elem2man' from 'dhcpicmpencap.hh' on 24/Feb/2006. text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpleasehash?rev=1140807056 This is automatically generated documentation. NAME DHCPLeaseHash -- Click element; The core of the DHCP Server. Responsible of keeping track of free and allocated leases SYNOPSIS DHCPLeaseHash( ServerIPAddress, SubnetMask ) Ports: none Package: dhcp text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpleasepool?rev=1140807056 This is automatically generated documentation. NAME DHCPLeasePool -- Click element; The core of the DHCP Server. Responsible of keeping track of free and allocated leases SYNOPSIS DHCPLeasePool( ServerIPAddress, SubnetMask ) Ports: none Package: dhcp text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpoffermsgqueue?rev=1140807056 This is automatically generated documentation. NAME DHCPOfferMsgQueue -- Click element; Stores DHCPOffer packets in a queue ordered by the duration of the leases. SYNOPSIS DHCPOfferMsgQueue(read_handler) Ports: 1 input, 1 output Processing: push inputs, pull outputs Package: dhcp text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpserverackornak?rev=1140807056 This is automatically generated documentation. NAME DHCPServerACKorNAK -- Click element; Handles incoming DHCP_REQUEST. Sends out DHCP_ACK or DHCP_NAK accordingly. SYNOPSIS DHCPServerACKorNAK( DHCPServerLeases ) Ports: 1 input, 1-2 outputs Processing: push Package: dhcp text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpserveroffer?rev=1140807056 This is automatically generated documentation. NAME DHCPServerOffer -- Click element; Handles incoming DHCP_DISCOVER. Sends out DHCP_OFFER if appropriate. SYNOPSIS DHCPServerOffer( DHCPServerLeases ) Ports: 1-2 inputs, 1-2 outputs Processing: push Package: dhcp text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpserverrelease?rev=1140807056 This is automatically generated documentation. NAME DHCPServerRelease -- Click element; handles DHCP release address messages SYNOPSIS DHCPServerRelease(...) Ports: 1 input, no outputs Processing: push Package: dhcp Generated by 'click-elem2man' from 'dhcpserverrelease.hh' on 24/Feb/2006. text/html 2006-02-24T10:50:56-08:00 http://www.read.cs.ucla.edu/click/elements/dhcpunicastencap?rev=1140807056 This is automatically generated documentation. NAME DHCPUnicastEncap -- Click element; Changes the ip_src and ip_dst of an outgoing packet, according to the read_handlers output. SYNOPSIS DHCPUnicastEncap(src_ip_read_handler, dst_ip_read_handler) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/directiplookup?rev=1236475441 This is automatically generated documentation. NAME DirectIPLookup -- Click element; IP routing lookup using direct-indexed tables SYNOPSIS DirectIPLookup(ADDR1/MASK1 [GW1] OUT1, ADDR2/MASK2 [GW2] OUT2, ...) Ports: 1 input, any number of outputs Processing: push Drivers: userlevel, bsdmodule Package: ip (core) <dl> <dt> </dt> <dd> Outputs a human-readable version of the current routing table.</dd> </dl> <dl> <dt> </dt> <dd> Reports the OUTput port and GW corresponding to an addres… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/discard?rev=1179990969 This is automatically generated documentation. NAME Discard -- Click element; drops all packets SYNOPSIS Discard Ports: 1 input, no outputs Processing: agnostic Package: standard (core) DESCRIPTION Discards all packets received on its single input. If used in a pull context, it initiates pulls whenever packets are available, and listens for activity notification, such as that available from Queue. <dl> <dt> </dt> <dd> Returns the number of packets discarded.</dd> </dl> <dl> <dt> … text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/discardnofree?rev=1140460876 This is automatically generated documentation. NAME DiscardNoFree -- Click element; drops all packets, but does not free any of them. SYNOPSIS DiscardNoFree Ports: 1 input, no outputs Processing: agnostic Package: standard (core) DESCRIPTION Discards all packets received on its single input, but does not free any of them. Only useful for benchmarking. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/drivermanager?rev=1236475442 This is automatically generated documentation. NAME DriverManager -- Click element; a Script that manages driver stop events SYNOPSIS DriverManager(INSTRUCTIONS...) Ports: any number of inputs, any number of outputs Processing: push Package: standard (core) text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/dropbroadcasts?rev=1140460872 This is automatically generated documentation. NAME DropBroadcasts -- Click element; drops link-level broadcast and multicast packets SYNOPSIS DropBroadcasts Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: standard (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/drrsched?rev=1140460875 This is automatically generated documentation. NAME DRRSched -- Click element; pulls from inputs with deficit round robin scheduling SYNOPSIS DRRSched Ports: one output, zero or more inputs Processing: pull Package: standard (core) DESCRIPTION Schedules packets with deficit round robin scheduling, from Shreedhar and Varghese's SIGCOMM 1995 paper "Efficient Fair Queuing using Deficit Round Robin." The inputs usually come from Queues or other pull schedulers. DRRSched uses notificat… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/dsdvroutetable?rev=1179990969 This is automatically generated documentation. NAME DSDVRouteTable -- Click element; Run DSDV local routing protocol SYNOPSIS DSDVRouteTable(TIMEOUT, PERIOD, JITTER, MIN_TRIGGER_PERIOD, ETH, IP [, KEYWORDS]) Ports: 1 input, 1 output Processing: push Package: grid (core) <dl> <dt> </dt> <dd> Unsigned integer. Milliseconds after which to expire route entries.</dd> </dl> <dl> <dt> </dt> <dd> Unsigned integer. Milliseconds between full dumps, plus/minus some jitter (see below).</dd> <… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/dsrarptable?rev=1179990969 This is automatically generated documentation. NAME DSRArpTable -- Click element; Maintains an ARP table for DSR. SYNOPSIS DSRArpTable(IP, ETHER) Ports: 3 inputs, 3 outputs Package: grid (core) DESCRIPTION Packets with ethernet headers pushed into input 2 are sent out unchanged on output 2. I-MAC address entries are added to the ARP table for each pushed packet's source MAC address and source IP address (derived from the various DSR option headers). Pulls on outputs 0 and 1 pull pa… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/dsrroutetable?rev=1236475442 This is automatically generated documentation. NAME DSRRouteTable -- Click element; A DSR protocol implementation SYNOPSIS DSRRouteTable(IP, LINKTABLE, [, KEYWORDS]) Ports: 3 inputs, 3 outputs Processing: push Package: grid (core) DESCRIPTION This is meant to approximate an `official' implementation of DSR as of version 10 of the IETF draft. Network-layer acknowledgements and many optimizations (e.g. reply-from-cache and route shortening) are not implemented. Regular arguments ar… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/dupefilter?rev=1140460874 This is automatically generated documentation. NAME DupeFilter -- Click element; SYNOPSIS DupeFilter([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are SR packets (ie a sr_pkt struct from sr.hh). Prints out a description of those packets. Keyword arguments are: text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/dynamicudpipencap?rev=1190150828 This is automatically generated documentation. NAME DynamicUDPIPEncap -- Click element; encapsulates packets in dynamic UDP/IP headers SYNOPSIS DynamicUDPIPEncap(SRC, SPORT, DST, DPORT [, CHECKSUM, INTERVAL]) Ports: 1 input, 1 output Processing: agnostic Package: tcpudp (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/e2elossmetric?rev=1179990969 This is automatically generated documentation. NAME E2ELossMetric -- Click element; SYNOPSIS E2ELossMetric(LinkStat, [, KEYWORDS]) Ports: None Package: grid (core) DESCRIPTION Child class of GridGenericMetric that implements the end-to-end cumulative link loss ratio metric. The metric is the product of the delivery ratios of each link in the path, from 0--100 as a percentage. Larger metrics values are better. LinkStat is this node's LinkStat element, which is needed to obtain the … text/html 1969-12-31T16:00:00-08:00 http://www.read.cs.ucla.edu/click/elements/elements-%40clickpackagename%40?rev= text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/elements-click?rev=1236475442 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-CLICK" n "7/Mar/2009" "Click" .SH "NAME" elements-click - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#Basic+Sources+and+Sinks">Basic&nbsp;Sources… text/html 2007-07-18T03:24:47-08:00 http://www.read.cs.ucla.edu/click/elements/elements-dhcp?rev=1184754287 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-DHCP" n "18/Jul/2007" "Click" .SH "NAME" elements-dhcp - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#DHCP">DHCP</a><br> .\"html <a href="#ALPHABE… text/html 2006-05-19T18:00:37-08:00 http://www.read.cs.ucla.edu/click/elements/elements-ip6_natpt?rev=1148086837 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-IP6_NATPT" n "19/May/2006" "Click" .SH "NAME" elements-ip6_natpt - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#Network+Address+Translation">Netwo… text/html 2007-01-27T23:34:40-08:00 http://www.read.cs.ucla.edu/click/elements/elements-models?rev=1169969680 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-MODELS" n "27/Jan/2007" "Click" .SH "NAME" elements-models - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#TCP/IP+Measurement">TCP/IP&nbsp;Measurem… text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/elements-multicast?rev=1148086840 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-MULTICAST" n "19/May/2006" "Click" .SH "NAME" elements-multicast - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#Miscellaneous">Miscellaneous</a><b… text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/elements-multicast6?rev=1148086841 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-MULTICAST6" n "19/May/2006" "Click" .SH "NAME" elements-multicast6 - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#IP">IP</a>&nbsp;- <a href="#Misc… text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/elements-netflow?rev=1148086841 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-NETFLOW" n "19/May/2006" "Click" .SH "NAME" elements-netflow - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#Mazu+Logging">Mazu&nbsp;Logging</a><br… text/html 2007-01-27T23:35:02-08:00 http://www.read.cs.ucla.edu/click/elements/elements-security?rev=1169969702 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-SECURITY" n "27/Jan/2007" "Click" .SH "NAME" elements-security - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#Packet+processing+for+security">Pack… text/html 2006-05-19T18:00:42-08:00 http://www.read.cs.ucla.edu/click/elements/elements-snmp?rev=1148086842 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-SNMP" n "19/May/2006" "Click" .SH "NAME" elements-snmp - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#SNMP">SNMP</a><br> .\"html <a href="#ALPHABE… text/html 2006-05-19T18:00:43-08:00 http://www.read.cs.ucla.edu/click/elements/elements-unibo_qos?rev=1148086843 This is automatically generated documentation. .\" -*- mode: nroff -*- .\" Generated by 'click-elem2man' .de M .IR "\\$1" "(\\$2)\\$3" .. .de RM .RI "\\$1" "\\$2" "(\\$3)\\$4" .. .TH "ELEMENTS-UNIBO_QOS" n "19/May/2006" "Click" .SH "NAME" elements-unibo_qos - documented Click element classes .SH "DESCRIPTION" This page lists all Click element classes that have manual page documentation. .\"html <p><a href="#BY+FUNCTION"><b>By Function</b></a>: .\"html <a href="#Basic+Classification+and+Selection… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/ensureether?rev=1140460873 This is automatically generated documentation. NAME EnsureEther -- Click element; ensures that IP packets are Ethernet encapsulated SYNOPSIS EnsureEther([ETHERTYPE, SRC, DST]) Ports: 1 input, 1 output Processing: agnostic Package: ethernet (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/eraseippayload?rev=1140460875 This is automatically generated documentation. NAME EraseIPPayload -- Click element; erases IP packet payload SYNOPSIS EraseIPPayload() Ports: 1 input, 1 output Processing: agnostic Package: analysis (core) DESCRIPTION Erases all TCP or UDP payload in incoming packets. Output packets have the same length, but all payload bytes are zero. text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/error?rev=1140460875 This is automatically generated documentation. NAME Error -- Click element; always fails SYNOPSIS Error(...) Ports: any number of inputs, any number of outputs Processing: agnostic Package: standard (core) DESCRIPTION The Error element always fails to initialize. It has any number of inputs and outputs, and accepts any configuration string without complaint. It is useful to prevent a router from initializing while avoiding spurious error messages about bad configuration strings or… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/errortest?rev=1236475441 This is automatically generated documentation. NAME ErrorTest -- Click element; runs regression tests for error handling SYNOPSIS ErrorTest() Ports: none Package: test (core) DESCRIPTION ErrorTest runs error handling regression tests at initialization time. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/estimaterouterregion?rev=1236475442 This is automatically generated documentation. NAME EstimateRouterRegion -- Click element; SYNOPSIS EstimateRouterRegion(IP, [FIXED, LATITUDE, LONGITUDE]) Ports: 1 input, 1 output Processing: push Drivers: userlevel Package: grid (core) DESCRIPTION Run the Region-based Grid Position Estimation Protocol. Subtypes GridLocationInfo, and can be used in its place. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/ethercount?rev=1179990969 This is automatically generated documentation. NAME EtherCount -- Click element; Track each ethernet source. SYNOPSIS EtherCount Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION ELEMENT HANDLERS <dl> <dt> (stats)</dt> <dd> Print information accumulated for each source</dd> </dl> <dl> <dt> (reset)</dt> <dd> Clear all information for each source</dd> </dl> text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/etherencap?rev=1236475442 This is automatically generated documentation. NAME EtherEncap -- Click element; encapsulates packets in Ethernet header SYNOPSIS EtherEncap(ETHERTYPE, SRC, DST) Ports: 1 input, 1 output Processing: agnostic Package: ethernet (core) DESCRIPTION Encapsulates each packet in the Ethernet header specified by its arguments. ETHERTYPE should be in host order. <dl> <dt> </dt> <dd> Returns or sets the SRC parameter.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the DST parameter.</dd> … text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/ethermirror?rev=1140460873 This is automatically generated documentation. NAME EtherMirror -- Click element; swaps Ethernet source and destination SYNOPSIS EtherMirror() Ports: 1 input, 1 output Processing: agnostic Package: ethernet (core) DESCRIPTION Incoming packets are Ethernet. Their source and destination Ethernet addresses are swapped before they are output. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/etherpausesource?rev=1236475441 This is automatically generated documentation. NAME EtherPauseSource -- Click element; creates and emits Ethernet 802.3x pause frames SYNOPSIS EtherPauseSource(SRC, PAUSETIME [, keywords DST, LIMIT, INTERVAL, ACTIVE]) Ports: no inputs, 1 output Processing: agnostic Package: ethernet (core) <dl> <dt> </dt> <dd> Ethernet address. Destination address of the PAUSE frames. Defaults to01-80-C2-00-00-01, the special multicast address allocated for PAUSEframes. Can also be a specific stat… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/etherswitch?rev=1236475442 This is automatically generated documentation. NAME EtherSwitch -- Click element; learning, forwarding Ethernet switch SYNOPSIS EtherSwitch([keywords TIMEOUT]) Ports: 2 or more inputs, the same number of outputs Processing: push Package: etherswitch (core) <dl> <dt> </dt> <dd> The timeout for port associations, in seconds. Any port mapping (i.e.,binding between an address and a port number) is dropped after TIMEOUT secondsof inactivity. If 0, the element acts like a dumb hub. Defa… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/ettmetric?rev=1140460874 This is automatically generated documentation. NAME ETTMetric -- Click element; Estimated Transmission Time (ETT) metric SYNOPSIS ETTMetric Ports: None Package: wifi (core) Generated by 'click-elem2man' from '../elements/wifi/sr/ettmetric.hh' on 20/Feb/2006. text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/ettstat?rev=1140460872 This is automatically generated documentation. NAME ETTStat -- Click element; Track broadcast loss rates at different bitrates. SYNOPSIS ETTStat([KEYWORDS]) Ports: 1 input, at most 1 output Processing: push Package: wifi (core) DESCRIPTION Expects probe packets as input. Records the last WINDOW unique (not neccessarily sequential) sequence numbers of link probes from each host, and calculates loss rates over the last TAU milliseconds for each host. If the output is connected, se… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/etx2metric?rev=1236475442 This is automatically generated documentation. NAME ETX2Metric -- Click element; SYNOPSIS ETX2Metric(DATA_LINKSTAT, ACK_LINKSTAT) Ports: None Package: grid (core) DESCRIPTION Child class of GridGenericMetric that implements the estimated transmission count (`ETX') metric using measurements at two packet sizes. LinkStat l1 is the LinkStat element measuring at the data packet size; l2 is measuring at the ACK packet size. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/etxmetric?rev=1236475442 This is automatically generated documentation. NAME ETXMetric -- Click element; SYNOPSIS ETXMetric(LINKSTAT) Ports: None Package: grid (core) DESCRIPTION Child class of GridGenericMetric that implements the estimated transmission count (`ETX') metric. LinkStat is this node's LinkStat element, which is needed to obtain the link delivery ratios used to calculate the metric. text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/extradecap?rev=1140460873 This is automatically generated documentation. NAME ExtraDecap -- Click element; Pulls the click_wifi_extra header from a packet and stores it in Packet::anno() SYNOPSIS ExtraDecap() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/extraencap?rev=1140460875 This is automatically generated documentation. NAME ExtraEncap -- Click element; Pushes the click_wifi_extra header on a packet based on information in Packet::anno() SYNOPSIS ExtraEncap() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/fasttcpflows?rev=1236475442 This is automatically generated documentation. NAME FastTCPFlows -- Click element; creates packets flows with static TCP/IP/Ethernet headers SYNOPSIS FastTCPFlows(RATE, LIMIT, LENGTH, SRCETH, SRCIP,N<> DSTETH, DSTIP,N<> FLOWS, FLOWSIZE [, ACTIVE]) Ports: no inputs, 1 output Processing: pull Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Returns the total number of packets that have been generated.</dd> </dl> <dl> <dt> … text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/fastudpflows?rev=1236475441 This is automatically generated documentation. NAME FastUDPFlows -- Click element; creates packets flows with static UDP/IP/Ethernet headers SYNOPSIS FastUDPFlows(RATE, LIMIT, LEN, SRCETH, SRCIP,N<> DSTETH, DSTIP,N<> FLOWS, FLOWSIZE [, CHECKSUM, ACTIVE]) Ports: no inputs, 1 output Processing: pull Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Returns the total number of packets that have been generated.</dd> </dl> <dl… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/fastudpsource.b?rev=1236475441 This is automatically generated documentation. NAME FastUDPSource.b -- Click element; creates packets with static UDP/IP/Ethernet headers SYNOPSIS FastUDPSource(RATE, LIMIT, LEN, SETHADDR, SIPADDR, SPORT, DETHADDR, DIPADDR, DPORT [, CHECKSUM?, INTERVAL, ACTIVE]) <dl> <dt> </dt> <dd> Returns the total number of packets that have been generated.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the RATE parameter.</dd> </dl> <dl> <dt> </dt> <dd> Reset and restart.</dd> </dl> <dl> <dt> </dt> … text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/fastudpsource?rev=1236475442 This is automatically generated documentation. NAME FastUDPSource -- Click element; creates packets with static UDP/IP/Ethernet headers SYNOPSIS FastUDPSource(RATE, LIMIT, LENGTH, SRCETH, SRCIP, SPORT, DSTETH, DSTIP, DPORT [, CHECKSUM, INTERVAL, ACTIVE]) <dl> <dt> </dt> <dd> Returns the total number of packets that have been generated.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the RATE parameter.</dd> </dl> <dl> <dt> </dt> <dd> Reset and restart.</dd> </dl> <dl> <dt> </dt> <dd> Cha… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/fastudpsourceip6?rev=1236475442 This is automatically generated documentation. NAME FastUDPSourceIP6 -- Click element; creates packets with static UDP/IP6/Ethernet headers SYNOPSIS FastUDPSourceIP6(RATE, LIMIT, LENGTH, SRCETH, SRCIP6, SPORT, DSTETH, DSTIP6, DPORT [, CHECKSUM, INTERVAL, ACTIVE]) <dl> <dt> </dt> <dd> Returns the total number of packets that have been generated.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the RATE parameter.</dd> </dl> <dl> <dt> </dt> <dd> Reset and restart.</dd> </dl> <dl> <dt> </dt>… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/filterbygridhops?rev=1236475441 This is automatically generated documentation. NAME FilterByGridHops -- Click element; SYNOPSIS FilterByGridHops(HOPS) Ports: 1 input, 2 outputs Processing: push Package: grid (core) DESCRIPTION Expects GRID_NBR_ENCAP packets with MAC headers on input 0. Any packet that has travelled less than HOPS so fare is sent to output 0. Packets that have already travelled HOPS or more are sent out output 1. HOPS is an Integer. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/filterbyrange?rev=1236475441 This is automatically generated documentation. NAME FilterByRange -- Click element; SYNOPSIS FilterByRange(RANGE, LOCINFO) Ports: 1 input, 2 outputs Processing: push Drivers: userlevel Package: grid (core) DESCRIPTION Expects Grid MAC layer packets on input 0. Any packet transmitted by a Grid node within RANGE metres from this node is sent to output 0. Packets transmitted by ``out of range'' nodes are sent out output 1. RANGE is an Integer. A negative range means no packets … text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/filterfailures?rev=1179990969 This is automatically generated documentation. NAME FilterFailures -- Click element; Filters unicast packets that failed to be acknowledged SYNOPSIS FilterFailures([KEYWORDS]) Ports: 1 input, 1-3 outputs Processing: agnostic, but output 1 is push Package: wifi (core) <dl> <dt> </dt> <dd> How many packets had the WIFI_EXTRA_TX_FAIL flag set.</dd> </dl> text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/filterphyerr?rev=1236475441 This is automatically generated documentation. NAME FilterPhyErr -- Click element; Filters packets that failed the 802.11 CRC check. SYNOPSIS FilterPhyErr([KEYWORDS]) Ports: 1 input, 1-3 outputs Processing: agnostic, but output 1 is push Package: wifi (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/filtertx?rev=1236475441 This is automatically generated documentation. NAME FilterTX -- Click element; Filter out wireless transmission feedback packets SYNOPSIS FilterTX([, KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: wifi (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/fixdstloc?rev=1236475441 This is automatically generated documentation. NAME FixDstLoc -- Click element; SYNOPSIS FixDstLoc(LOCTABLE) Ports: 1 input, 1 output Processing: agnostic Drivers: userlevel Package: grid (core) DESCRIPTION Expects a GRID_NBR_ENCAP packet with MAC header as input. Sets the packet's destination according to the destination IP address. Takes a LocationTable element as its argument. text/html 2007-01-27T23:32:31-08:00 http://www.read.cs.ucla.edu/click/elements/fixipsrc?rev=1169969551 This is automatically generated documentation. NAME FixIPSrc -- Click element; sets IP source field if requested by annotation SYNOPSIS FixIPSrc(IPADDR) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Expects an IP packet as input. If its Fix IP Source annotation is set, then changes its IP source address field to IPADDR and recomputes the checksum. Used by elements such as ICMPError that are required by standards to use the IP address on the outgoing … text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/fixpimsource?rev=1148086840 This is automatically generated documentation. NAME FixPIMSource -- Click element; IPv4 Multicast SYNOPSIS FixPIMSource(outgoing interface's IP address, PIMForwardingTable) Ports: 1 input, 1 output Processing: agnostic Package: multicast DESCRIPTION Adds upstream interface IP to PIM join/prune messages and calculates the checksum. text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/fixsrcloc?rev=1140460872 This is automatically generated documentation. NAME FixSrcLoc -- Click element; SYNOPSIS FixSrcLoc(LOCINFO) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION Expects a Grid MAC layer packet as input. Sets the packet's source location to the Grid node's location. This element uses the GridGenericLocInfo element named LOCINFO. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/floodinglocquerier?rev=1236475441 This is automatically generated documentation. NAME FloodingLocQuerier -- Click element; Sets Grid Destination location by running a flooding query protocol SYNOPSIS FloodingLocQuerier(ETH, IP) Ports: 2 inputs, 2 outputs Processing: push Package: grid (core) text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/floodtracker?rev=1140460873 This is automatically generated documentation. NAME FloodTracker -- Click element; Select a gateway to send a packet to based on TCP connection state and metric to gateway. SYNOPSIS FloodTracker(IP, ETH, ETHERTYPE, LinkTable, ARPTable, [PERIOD timeout], [GW is_gateway], N<> [METRIC GridGenericMetric]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/flowinfo?rev=1236475441 This is automatically generated documentation. NAME FlowInfo -- Click element; specifies flow codes SYNOPSIS FlowInfo(ELEMENT FLOWCODE, ...) Ports: None Package: standard (core) DESCRIPTION Allows the user to override specific elements' flow codes. Each configuration argument has the form `ELEMENT CODE', meaning that the element named ELEMENT has flow code CODE. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/forceicmp?rev=1140460874 This is automatically generated documentation. NAME ForceICMP -- Click element; sets ICMP checksum SYNOPSIS ForceICMP([TYPE, CODE]) Ports: 1 input, 1 output Processing: agnostic Package: local (core) DESCRIPTION Sets the ICMP checksum of an ICMP-in-IP packet. Optionally sets the TYPE and CODE of the ICMP header. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/forceip?rev=1140460876 This is automatically generated documentation. NAME ForceIP -- Click element; Fixes fields to make packets into legal IP packets. SYNOPSIS ForceIP() Ports: 1 input, 1 output Processing: agnostic Package: local (core) DESCRIPTION Fixes various fields in incoming packets to make sure they are legal IP packets. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/forcetcp?rev=1140460874 This is automatically generated documentation. NAME ForceTCP -- Click element; sets TCP packet fields SYNOPSIS ForceTCP([DPORT [,RANDOM [, FLAGS]]]) Ports: 1 input, 1 output Processing: agnostic Package: local (core) DESCRIPTION Set the checksum and some other fields to try to make a packet look like TCP. If DPORT is specified and not -1, forces the destination port to be DPORT. Otherwise, if RANDOM is set, destination port may be randomly set. If RANDOM is not set and DPORT is -1… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/forceudp?rev=1140460874 This is automatically generated documentation. NAME ForceUDP -- Click element; sets UDP packet fields SYNOPSIS ForceUDP([DPORT]) Ports: 1 input, 1 output Processing: agnostic Package: local (core) DESCRIPTION Set the checksum and some other fields to try to make a packet look like UDP. If DPORT is specified and not -1, forces the destination port to be DPORT. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/fromcapdump?rev=1179990969 This is automatically generated documentation. NAME FromCapDump -- Click element; reads packets from a 'cap' output file SYNOPSIS FromCapDump(FILENAME [, KEYWORDS]) Ports: no inputs, 1 output Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Boolean. If true, then FromCapDump will ask the router to stop when itis done reading. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If false, then FromCapDump will not emit packets (until the` … text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/fromdagdump?rev=1179990969 This is automatically generated documentation. NAME FromDAGDump -- Click element; reads packets from a DAG/ERF file SYNOPSIS FromDAGDump(FILENAME [, KEYWORDS]) Ports: no inputs, 1-2 outputs Processing: agnostic, but output 1 is push Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Boolean. If true, then FromDAGDump will ask the router to stop when it isdone reading its file (or the END time is reached). Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. I… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/fromdevice.b?rev=1179990969 This is automatically generated documentation. NAME FromDevice.b -- Click element; reads packets from network device (BSD kernel) SYNOPSIS FromDevice(DEVNAME [, PROMISC, BURST, KEYWORDS]) Ports: no inputs, 1 output Processing: push Drivers: bsdmodule Package: bsdmodule (core) <dl> <dt> </dt> <dd> Boolean. Same as the PROMISC argument.</dd> </dl> <dl> <dt> </dt> <dd> Unsigned integer. Same as the BURST argument.</dd> </dl> <dl> <dt> </dt> <dd> Allow nonexistent devices. If true, a… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/fromdevice?rev=1236475441 This is automatically generated documentation. NAME FromDevice -- Click element; reads packets from network device (Linux kernel) SYNOPSIS FromDevice(DEVNAME [, keywords PROMISC, BURST, TIMESTAMP...]) Ports: no inputs, 1 output Processing: push Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Boolean. If true, the device is put into promiscuous mode while FromDevice isactive. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Unsigned integer. Sets the BURST… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/fromdevice.u?rev=1236475442 This is automatically generated documentation. NAME FromDevice.u -- Click element; reads packets from network device (user-level) SYNOPSIS FromDevice(DEVNAME [, keywords SNIFFER, PROMISC, SNAPLEN, FORCE_IP, CAPTURE, BPF_FILTER, OUTBOUND, HEADROOM]) <dl> <dt> </dt> <dd> Boolean. Specifies whether should run in sniffer mode. Innon-sniffer mode, installs filtering rules to blockthe kernel from handling any packets arriving on device DEVNAME. Default istrue (sniffer mode).</dd> </dl> <dl… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/fromdump?rev=1236475441 This is automatically generated documentation. NAME FromDump -- Click element; reads packets from a tcpdump file SYNOPSIS FromDump(FILENAME [, keywords STOP, TIMING, SAMPLE, FORCE_IP, START, START_AFTER, END, END_AFTER, INTERVAL, END_CALL, FILEPOS, MMAP]) <dl> <dt> </dt> <dd> Boolean. If true, then FromDump will ask the router to stop when it is donereading its tcpdump file (or the END time is reached). Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If true, then FromDump tri… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/fromhost?rev=1236475441 This is automatically generated documentation. NAME FromHost -- Click element; reads packets from Linux SYNOPSIS FromHost(DEVNAME [, PREFIX, KEYWORDS]) Ports: no inputs, 1-2 outputs Processing: push Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Specifies the device type. Valid options are and . Currentlydefaults to with a warning.</dd> </dl> <dl> <dt> </dt> <dd> Specifies the fake device's IP address and netmask.</dd> </dl> <dl> <dt> </dt> <dd> Etherne… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/fromhost.u?rev=1236475441 This is automatically generated documentation. NAME FromHost.u -- Click element; interface to /dev/net/tun or ethertap (user-level) SYNOPSIS FromHost(DEVNAME [, DST, GATEWAY, HEADROOM] [, KEYWORDS]) Ports: no inputs, 1 output Processing: push Drivers: userlevel Package: userlevel (core) <dl> <dt> </dt> <dd> Ethernet address. Specifies the fake device's Ethernet address. Default isnot specified, in which case the fake device's address is whatever thekernel chooses.</dd> </dl> <dl> … text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/fromipsummarydump?rev=1236475442 This is automatically generated documentation. NAME FromIPSummaryDump -- Click element; reads packets from an IP summary dump file SYNOPSIS FromIPSummaryDump(FILENAME [, keywords STOP, TIMING, ACTIVE, ZERO, CHECKSUM, PROTO, MULTIPACKET, SAMPLE, CONTENTS, FLOWID]) <dl> <dt> </dt> <dd> Boolean. If true, then FromIPSummaryDump will ask the router to stop when itis done reading. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If true, then FromIPSummaryDump tries to maintain the tim… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/fromnetflowsummarydump?rev=1179990969 This is automatically generated documentation. NAME FromNetFlowSummaryDump -- Click element; reads packets from a NetFlow summary file SYNOPSIS FromNetFlowSummaryDump(FILE [, KEYWORDS]) Ports: no inputs, 1 output Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Boolean. If true, then FromNetFlowSummaryDump will ask the router to stop whenit is done reading. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If false, then FromNetFlowSum… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/fromnlanrdump?rev=1179990969 This is automatically generated documentation. NAME FromNLANRDump -- Click element; reads packets from an NLANR file SYNOPSIS FromNLANRDump(FILENAME [, KEYWORDS]) Ports: no inputs, 1-2 outputs Processing: agnostic, but output 1 is push Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> String. Should be either 'fr', 'fr+', 'tsh', or 'guess'. Default is 'guess'.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If true, then FromNLANRDump will ask the router to stop when it… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/fromrawsocket?rev=1140460873 This is automatically generated documentation. NAME FromRawSocket -- Click element; reads raw IP packets from safe raw socket (user-level) SYNOPSIS FromRawSocket("TCP", <TCP source port number> [, KEYWORDS]) FromRawSocket("UDP", <UDP source port number> [, KEYWORDS]) FromRawSocket("GRE", <GRE key or PPTP call ID> [, KEYWORDS]) FromRawSocket("ICMP", <ICMP identifier> [, KEYWORDS]) text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/fromsimdevice.u?rev=1140460876 This is automatically generated documentation. NAME FromSimDevice.u -- Click element; reads packets from a simulator device SYNOPSIS FromSimDevice(DEVNAME [, PROMISC? [, MAXPACKETSIZE]]) Ports: no inputs, 1 output Processing: push Drivers: ns Package: ns (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/fromsocket?rev=1140460875 This is automatically generated documentation. NAME FromSocket -- Click element; reads data from socket (user-level) SYNOPSIS FromSocket("TCP", IP, PORTNUMBER [, KEYWORDS]) FromSocket("UDP", IP, PORTNUMBER [, KEYWORDS]) FromSocket("UNIX", FILENAME [, KEYWORDS]) FromSocket("UNIX_DGRAM", FILENAME [, KEYWORDS]) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/fromtcpdump?rev=1179990969 This is automatically generated documentation. NAME FromTcpdump -- Click element; reads packets from an ASCII tcpdump output file SYNOPSIS FromTcpdump(FILENAME [, KEYWORDS]) Ports: no inputs, 1 output Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Boolean. If true, then FromTcpdump will ask the router to stop when itis done reading. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If false, then FromTcpdump will not emit packets (un… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/fromuserdevice?rev=1236475442 This is automatically generated documentation. NAME FromUserDevice -- Click element; Reads packets from the device's ring buffer and injects them into Click SYNOPSIS FromUserDevice(DEV_MINOR, [<keywords> CAPACITY]) Ports: no inputs, 1 output Processing: pull Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Unsigned integer. Sets the CAPACITY of the internal ring buffer that stores the packets.The device must be first created in the /dev directoryvia mknod /dev… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/frontdropqueue?rev=1236475442 This is automatically generated documentation. NAME FrontDropQueue -- Click element; stores packets in drop-from-front FIFO queue SYNOPSIS FrontDropQueue FrontDropQueue(CAPACITY) Ports: 1 input, 1-2 outputs Package: standard (core) DESCRIPTION Stores incoming packets in a first-in-first-out queue. Drops the head packet before inserting the incoming packet if the queue already holds CAPACITY packets. The default for CAPACITY is 1000. <dl> <dt> </dt> <dd> Returns the current number o… text/html 2007-07-18T03:23:58-08:00 http://www.read.cs.ucla.edu/click/elements/ftpportmapper?rev=1184754238 This is automatically generated documentation. NAME FTPPortMapper -- Click element; manipulates IPRewriter for FTP SYNOPSIS FTPPortMapper(CONTROL_REWRITER, DATA_REWRITER, PATTERN FOUTPUT ROUTPUT) Ports: 1 input, 1 output Processing: agnostic Package: app (core) <dl> <dt> </dt> <dd> Creates a new mapping using the PATTERN. Say it returns 9000 as the newsource port.</dd> </dl> <dl> <dt> </dt> <dd> Installs the following mappings into the rewriter:</dd> </dl> <dl> <dt> </dt> <dd> Rewr… text/html 2006-05-19T18:00:37-08:00 http://www.read.cs.ucla.edu/click/elements/ftpportmapper6?rev=1148086837 This is automatically generated documentation. NAME FTPPortMapper6 -- Click element; Translates FTP control commands. SYNOPSIS FTPPortMapper6(TCPAddressTranslator) Ports: 2 inputs, 2 outputs Processing: push Package: ip6_natpt DESCRIPTION Expects FTP control packets. Watches packets for PORT/EPRT, PASV/EPSV commands and their respective responses in IPv4/IPv6 packets. It must be used after after the packets are translated from IPv4 to IPv6 or vice versa, because FTPPortMapper6 tak… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/functiontest?rev=1236475442 This is automatically generated documentation. NAME FunctionTest -- Click element; runs regression tests for other Click functions SYNOPSIS FunctionTest() Ports: none Package: test (core) DESCRIPTION FunctionTest runs regression tests for other Click functions, such as for integer functions, at initialization time. It does not route packets. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/gatewayselector?rev=1140460876 This is automatically generated documentation. NAME GatewaySelector -- Click element; Select a gateway to send a packet to based on TCP connection state and metric to gateway. SYNOPSIS GatewaySelector(IP, ETH, ETHERTYPE, LinkTable, ARPTable, [PERIOD timeout], [GW is_gateway], N<> [METRIC GridGenericMetric]) Ports: 1 input, 1 output Processing: push Package: wifi (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/getip6address?rev=1236475442 This is automatically generated documentation. NAME GetIP6Address -- Click element; SYNOPSIS GetIP6Address(OFFSET) Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) DESCRIPTION Copies 16 bytes from the packet , starting at OFFSET, to the destination IP6 address annotation. The offset is usually 24, to fetch the dst address from an IP6 packet (w/o ether header). The destination address annotation is used by elements that need to know where the packet is going. Such… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/getipaddress?rev=1140460872 This is automatically generated documentation. NAME GetIPAddress -- Click element; sets destination IP address annotation from packet data SYNOPSIS GetIPAddress(OFFSET) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Copies 4 bytes from the packet, starting at OFFSET, to the destination IP address annotation. OFFSET is usually 16, to fetch the destination address from an IP packet. text/html 2006-05-19T18:00:43-08:00 http://www.read.cs.ucla.edu/click/elements/getssrc?rev=1148086843 This is automatically generated documentation. NAME GetSSRC -- Click element; splits packets _possibly_ containing an SSRC field (used by the RTP protocol): this is copied it inside the packet annotation field SYNOPSIS GetSSRC(OFFSET) Ports: 1 input, 2 outputs Processing: Push Package: unibo_qos <dl> <dt> </dt> <dd> Offset (in bytes) of the SSRC field from the beginning of the Ethernet datagram (50 bytes).See also RFC 3550.</dd> </dl> text/html 2006-05-19T18:00:36-08:00 http://www.read.cs.ucla.edu/click/elements/greencap?rev=1148086836 This is automatically generated documentation. NAME GREEncap -- Click element; encapsulates packets in static GRE header SYNOPSIS GREEncap(PROTOCOL, KEYWORDS) Ports: 1 input, 1 output Processing: agnostic Package: @CLICKPACKAGENAME@ DESCRIPTION Encapsulates each incoming packet in a GRE packet with protocol PROTOCOL. This is most useful for GRE-in-IP encapsulation. Keyword arguments are: <dl> <dt> </dt> <dd> Boolean. If true, sets the Checksum Present bit to one and fills theCheck… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/gridencap?rev=1236475441 This is automatically generated documentation. NAME GridEncap -- Click element; Encapsulates packets in static Grid data encapsulation header (GRID_NBR_ENCAP), including ethernet, Grid, and grid data encap headers. SYNOPSIS GridEncap(ETH, IP) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/gridgatewayinfo?rev=1236475441 This is automatically generated documentation. NAME GridGatewayInfo -- Click element; Manage grid node gateway info. SYNOPSIS GridGatewayInfo(ROUTETABLE, IS_GATEWAY) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION GridGatewayInfo performs two functions [probably indicating a bad design!]: first, it determines whether this particular node is a gateway (IS_GATEWAY argument); second, it sets the destinination IP address annotation of incoming packets to… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/gridheaderinfo?rev=1236475442 This is automatically generated documentation. NAME GridHeaderInfo -- Click element; Provide information about Grid header version, header sizes, and offsets for the current router exectuable. SYNOPSIS GridHeaderInfo Ports: None Package: grid (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/gridlocationinfo?rev=1179990969 This is automatically generated documentation. NAME GridLocationInfo -- Click element; SYNOPSIS GridLocationInfo(LATITUDE, LONGITUDE [, HEIGHT, KEYWORDS]) Ports: None Drivers: userlevel Package: grid (core) DESCRIPTION This element implements the GridGenericLocInfo interface. LATITUDE and LONGITUDE are in decimal degrees (Real). Positive is North and East, negative is South and West. HEIGHT is in metres, positive is up. Only 5 fractional digits are used for latitude and longitud… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/gridlocationinfo2?rev=1179990969 This is automatically generated documentation. NAME GridLocationInfo2 -- Click element; SYNOPSIS GridLocationInfo2(LATITUDE, LONGITUDE [, HEIGHT, KEYWORDS]) Ports: None Package: grid (core) DESCRIPTION This element implements the GridGenericLocInfo interface. Unlike GridLocationInfo, this element can work in the kernel. LATITUDE and LONGITUDE are in milliseconds. Positive is North and East, negative is South and West. HEIGHT is in millimetres, positive is up. All are integers. K… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/gridlogger?rev=1179990969 This is automatically generated documentation. NAME GridLogger -- Click element; Log Grid-related events. SYNOPSIS GridLogger(KEYWORDS) Drivers: userlevel Package: grid (core) DESCRIPTION This element provides methods which other Grid components can call to log significant protocol events. Multiple GridLogger elements can co-exist. Keyword arguments are: <dl> <dt> </dt> <dd> String. Filename of binary format log file. If this argument issupplied, the element starts logging to the … text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/gridprobehandler?rev=1236475442 This is automatically generated documentation. NAME GridProbeHandler -- Click element; Handles Grid route probes, producing probe replies SYNOPSIS GridProbeHandler(ETH, IP, LookupLocalGridRoute, LookupGeographicGridRoute, FloodingLocQuerier) Ports: 1 input, 2 outputs Processing: push Drivers: userlevel Package: grid (core) text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/gridprobereplyreceiver?rev=1140460876 This is automatically generated documentation. NAME GridProbeReplyReceiver -- Click element; Receives Grid route probe replies SYNOPSIS GridProbeReplyReceiver(CHANNEL) Ports: 1 input, no outputs Processing: agnostic Drivers: userlevel Package: grid (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/gridprobesender?rev=1236475442 This is automatically generated documentation. NAME GridProbeSender -- Click element; Produces a Grid route probe packet. SYNOPSIS GridProbeSender(ETH, IP) Ports: no inputs, 1 output Processing: push Drivers: userlevel Package: grid (core) <dl> <dt> </dt> <dd> arguments are the destination IP followed by a nonce, e.g: ``18.26.7.111 3242435''</dd> </dl> text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/gridproxy?rev=1236475442 This is automatically generated documentation. NAME GridProxy -- Click element SYNOPSIS GridProxy(IP) Ports: 2 inputs, 2 outputs Processing: push Package: grid (core) DESCRIPTION a simple mobile-ip proxy Input 0: ipip packets from a gateway Input 1: ip packets for a mobile host Output 0: ip packets for the outside world Output 1: ipip packets for current "gateway" machine GridProxy tracks the last gateway a host sent an ip packet through and when it receives packets for that host,… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/gridroutetable?rev=1236475441 This is automatically generated documentation. NAME GridRouteTable -- Click element; Run DSDV-like local routing protocol SYNOPSIS GridRouteTable(TIMEOUT, PERIOD, JITTER, ETH, IP, GridGatewayInfo, LinkTracker, LinkStat [, KEYWORDS]) Ports: 1 input, 1 output Processing: push Drivers: userlevel Package: grid (core) <dl> <dt> </dt> <dd> Integer. The maximum number of hops for which a route shouldpropagate. The default number of hops is 3.</dd> </dl> <dl> <dt> </dt> <dd> String. Th… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/gridtxerror?rev=1179990969 This is automatically generated documentation. NAME GridTxError -- Click element; Reports packet transmission error to Grid logging infrastructure SYNOPSIS GridTxError Ports: 1 input, no outputs Processing: push Package: grid (core) DESCRIPTION Keywords: <dl> <dt> </dt> <dd> GridGenericLogger element. If no LOG is specified in the configuration, no logging will occur.</dd> </dl> text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/hashswitch?rev=1140460874 This is automatically generated documentation. NAME HashSwitch -- Click element; classifies packets by hash of contents SYNOPSIS HashSwitch(OFFSET, LENGTH) Ports: 1 input, 1 or more outputs Processing: push Package: standard (core) DESCRIPTION Can have any number of outputs. Chooses the output on which to emit each packet based on a hash of the LENGTH bytes starting at OFFSET. Could be used for stochastic fair queuing. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/hashtabletest?rev=1236475442 This is automatically generated documentation. NAME HashTableTest -- Click element; runs regression tests for HashTable<K, V> SYNOPSIS HashTableTest() Ports: none Package: test (core) DESCRIPTION HashTableTest runs HashTable regression tests at initialization time. It does not route packets. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/hopcountmetric?rev=1140460876 This is automatically generated documentation. NAME HopcountMetric -- Click element; SYNOPSIS HopcountMetric Ports: None Package: grid (core) DESCRIPTION Child class of GridGenericMetric that implements the minimum hop-count metric. SEE ALSO ETXMetric text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/hostetherfilter?rev=1179990969 This is automatically generated documentation. NAME HostEtherFilter -- Click element; drops Ethernet packets sent to other machines SYNOPSIS HostEtherFilter(ETHER [, DROP_OWN, DROP_OTHER, KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ethernet (core) <dl> <dt> </dt> <dd> Same as the DROP_OWN parameter.</dd> </dl> <dl> <dt> </dt> <dd> Same as the DROP_OTHER parameter.</dd> </dl> <dl> <dt> </dt> <dd> The ethernet header starts OFFSET bytes … text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/hub?rev=1236475441 This is automatically generated documentation. NAME Hub -- Click element; duplicates packets like a hub SYNOPSIS Hub() Ports: any number of inputs, the same number of outputs Processing: push Package: standard (core) DESCRIPTION Hub sends a copy of each input packet out each output port. However, a packet received on input port N is not emitted on output port N. Thus, the element acts sort of like an Ethernet hub (but it is not Ethernet specific). text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/icmp6checksum?rev=1148086841 This is automatically generated documentation. NAME ICMP6Checksum -- Click element; computes ICMP6 messages checksum SYNOPSIS ICMP6Checksum() Ports: 1 input, 1 output Processing: agnostic Package: multicast6 DESCRIPTION Expects an IPv6 packet as input. Caclulates RFC 2463/2460 checksum. text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/icmp6error?rev=1140460875 This is automatically generated documentation. NAME ICMP6Error -- Click element; SYNOPSIS ICMP6Error(IP6ADDR, TYPE, CODE) Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) DESCRIPTION need to rewrite the following comments. Generate an ICMP6 error or redirect packet, with specified TYPE and CODE, in response to an incoming IP6 packet. The output is an IP6/ICMP6 packet. The ICMP6 packet's IP6 source address is set to IP6ADDR. The error packet will include (as payloa… text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/icmperror?rev=1190150828 This is automatically generated documentation. NAME ICMPError -- Click element; generates ICMP error packets SYNOPSIS ICMPError(SRC, TYPE [, CODE, keywords BADADDRS, MTU]) Ports: 1 input, 1 output Processing: agnostic Package: icmp (core) DESCRIPTION Generate an ICMP error packet, with specified TYPE and CODE, in response to an incoming IP packet. The output is an IP/ICMP packet. The ICMP packet's IP source address is set to SRC. The error packet will include (as payload) the orig… text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/icmppingencap?rev=1190150828 This is automatically generated documentation. NAME ICMPPingEncap -- Click element; encapsulates packets in ICMP ping headers SYNOPSIS ICMPPingEncap(SRC, DST [, keyword IDENTIFIER]) Ports: 1 input, 1 output Processing: agnostic Package: icmp (core) <dl> <dt> </dt> <dd> Integer. Determines the ICMP identifier field in emitted pings. Default is0.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the SRC argument.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the DST argument.</dd> </… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/icmppingresponder?rev=1140460874 This is automatically generated documentation. NAME ICMPPingResponder -- Click element; responds to ICMP echo requests SYNOPSIS ICMPPingResponder() Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: icmp (core) text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/icmppingrewriter?rev=1190150829 This is automatically generated documentation. NAME ICMPPingRewriter -- Click element; rewrites ICMP echo requests and replies SYNOPSIS ICMPPingRewriter(SRC, DST, keywords DST_ANNO) Ports: 1-2 inputs, 1-2 outputs Processing: push Package: icmp (core) <dl> <dt> </dt> <dd> Boolean. If true, then set the destination IP address annotation on passingpackets to the rewritten destination address. Default is true.</dd> </dl> text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/icmppingsource?rev=1236475441 This is automatically generated 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) <dl> <dt> </dt> <dd> Amount of time between pings, in seconds. Default is 1.</dd> </dl> <dl> <dt> </dt> <dd> Integer. Determines the ICMP identifier field in emitted pings. Default is0.</dd> </dl> <dl> <dt> </dt> <dd> Inte… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/icmprewriter?rev=1236475441 This is automatically generated documentation. NAME ICMPRewriter -- Click element; rewrites ICMP packets based on IP rewriter mappings SYNOPSIS ICMPRewriter(MAPS, keywords DST_ANNO) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: icmp (core) <dl> <dt> </dt> <dd> Boolean. If true, then set the destination IP address annotation on passingpackets to the rewritten destination address. Default is true.</dd> </dl> text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/idle?rev=1140460873 This is automatically generated documentation. NAME Idle -- Click element; discards packets SYNOPSIS Idle Ports: any number of inputs, any number of outputs Processing: agnostic Package: standard (core) DESCRIPTION Has zero or more agnostic outputs and zero or more agnostic inputs. It never pushes a packet to any output or pulls a packet from any input. Any packet it does receive is discarded. Used to avoid "input not connected" error messages. text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/igmp?rev=1148086840 This is automatically generated documentation. NAME IGMP -- Click element; IPv4 Multicast SYNOPSIS IGMP(IPMulticastTable) Ports: 1 input, 2 outputs Package: multicast DESCRIPTION Handles most of the IGMPv3 protocol (RFC3376). Was tested against Microsoft Windows XP and Linux Vanilla Kernel 2.6.9. IGMPv1 and IGMPv2 join/leave messages are also processed. Queries are IGMPv3 only. This element checks whether an arriving IGMP message is valid (checksum) and takes appropriate actions. I… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/incrementseqno?rev=1179990969 This is automatically generated documentation. NAME IncrementSeqNo -- Click element; SYNOPSIS IncrementSeqNo([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION Store a 32-bit unsigned integer sequence number in packets, at a specified offset. The number is incremented with each packet that passes through the element. Keywords are: <dl> <dt> </dt> <dd> Unsigned integer. Byte offset at which to store sequence number.Defaults to 0.</dd> </dl>… text/html 2006-02-24T10:50:51-08:00 http://www.read.cs.ucla.edu/click/elements/inferipaddrcolors?rev=1140807051 This is automatically generated documentation. NAME InferIPAddrColors -- Click element; Infer a graph-coloring for IP addresses. SYNOPSIS InferIPAddrColors([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Drivers: userlevel Package: models <dl> <dt> </dt> <dd> Boolean. If false, packets are passed through without affecting the coloring.Default is true.</dd> </dl> <dl> <dt> </dt> <dd> Filename. Read this color file for seed colors.</dd> </dl> <dl> <dt> </dt> <dd> Argument… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/infinitesource?rev=1236475442 This is automatically generated documentation. NAME InfiniteSource -- Click element; generates packets whenever scheduled SYNOPSIS InfiniteSource([DATA, LIMIT, BURST, ACTIVE, KEYWORDS]) Ports: no inputs, 1 output Processing: agnostic Package: standard (core) <dl> <dt> </dt> <dd> String. Same as the DATA argument.</dd> </dl> <dl> <dt> </dt> <dd> Integer. If set, the outgoing packet will have this length.</dd> </dl> <dl> <dt> </dt> <dd> Integer. Same as the LIMIT argument.</dd> </dl>… text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/ip6fixpimsource?rev=1148086841 This is automatically generated documentation. NAME IP6FixPIMSource -- Click element; IPv6 Multicast SYNOPSIS IP6FixPIMSource(PIMForwardingTable) Ports: 1 input, 1 output Processing: agnostic Package: multicast6 DESCRIPTION Adds upstream interface IP to PIM join/prune messages and calculates the checksum. text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/ip6fragmenter?rev=1140460872 This is automatically generated documentation. NAME IP6Fragmenter -- Click element; SYNOPSIS IP6Fragmenter(MTU) Ports: 1 input, 1-2 outputs Processing: push Package: ip6 (core) DESCRIPTION Expects IP6 packets as input. If the IP6 packet size is <= mtu, just emits the packet on output 0. If the size is greater than mtu and DF isn't set, splits into fragments emitted on output 0. If DF is set and size is greater than mtu, sends to output 1. Ordinarily output 1 is connected to an ICM… text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/ip6mc_etherencap?rev=1148086840 This is automatically generated documentation. NAME IP6MC_EtherEncap -- Click element; IPv4 Multicast SYNOPSIS IP6MC_EtherEncap(ETHERTYPE, SRC) Package: multicast6 DESCRIPTION Encapsulates each packet in the Ethernet header specified by its arguments and the packet's Multicast IP destination address. ETHERTYPE should be in host order. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/ip6mirror?rev=1140460874 This is automatically generated documentation. NAME IP6Mirror -- Click element; swaps IP6 source and destination SYNOPSIS IP6Mirror Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) DESCRIPTION Incoming packets must have their IP6 header annotations set. Swaps packets' source and destination IP6 addresses. Packets containing TCP or UDP headers---that is, first fragments of packets with protocol 6 or 17---also have their source and destination ports swapped. The TCP… text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/ip6multicasttable?rev=1148086841 This is automatically generated documentation. NAME IP6MulticastTable -- Click element; IPv6 Multicast SYNOPSIS IP6MulticastTable(IP6PIMControl) Ports: 1 input, 2 outputs Package: multicast6 DESCRIPTION Includes data structures to store addresses of receivers of multicast streams (IPv6). Each multicast group entry can hold information about senders and receivers. The data structures is based upon STL containers. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/ip6ndadvertiser?rev=1236475442 This is automatically generated documentation. NAME IP6NDAdvertiser -- Click element; SYNOPSIS IP6NDAdvertiser(IP61 MASK1 ETH1, IP62 MASK2 ETH2, ...) Ports: 1 input, 1 output Processing: agnostic Package: ethernet (core) DESCRIPTION Input should be Neighbor Solitation Message, which includes the ethernet header, ip6 header and message itself. The Neighbor Solitation Message query about the link layer address of an IPv6 target address. If the IP6NDAdvertiser knows the answer, it fo… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ip6ndsolicitor?rev=1236475441 This is automatically generated documentation. NAME IP6NDSolicitor -- Click element; SYNOPSIS IP6NDSolicitor(IP, ETH) Ports: 2 inputs, 1-2 outputs Processing: push Package: ethernet (core) DESCRIPTION Handles most of the Neighbor Discovery(ND) protocol. Argument IP should be this host's IP6 address, and ETH should be this host's ethernet address. Expects ordinary IP6 packets on input 0, each with a destination address annotation. If an ethernet address is already known for the des… text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/ip6pim?rev=1148086841 This is automatically generated documentation. NAME IP6PIM -- Click element; IPv6 Multicast SYNOPSIS IP6PIM(IP6PIMForwardingTable, IP6PIMControl, Interfaceaddress) Ports: 1 input, 2 outputs Package: multicast6 DESCRIPTION Handles PIM messages. Arriving PIM messages are checked and processed. A working Click multicast configuration must have a PIM element attached to each incoming interface. This element manages the IP6PIMForwardingTable. It manages the databank of PIM receivers kept… text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/ip6pimcontrol?rev=1148086840 This is automatically generated documentation. NAME IP6PIMControl -- Click element; IPv6 Multicast SYNOPSIS IP6PIMControl(IP6PIMForwardingTable) Ports: no inputs, 1 output Processing: push Package: multicast6 DESCRIPTION Handles the PIM protocol, i.e. generation of Hello-messages and detection of connected PIM routers. This management information is needed for PIMForwardingTable. text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/ip6pimforwardingtable?rev=1148086840 This is automatically generated documentation. NAME IP6PIMForwardingTable -- Click element; IPv6 Multicast SYNOPSIS IP6PIMForwardingTable() Ports: 1 input, 1 output Processing: push Package: multicast6 DESCRIPTION Takes care of arriving multicast traffic. Streams are duplicated and forwarded to neighbouring routers which are connected to Rendezvous Point or Source Path Trees. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/ip6print?rev=1236475442 This is automatically generated documentation. NAME IP6Print -- Click element; pretty-prints IP6 packets SYNOPSIS IP6Print([TAG, NBYTES, CONTENTS]) Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) DESCRIPTION dumps simple information about ip6 packet. may someday be as good as IPPrint. TAG specifies the label at the head of each line. NBYTES specify how many bytes to print and CONTENTS specify if the content should be printed, in hex. NBYTES and CONTENTS are keywo… text/html 2006-02-24T10:50:51-08:00 http://www.read.cs.ucla.edu/click/elements/ipaddrcolorpaint?rev=1140807051 This is automatically generated documentation. NAME IPAddrColorPaint -- Click element; Sets paint annotations based on destination IP address color. SYNOPSIS IPAddrColorPaint(FILENAME [, KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Drivers: userlevel Package: models <dl> <dt> </dt> <dd> Boolean. If true, then check that the packet's source and destinationaddresses have compatible colors; if not, emit the packet on output 1. Defaultis false.</dd>… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/ipaddresscounter?rev=1140460874 This is automatically generated documentation. NAME IPAddressCounter -- Click element; Count traffic for individual ip addresses. SYNOPSIS IPAddressCounter() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Expects a SR MAC packet as input. Calculates the SR header's checksum and sets the version and checksum header fields. text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/ipaddrpairrewriter?rev=1190150829 This is automatically generated documentation. NAME IPAddrPairRewriter -- Click element; rewrites IP packets' addresses by address pair SYNOPSIS IPAddrPairRewriter(INPUTSPEC1, ..., INPUTSPECn) Ports: 1 or more inputs, 1-256 outputs Processing: push Package: ip (core) <dl> <dt> </dt> <dd> These INPUTSPECs behave like those in .</dd> </dl> <dl> <dt> </dt> <dd> Creates a mapping according to the given pattern, 'SADDR DADDR'. Eitherpattern field may be a dash '-', in which case the cor… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/ipaddrrewriter?rev=1190150829 This is automatically generated documentation. NAME IPAddrRewriter -- Click element; rewrites IP packets' addresses SYNOPSIS IPAddrRewriter(INPUTSPEC1, ..., INPUTSPECn) Ports: 1 or more inputs, 1-256 outputs Processing: push Package: ip (core) <dl> <dt> </dt> <dd> These INPUTSPECs behave like those in .</dd> </dl> <dl> <dt> </dt> <dd> Creates a mapping according to the given pattern. The destinationaddress must be a dash '-', since IPAddrRewriter only changes outgoingpackets' sourc… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/ipclassifier?rev=1179990969 This is automatically generated documentation. NAME IPClassifier -- Click element; classifies IP packets by contents SYNOPSIS IPClassifier(PATTERN_1, ..., PATTERN_N) Ports: 1 input, any number of outputs Processing: push Package: ip (core) <dl> <dt> </dt> <dd> PROTO is an IP protocol name (see below) or a valid IP protocol number.Matches packets of the given protocol.</dd> </dl> <dl> <dt> </dt> <dd> IPADDR is an IP address and SRCORDST is 'src', 'dst', 'src or dst', or 'srcand dst'.… text/html 2006-05-19T18:00:36-08:00 http://www.read.cs.ucla.edu/click/elements/ipcp?rev=1148086836 This is automatically generated documentation. NAME IPCP -- Click element; PPP IP Control Protocol (IPCP) Element. SYNOPSIS IPCP([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: @CLICKPACKAGENAME@ DESCRIPTION Expects PPP packets as input. Packets not of protocol type 0x8021 (PPP_IPCP) are silently discarded. Outputs PPP_IPCP packets as required, which should be routed to the peer from which the input packets were received. Keyword arguments are: <dl> <dt> </dt> <… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/ipencap?rev=1190150829 This is automatically generated documentation. NAME IPEncap -- Click element; encapsulates packets in static IP header SYNOPSIS IPEncap(PROTO, SRC, DST, KEYWORDS) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Encapsulates each incoming packet in an IP packet with protocol PROTO, source address SRC, and destination address DST. This is most useful for IP-in-IP encapsulation. Its destination address annotation is also set to DST. As a special case, if … text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/ipfilter?rev=1179990969 This is automatically generated documentation. NAME IPFilter -- Click element; filters IP packets by contents SYNOPSIS IPFilter(ACTION_1 PATTERN_1, ..., ACTION_N PATTERN_N) Ports: 1 input, any number of outputs Processing: push Package: ip (core) <dl> <dt> </dt> <dd> Returns a human-readable definition of the program the IPFilter elementis using to classify packets. At each step in the program, four bytesof packet data are ANDed with a mask and compared against four bytes ofclassifie… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ipflowrawsockets?rev=1236475441 This is automatically generated documentation. NAME IPFlowRawSockets -- Click element; creates separate sockets for each TCP/UDP flow SYNOPSIS IPFlowRawSockets([KEYWORDS]) Ports: 1 input, 1 output Drivers: userlevel Package: userlevel (core) <dl> <dt> </dt> <dd> The name of an AggregateNotifier element, like . If given,then IPFlowRawSockets will ask the element for notification when flows aredeleted. It uses that notification to free its state early. It's a very goodidea to supply a … text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/ipfragmenter?rev=1236475442 This is automatically generated documentation. NAME IPFragmenter -- Click element; fragments large IP packets SYNOPSIS IPFragmenter(MTU, [keywords HONOR_DF, VERBOSE]) Ports: 1 input, 1-2 outputs Processing: push Package: ip (core) DESCRIPTION Expects IP packets as input. If the IP packet size is <= MTU, just emits the packet on output 0. If the size is greater than MTU and the don't-fragment bit (DF) isn't set, IPFragmenter splits the packet into fragments emitted on output 0. If … text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/ipgwoptions?rev=1140460874 This is automatically generated documentation. NAME IPGWOptions -- Click element; processes router IP options SYNOPSIS IPGWOptions(MYADDR [, OTHERADDRS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ip (core) text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/ipinputcombo?rev=1140460874 This is automatically generated documentation. NAME IPInputCombo -- Click element; input combo for IP routing SYNOPSIS IPInputCombo(COLOR [, BADSRC, keywords INTERFACES, BADSRC, GOODDST]) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/ipmirror?rev=1140460873 This is automatically generated documentation. NAME IPMirror -- Click element; swaps IP source and destination SYNOPSIS IPMirror Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Incoming packets must have their IP header annotations set. Swaps packets' source and destination IP addresses. Packets containing TCP or UDP headers---that is, first fragments of packets with protocol 6 or 17---also have their source and destination ports swapped. TCP packets a… text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/ipmulticastetherencap?rev=1148086840 This is automatically generated documentation. NAME IPMulticastEtherEncap -- Click element; IPv4 Multicast SYNOPSIS IPMulticastEtherEncap(ETHERTYPE, SRC) Ports: 1 input, 1 output Processing: agnostic Package: multicast DESCRIPTION Encapsulates each packet in the Ethernet header specified by its arguments and the packet's Multicast IP destination address. ETHERTYPE should be in host order. text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/ipmulticasttable?rev=1148086840 This is automatically generated documentation. NAME IPMulticastTable -- Click element; IPv4 Multicast SYNOPSIS IPMulticastTable(PIMControl) Ports: 1 input, 2 outputs Package: multicast DESCRIPTION Includes data structures to store addresses of receivers of multicast streams (IPv4). Each multicast group entry can hold information about senders and receivers. The data structures is based upon STL containers. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ipnameinfo?rev=1236475441 This is automatically generated documentation. NAME IPNameInfo -- Click element; stores name information about IP packets SYNOPSIS IPNameInfo() Ports: none Package: ip (core) DESCRIPTION Contains IP-related name mappings, such as the names for common IP protocols. This element should not be used in configurations. IPNameInfo installs the following name mappings by default: IP protocols: dccp, icmp, igmp, ipip, payload, sctp, tcp, tcpudp, transp, udp. TCP/UDP ports: auth, bootpc, boo… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/ipoutputcombo?rev=1140460876 This is automatically generated documentation. NAME IPOutputCombo -- Click element; output combo for IP routing SYNOPSIS IPOutputCombo(COLOR, IPADDR, MTU) Ports: 1 input, 5 outputs Processing: push Package: ip (core) DESCRIPTION A single element encapsulating common tasks on an IP router's output path. Effectively equivalent to text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ipprint?rev=1236475441 This is automatically generated documentation. NAME IPPrint -- Click element; pretty-prints IP packets SYNOPSIS IPPrint([LABEL, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Expects IP packets as input. Should be placed downstream of a CheckIPHeader or equivalent element. Prints out IP packets in a human-readable tcpdump-like format, preceded by the LABEL text. Keyword arguments are: <dl> <dt> </dt> <dd> Determines whether the packet data… text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/ipratemonitor?rev=1190150828 This is automatically generated documentation. NAME IPRateMonitor -- Click element; measures coming and going IP traffic rates SYNOPSIS IPRateMonitor(TYPE, RATIO, THRESH [, MEMORY, ANNO]) Ports: 1-2 inputs, 1-2 outputs Processing: agnostic Drivers: userlevel Package: ip (core) <dl> <dt> </dt> <dd> Returns the rate of counted to and from a cluster of IP addresses. The firstprinted line is the number of 'jiffies' that have past since the last reset.There are 100 jiffies in one second… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/ipreassembler?rev=1236475442 This is automatically generated documentation. NAME IPReassembler -- Click element; Reassembles fragmented IP packets SYNOPSIS IPReassembler([KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ip (core) <dl> <dt> </dt> <dd> The upper bound for memory consumption, in bytes. Default is 256K.</dd> </dl> text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/iprewriter?rev=1179990969 This is automatically generated documentation. NAME IPRewriter -- Click element; rewrites TCP/UDP packets' addresses and ports SYNOPSIS IPRewriter(INPUTSPEC1, ..., INPUTSPECn [, keywords]) Ports: 1 or more inputs, 1-256 outputs Processing: push Package: tcpudp (core) <dl> <dt> </dt> <dd> Discards input packets.</dd> </dl> <dl> <dt> </dt> <dd> Sends input packets to output port OUTPUT. No mappings are installed.</dd> </dl> <dl> <dt> </dt> <dd> Installs mappings that preserve the in… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/iprewriterpatterns?rev=1140460873 This is automatically generated documentation. NAME IPRewriterPatterns -- Click element; specifies shared IPRewriter patterns SYNOPSIS IPRewriterPatterns(NAME PATTERN, ...) Ports: none Package: ip (core) DESCRIPTION This element stores information about shared patterns that IPRewriter and related elements can use. Each configuration argument is a name and a pattern, 'NAME SADDR SPORT DADDR DPORT'. The NAMEs for every argument in every IPRewriterPatterns element in the configuratio… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/iproutetable?rev=1236475441 This is automatically generated documentation. NAME IPRouteTable -- Click element; IP routing table superclass SYNOPSIS IPRouteTable Package: ip (core) DESCRIPTION IPRouteTable defines an interface useful for implementing IPv4 route lookup elements. It parses configuration strings -- see LinearIPLookup for an example -- and calls virtual functions to add the resulting routes. A default push function uses those virtual functions to look up routes and output packets accordingly. There a… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ipsecaes?rev=1236475441 This is automatically generated documentation. NAME IPsecAES -- Click element; encrypt packet using DES-CBC SYNOPSIS IPsecAES(ENCRYPT) Ports: 1 input, 1 output Processing: agnostic Package: ipsec (core) DESCRIPTION Encrypts or decrypts packet using DES-CBC. If the first argument is 0, IPsecAES will decrypt. If the first argument is 1, IPsecAES will encrypt. KEY is the DES secret key. Gets IV value from ESP header. IGNORE is the number of bytes at the end of the payload to ignore. … text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ipsecauthhmacsha1?rev=1236475441 This is automatically generated documentation. NAME IPsecAuthHMACSHA1 -- Click element; verify SHA1 authentication digest. SYNOPSIS IPsecAuthHMACSHA1(VERIFY) Ports: 1 input, any number of outputs Processing: agnostic Package: ipsec (core) DESCRIPTION If first argument is 0, computes SHA1 authentication digest for ESP packet per RFC 2404, 2406. If first argument is 1, verify SHA1 digest and remove authentication bits. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ipsecauthsha1?rev=1236475441 This is automatically generated documentation. NAME IPsecAuthSHA1 -- Click element; verify SHA1 authentication digest. SYNOPSIS IPsecAuthSHA1(VERIFY) Ports: 1 input, any number of outputs Processing: agnostic Package: ipsec (core) DESCRIPTION If first argument is 0, computes SHA1 authentication digest for ESP packet per RFC 2404, 2406. If first argument is 1, verify SHA1 digest and remove authentication bits. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/ipsecdes?rev=1236475442 This is automatically generated documentation. NAME IPsecDES -- Click element; encrypt packet using DES-CBC SYNOPSIS IPsecDES(ENCRYPT, KEY [, IGNORE]) Ports: 1 input, 1 output Processing: agnostic Package: ipsec (core) DESCRIPTION Encrypts or decrypts packet using DES-CBC. If the first argument is 0, IPsecDES will decrypt. If the first argument is 1, IPsecDES will encrypt. KEY is the DES secret key. Gets IV value from ESP header. IGNORE is the number of bytes at the end of the pay… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ipsecencap?rev=1236475441 This is automatically generated documentation. NAME IPsecEncap -- Click element; encapsulates packets in static IP header SYNOPSIS IPsecEncap(PROTO, SRC, DST, KEYWORDS) Ports: 1 input, 1 output Processing: agnostic Package: ipsec (core) DESCRIPTION Encapsulates each incoming packet in an IP packet with protocol PROTO, source address SRC, and destination address DST. This is most useful for IP-in-IP encapsulation. Its destination address annotation is also set to DST. Keyword argum… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/ipsecespencap?rev=1140460875 This is automatically generated documentation. NAME IPsecESPEncap -- Click element; apply IPSec encapsulation SYNOPSIS IPsecESPEncap(SPI) Ports: 1 input, 1 output Processing: agnostic Package: ipsec (core) DESCRIPTION Adds IPsec ESP header to packet. assign SPI as the security parameters index. Block size is set to 8 bytes. The packet will be padded to be multiples of 8 bytes. Padding uses the default padding scheme specified in RFC 2406: pad[0] = 1, pad[1] = 2, pad[2] = 3, etc. T… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/ipsecespunencap?rev=1140460873 This is automatically generated documentation. NAME IPsecESPUnencap -- Click element; removes IPSec encapsulation SYNOPSIS IPsecESPUnencap() Ports: 1 input, 1 output Processing: agnostic Package: ipsec (core) DESCRIPTION Removes ESP header added by IPsecESPEncap. see RFC 2406. Does not perform the optional anti-replay attack checks. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ipsecroutetable?rev=1236475441 This is automatically generated documentation. NAME IPsecRouteTable -- Click element; IP routing table superclass SYNOPSIS IPsecRouteTable Package: ipsec (core) DESCRIPTION IPsecRouteTable defines an interface useful for implementing IPv4 route lookup elements. It parses configuration strings -- see LinearIPLookup for an example -- and calls virtual functions to add the resulting routes. A default push function uses those virtual functions to look up routes and output packets accordin… text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/kernelfilter?rev=1190150828 This is automatically generated documentation. NAME KernelFilter -- Click element; block kernel from handling packets SYNOPSIS KernelFilter(FILTERSPEC, ...) Ports: none Drivers: userlevel Package: userlevel (core) DESCRIPTION The KernelFilter element installs filter rules in the kernel to stop the kernel from handling certain types of packets. Use this in combination with FromDevice.u to handle packets in user-level Click configurations. KernelFilter uses iptables(1) to install f… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/kernelhandlerproxy?rev=1179990969 This is automatically generated documentation. NAME KernelHandlerProxy -- Click element; proxies kernel module handlers at user level SYNOPSIS KernelHandlerProxy([KEYWORDS]) Drivers: userlevel Package: userlevel (core) DESCRIPTION Provides one proxy handler for each handler in a Linux kernel module Click configuration. The proxy handler for an element e's handler h is named `e.h'. Reading KernelHandlerProxy's e.h handler will return the result of reading kernel element e's h handler… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/kerneltap?rev=1236475441 This is automatically generated documentation. NAME KernelTap -- Click element; interface to /dev/tap or ethertap (user-level) SYNOPSIS KernelTap(ADDR/MASK [, GATEWAY, keywords ETHER, MTU, HEADROOM, IGNORE_QUEUE_OVERFLOWS]) Ports: at most 1 input, 1-2 outputs Drivers: userlevel Package: userlevel (core) <dl> <dt> </dt> <dd> Ethernet address. Specifies the fake device's Ethernet address. Default is00:01:02:03:04:05. On Linux, you must supply an ETHER argument, and use thataddress as t… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/kerneltun?rev=1236475441 This is automatically generated documentation. NAME KernelTun -- Click element; interface to /dev/tun or ethertap (user-level) SYNOPSIS KernelTun(ADDR/MASK [, GATEWAY, keywords HEADROOM, ETHER, MTU, IGNORE_QUEUE_OVERFLOWS]) Ports: at most 1 input, 1-2 outputs Drivers: userlevel Package: userlevel (core) <dl> <dt> </dt> <dd> Integer. The number of bytes left empty before the packet data to leaveroom for additional encapsulation headers. Default is 28.</dd> </dl> <dl> <dt> </dt> <dd> … text/html 2006-05-19T18:00:36-08:00 http://www.read.cs.ucla.edu/click/elements/lcp?rev=1148086836 This is automatically generated documentation. NAME LCP -- Click element; PPP Link Control Protocol (LCP) Element. SYNOPSIS LCP([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: @CLICKPACKAGENAME@ DESCRIPTION Expects PPP packets as input. Packets not of protocol type 0xc021 (PPP_LCP) are answered with an LCP Protocol Rejection. Outputs PPP_LCP packets as required, which should be routed to the peer from which the input packets were received. Keyword arguments are:… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/lineariplookup?rev=1179990969 This is automatically generated documentation. NAME LinearIPLookup -- Click element; simple IP routing table SYNOPSIS LinearIPLookup(ADDR1/MASK1 [GW1] OUT1, ADDR2/MASK2 [GW2] OUT2, ...) Ports: 1 input, any number of outputs Processing: push Package: ip (core) <dl> <dt> </dt> <dd> Outputs a human-readable version of the current routing table.</dd> </dl> <dl> <dt> </dt> <dd> Reports the OUTput port and GW corresponding to an address.</dd> </dl> <dl> <dt> </dt> <dd> Adds a route to th… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/linkfailuredetection?rev=1140460872 This is automatically generated documentation. NAME LinkFailureDetection -- Click element; Calls a handler after a certain number of successfive transmit failures. SYNOPSIS LinkFailureDetection(THRESHOLD, HANDLER) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) <dl> <dt> </dt> <dd> Unsigned integer. Number of failures before HANLDER is called</dd> </dl> <dl> <dt> </dt> <dd> The write handler to call when a link failure is detected.This handler will be called with … text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/linkstat?rev=1236475441 This is automatically generated documentation. NAME LinkStat -- Click element; Track broadcast loss rates. SYNOPSIS LinkStat([KEYWORDS]) Ports: 1 input, at most 1 output Processing: push Package: grid (core) DESCRIPTION Expects Link probe packets as input. Records the last WINDOW unique (not neccessarily sequential) sequence numbers of link probes from each host, and calculates loss rates over the last TAU milliseconds for each host. If the output is connected, sends probe packe… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/linktable?rev=1236475441 This is automatically generated documentation. NAME LinkTable -- Click element; Keeps a Link state database and calculates Weighted Shortest Path for other elements SYNOPSIS LinkTable(IP Address, [STALE timeout]) Ports: none Package: wifi (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/linktester?rev=1236475442 This is automatically generated documentation. NAME LinkTester -- Click element; SYNOPSIS LinkTester(SRC, DST [, KEYWORDS]) Ports: no inputs, 1 output Processing: push Drivers: userlevel Package: grid (core) DESCRIPTION Send experimental packets over wireless link to test link characteristics. Packets are sent with source and destination ethernet address SRC_ETH and DST_ETH. The ethernet type code is set to 0x7eee. Keyword arguments are: <dl> <dt> </dt> <dd> Integer. When to … text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/linktestreceiver?rev=1236475442 This is automatically generated documentation. NAME LinkTestReceiver -- Click element; SYNOPSIS LinkTestReceiver([AIROINFO]) Ports: 1 input, 1 output Processing: agnostic Drivers: userlevel Package: grid (core) DESCRIPTION Expects packets sent by LinkTester as input. Print packet header contents. If the optional AiroInfo element argument is suplied, queries card for and prints signal and noise information for each packet. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/linktracker?rev=1140460876 This is automatically generated documentation. NAME LinkTracker -- Click element; SYNOPSIS LinkTracker(TAU) Ports: 1 input, 1 output Processing: agnostic Drivers: userlevel, ns Package: grid (core) DESCRIPTION Expects Grid packets as input. Extracts ping-ponged link stat info from unicast packet headers and incorporates it into running averages. TAU is the time constant to use for the exponential decay averaging, in milliseconds. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/linkunqueue?rev=1179990969 This is automatically generated documentation. NAME LinkUnqueue -- Click element; link emulator SYNOPSIS LinkUnqueue(LATENCY, BANDWIDTH) Ports: 1 input, 1 output Processing: pull inputs, push outputs Package: standard (core) DESCRIPTION Pulls packets from the single input port, then delays them so as to emulate a serial link with latency LATENCY (microsecond precision) and bandwidth BANDWIDTH (such as "384kbps"). Thus, every packet is delayed at least by LATENCY, and additionally … text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/linuxiplookup?rev=1140460874 This is automatically generated documentation. NAME LinuxIPLookup -- Click element; interface to Linux's routing table SYNOPSIS LinuxIPLookup(if0, if1, ..., ifN) Ports: 1 input, 1 or more outputs Processing: agnostic Drivers: userlevel Package: ip (core) text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/lirmetric?rev=1140460876 This is automatically generated documentation. NAME LIRMetric -- Click element; SYNOPSIS LIRMetric(GridGenericRouteTable) Ports: None Package: grid (core) DESCRIPTION Child class of GridGenericMetric that implements the `Least Interference Routing' metric. The metric is the sum of the number 1-hop neighbors of each node in the route. This node's number of 1-hop neighbors is obtained from the GridGenericRouteTable argument. Smaller metric values are better. LIR is described in `Sp… text/html 2006-03-02T23:07:27-08:00 http://www.read.cs.ucla.edu/click/elements/listenetherswitch?rev=1141369647 This is automatically generated documentation. NAME ListenEtherSwitch -- Click element; learning, forwarding Ethernet switch with listen port SYNOPSIS ListenEtherSwitch([keywords TIMEOUT]) Ports: any number of inputs, 1 more output Processing: push Package: etherswitch (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/listtest?rev=1236475442 This is automatically generated documentation. NAME ListTest -- Click element; runs regression tests for List<T, link> SYNOPSIS ListTest() Ports: none Package: test (core) DESCRIPTION ListTest runs List regression tests at initialization time. It does not route packets. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/localbroadcast?rev=1140460874 This is automatically generated documentation. NAME LocalBroadcast -- Click element; Floods a packet to 1-hop neighbors. SYNOPSIS LocalBroadcast(IP, ETH, ETHERTYPE, LocalBroadcast element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/locationtable?rev=1179990969 This is automatically generated documentation. NAME LocationTable -- Click element; SYNOPSIS LocationTable(IP LAT LON ERR, ...) Ports: None Drivers: userlevel Package: grid (core) DESCRIPTION LAT and LON are in decimal degrees (Real). Positive is North and East, negative is South and West. ERR is the integer error radius, in meters. A negative rror radius means don't ever believe this entry. There can be multiple arguments, but each argument's IP address must be unique. <dl> <… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/locfromfile?rev=1140460873 This is automatically generated documentation. NAME LocFromFile -- Click element; SYNOPSIS LocFromFile(filename) Drivers: userlevel Package: grid (core) DESCRIPTION Pretends to be a GridLocationInfo element, but actually reads the locations from a file. Each line of the file looks like text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/locqueryresponder?rev=1140460876 This is automatically generated documentation. NAME LocQueryResponder -- Click element; generates responses to Grid Location queries SYNOPSIS LocQueryResponder(E, I) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION E and I are this node's ethernet and IP addresses, respectively. Input should be Grid location query packets destined for us, including the MAC header. Produces a GRID_LOC_REPLY packet with the correct destination IP and location informati… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/lookupgeographicgridroute?rev=1236475441 This is automatically generated documentation. NAME LookupGeographicGridRoute -- Click element; SYNOPSIS LookupGeographicGridRoute(ETH, IP, GRIDROUTES, LOCINFO) Ports: 1 input, 2 outputs Processing: push Drivers: userlevel Package: grid (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/lookupip6route?rev=1236475441 This is automatically generated documentation. NAME LookupIP6Route -- Click element; SYNOPSIS LookupIP6Route(DST1 MASK1 GW1 OUT1, DST2 MAS2 GW2 OUT2, ...) Ports: 1 input, any number of outputs Processing: push Package: ip6 (core) DESCRIPTION Input: IP6 packets (no ether header). Expects a destination IP6 address annotation with each packet. Looks up the address, sets the destination annotation to the corresponding GW (if non-zero), and emits the packet on the indicated OUTput. Eac… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/lookupiproutemp?rev=1140460875 This is automatically generated documentation. NAME LookupIPRouteMP -- Click element; simple static IP routing table SYNOPSIS LookupIPRouteMP(DST1/MASK1 [GW1] OUT1, DST2/MASK2 [GW2] OUT2, ...) Ports: 1 input, any number of outputs Processing: agnostic Drivers: linuxmodule Package: ip (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/lookuplocalgridroute?rev=1236475441 This is automatically generated documentation. NAME LookupLocalGridRoute -- Click element; SYNOPSIS LookupLocalGridRoute(ETH, IP, GenericGridRouteTable, KEYWORDS) Ports: 2 inputs, 4 outputs Processing: push Package: grid (core) DESCRIPTION Forward packets according to the tables accumulated by the GenericGridRouteTable element. MAC-ADDRESS and IP-ADDRESS are the local machine's addresses. Input 0 is from the device, output 0 is to the device. Both should be GRID_NBR_ENCAP packet… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/lookuplocalgridroute2?rev=1236475441 This is automatically generated documentation. NAME LookupLocalGridRoute2 -- Click element; Grid SYNOPSIS LookupLocalGridRoute2(ETH, IP, GenericGridRouteTable, KEYWORDS) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION Forward packets according to the tables accumulated by the GenericGridRouteTable element. ETH and IP are this node's ethernet and IP addresses, respectively. Inputs must be GRID_NBR_ENCAP packets with MAC headers, with the destination I… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/madwifirate?rev=1140460875 This is automatically generated documentation. NAME MadwifiRate -- Click element; Madwifi wireless bit-rate selection algorithm SYNOPSIS MadwifiRate([KEYWORDS]) Ports: 2 inputs, at most 2 outputs Package: wifi (core) DESCRIPTION Rate Control present in the Madwifi driver (<http://sourceforge.net/project/madwifi>). text/html 2007-01-27T23:35:02-08:00 http://www.read.cs.ucla.edu/click/elements/maptrw?rev=1169969702 This is automatically generated documentation. NAME MapTRW -- Click element; This is a packet processor for approximate TRW SYNOPSIS MapTRW(IP/MASK, ETHADDR, keywords) Ports: 2 inputs, 4 outputs Processing: push Package: security DESCRIPTION This module implements approximate TRW scan detection. It is designed to be a push-only module. It takes two input streams and has four output streams. The first two output streams correspond to the two inputs for normal passing of packets. … text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/markip6header?rev=1140460873 This is automatically generated documentation. NAME MarkIP6Header -- Click element; SYNOPSIS MarkIP6Header([OFFSET]) Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) DESCRIPTION Marks packets as IP6 packets by setting the IP6 Header annotation. The IP6 header starts OFFSET bytes into the packet. Default OFFSET is 0. Does not check length fields for sanity or shorten packets to the IP length; use CheckIPHeader or CheckIPHeader2 for that. text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/markipce?rev=1140460875 This is automatically generated documentation. NAME MarkIPCE -- Click element; sets IP packets' ECN field to Congestion Experienced SYNOPSIS MarkIPCE() Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Expects IP packets as input. Sets each incoming packet's ECN field to Congestion Experienced (value 3), incrementally recalculates the IP checksum, and passes the packet to output 0. Non-IP packets, and IP packets whose ECN field is zero (not ECN-capable),… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/markipheader?rev=1140460876 This is automatically generated documentation. NAME MarkIPHeader -- Click element; sets IP header annotation SYNOPSIS MarkIPHeader([OFFSET]) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Marks packets as IP packets by setting the IP Header annotation. The IP header starts OFFSET bytes into the packet. Default OFFSET is 0. Does not check length fields for sanity, shorten packets to the IP length, or set the destination IP address annotation. Use Check… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/message?rev=1140460876 This is automatically generated documentation. NAME Message -- Click element; prints a message on configuration SYNOPSIS Message(MESSAGE [, TYPE]) Ports: none Package: standard (core) DESCRIPTION The Message element prints a message, warning, or error when configured. It can be used to provide configuration-level documentation. The MESSAGE argument is the message (a string); TYPE should be MESSAGE, WARNING, or ERROR. The default is MESSAGE. If TYPE is ERROR the router will fail t… text/html 2007-05-24T00:09:21-08:00 http://www.read.cs.ucla.edu/click/elements/meter?rev=1179990561 This is automatically generated documentation. NAME Meter -- Click element; classifies packet stream by rate (pkt/s) SYNOPSIS Meter(RATE1, RATE2, ..., RATEn) Ports: 1 input, 2 or more outputs Processing: push Package: standard (core) DESCRIPTION Classifies packets based on the rate of packet arrival. The rate is measured in packets per second using an exponential weighted moving average. (The related BandwidthMeter element measures rates in bytes per second.) The configuration str… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/metricflood?rev=1140460874 This is automatically generated documentation. NAME MetricFlood -- Click element; Floods a packet with previous hops based on Link Metrics. SYNOPSIS MetricFlood(IP, ETH, ETHERTYPE, MetricFlood element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/mixedqueue?rev=1236475442 This is automatically generated documentation. NAME MixedQueue -- Click element; stores packets in a FIFO/LIFO queue SYNOPSIS MixedQueue MixedQueue(CAPACITY) Ports: 2 inputs, 1-2 outputs Package: standard (core) DESCRIPTION Stores incoming packets in a mixed first-in-first-out/last-in-first-out queue. In particular, MixedQueue's first input is FIFO, but its second input is LIFO. The queue is full when it holds CAPACITY packets. When full, MixedQueue drops incoming FIFO packets, but… text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/mld?rev=1148086840 This is automatically generated documentation. NAME MLD -- Click element; IPv6 Multicast SYNOPSIS MLD(IP6MulticastTable) Ports: 1 input, 2 outputs Package: multicast6 DESCRIPTION Handles most of the MLD protocol (RFC2710, RFC3810). Was tested against Microsoft Windows XP and Linux Vanilla Kernel 2.6.9. MLD join/leave messages are also processed. Queries are MLDv2 only. This element checks whether an arriving MLD message is valid (checksum) and takes appropriate actions. It manages … text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/movementsimulator?rev=1140460874 This is automatically generated documentation. NAME MovementSimulator -- Click element; SYNOPSIS MovementSimulator(T NODE-EL V-LAT V-LON, ...) Ports: None Drivers: userlevel Package: grid (core) DESCRIPTION Generate programmed movement in Click-embedded Grid network simulations. Each argument tuple specifies a new velocity for the GridLocationInfo element NODE-EL at time T milliseconds, with new latitude velocity of V-LAT degree per second, and new longitude velocity of V-LON deg… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/msqueue?rev=1236475441 This is automatically generated documentation. NAME MSQueue -- Click element; stores packets in a FIFO queue SYNOPSIS MSQueue MSQueue(CAPACITY) Ports: 1 input, 1-2 outputs Package: standard (core) DESCRIPTION Stores incoming packets in a multiple producer single consumer first-in-first-out queue. Enqueue operations are synchronized, dequeue operations are not. Drops incoming packets if the queue already holds CAPACITY packets. The default for CAPACITY is 1000. <dl> <dt> </dt> <dd> … text/html 2006-02-24T10:50:51-08:00 http://www.read.cs.ucla.edu/click/elements/multiq?rev=1140807051 This is automatically generated documentation. NAME MultiQ -- Click element; calculates capacity information using EMG SYNOPSIS MultiQ([keywords TCPCOLLECTOR, RAW_TIMESTAMP, MIN_SCALE]) Ports: at most 1 input, the same number of outputs Processing: agnostic Drivers: userlevel Package: models <dl> <dt> </dt> <dd> The name of a element.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If true, then input packet timestamps are used raw (MultiQ will notcalculate interarrivals). Default is … text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/netflowexport?rev=1148086841 This is automatically generated documentation. NAME NetflowExport -- Click element; generates Cisco NetFlow and IETF IPFIX records SYNOPSIS NetflowExport(NOTIFIER, [KEYWORDS]) Ports: 1 input, 1 output Processing: push Drivers: userlevel Package: netflow <dl> <dt> </dt> <dd> Integer. Version of Netflow records to generate.</dd> </dl> <dl> <dt> </dt> <dd> (V9 and IPFIX only). Integer. Source identifier. Default is a randomnumber between 0 and 65535.</dd> </dl> <dl> <dt> </dt> <dd> … text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/netflowprint?rev=1148086841 This is automatically generated documentation. NAME NetflowPrint -- Click element; prints human-readable summary of Cisco NetFlow packets SYNOPSIS NetflowPrint([TAG, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: netflow <dl> <dt> </dt> <dd> Boolean. Determines whether to print individual flow records or not. Defaultis false.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. Determines whether output should be very verbose or not. Defaultis false.</dd> </dl> <dl> <dt> <… text/html 2006-05-19T18:00:41-08:00 http://www.read.cs.ucla.edu/click/elements/netflowtemplatecache?rev=1148086841 This is automatically generated documentation. NAME NetflowTemplateCache -- Click element; caches Netflow V9/IPFIX template records SYNOPSIS NetflowTemplateCache([TAG, KEYWORDS]) Ports: None Package: netflow DESCRIPTION Caches Netflow V9/IPFIX template records so that templated packets can be parsed. Specify this element as a keyword to Netflow parsing elements such as NetflowPrint if you want to be able to parse Netflow V9/IPFIX data records. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/notifierdebug?rev=1236475441 This is automatically generated documentation. NAME NotifierDebug -- Click element; useful for debugging notification SYNOPSIS NotifierDebug() Ports: 1 input, 1 output Processing: agnostic Package: test (core) DESCRIPTION Responds to each packet by pushing it unchanged out its first output. The purpose of this element is that it provides a "signal" handler, which reports the unparsed version of the appropriate notification signal. If the element is in a push context, this is the… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/notifierqueue?rev=1236475441 This is automatically generated documentation. NAME NotifierQueue -- Click element; stores packets in a FIFO queue SYNOPSIS NotifierQueue NotifierQueue(CAPACITY) Ports: 1 input, 1-2 outputs Package: standard (core) DESCRIPTION Stores incoming packets in a first-in-first-out queue. Drops incoming packets if the queue already holds CAPACITY packets. The default for CAPACITY is 1000. NotifierQueue notifies interested parties when it becomes empty and when a formerly-empty queue receiv… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/null?rev=1140460872 This is automatically generated documentation. NAME Null -- Click element; passes packets unchanged SYNOPSIS Null Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Just passes packets along without doing anything else. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/null1?rev=1140460874 This is automatically generated documentation. NAME Null1 -- Click element; copy of Null SYNOPSIS Null1() ... Null8() Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION The elements Null1 through Null8 are reimplementations of Null. However, each has independent code, so the i-cache cost of using all eight elements (Null1 through Null8) is eight times the cost of eight Null elements. text/html 2006-02-16T01:42:03-08:00 http://www.read.cs.ucla.edu/click/elements/null2?rev=1140082923 This is automatically generated documentation. NAME Null1, Null2, Null3, Null4, Null5, Null6, Null7, Null8 -- Click elements; copy of .M Null "n" SYNOPSIS Null1() Null2() Null3() Null4() Null5() Null6() Null7() Null8() PACKAGE default text/html 2006-02-16T01:42:03-08:00 http://www.read.cs.ucla.edu/click/elements/null3?rev=1140082923 This is automatically generated documentation. NAME Null1, Null2, Null3, Null4, Null5, Null6, Null7, Null8 -- Click elements; copy of .M Null "n" SYNOPSIS Null1() Null2() Null3() Null4() Null5() Null6() Null7() Null8() PACKAGE default text/html 2006-02-16T01:42:03-08:00 http://www.read.cs.ucla.edu/click/elements/null4?rev=1140082923 This is automatically generated documentation. NAME Null1, Null2, Null3, Null4, Null5, Null6, Null7, Null8 -- Click elements; copy of .M Null "n" SYNOPSIS Null1() Null2() Null3() Null4() Null5() Null6() Null7() Null8() PACKAGE default text/html 2006-02-16T01:42:03-08:00 http://www.read.cs.ucla.edu/click/elements/null5?rev=1140082923 This is automatically generated documentation. NAME Null1, Null2, Null3, Null4, Null5, Null6, Null7, Null8 -- Click elements; copy of .M Null "n" SYNOPSIS Null1() Null2() Null3() Null4() Null5() Null6() Null7() Null8() PACKAGE default text/html 2006-02-16T01:42:03-08:00 http://www.read.cs.ucla.edu/click/elements/null6?rev=1140082923 This is automatically generated documentation. NAME Null1, Null2, Null3, Null4, Null5, Null6, Null7, Null8 -- Click elements; copy of .M Null "n" SYNOPSIS Null1() Null2() Null3() Null4() Null5() Null6() Null7() Null8() PACKAGE default text/html 2006-02-16T01:42:03-08:00 http://www.read.cs.ucla.edu/click/elements/null7?rev=1140082923 This is automatically generated documentation. NAME Null1, Null2, Null3, Null4, Null5, Null6, Null7, Null8 -- Click elements; copy of .M Null "n" SYNOPSIS Null1() Null2() Null3() Null4() Null5() Null6() Null7() Null8() PACKAGE default text/html 2006-02-16T01:42:03-08:00 http://www.read.cs.ucla.edu/click/elements/null8?rev=1140082923 This is automatically generated documentation. NAME Null1, Null2, Null3, Null4, Null5, Null6, Null7, Null8 -- Click elements; copy of .M Null "n" SYNOPSIS Null1() Null2() Null3() Null4() Null5() Null6() Null7() Null8() PACKAGE default text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/openauthrequeser?rev=1179990969 This is automatically generated documentation. NAME OpenAuthRequeser -- Click element; Sends 802.11 open authentication requests when poked. SYNOPSIS OpenAuthRequeser Package: wifi (core) DESCRIPTION ELEMENT HANDLERS <dl> <dt> bssid (read/write)</dt> <dd> The bssid to associate to</dd> </dl> <dl> <dt> eth (read/write)</dt> <dd> The station's ethernet address</dd> </dl> <dl> <dt> ssid (read/write)</dt> <dd> The ssid to associate to</dd> </dl> <dl> <dt> listen_interval (read/wri… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/openauthresponder?rev=1236475441 This is automatically generated documentation. NAME OpenAuthResponder -- Click element; Respond to 802.11 open authentication requests. SYNOPSIS OpenAuthResponder([, KEYWORDS]) Ports: 1 input, 1 output Processing: push Package: wifi (core) <dl> <dt> </dt> <dd> The wireless channel it is operating on.</dd> </dl> <dl> <dt> </dt> <dd> The SSID of the access point.</dd> </dl> <dl> <dt> </dt> <dd> An Ethernet Address (usually the same as the ethernet address of the wireless card).</dd> … text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/packetlogger?rev=1140460874 This is automatically generated documentation. NAME PacketLogger -- Click element; Log packets for later dumping/analysis. SYNOPSIS PacketLogger(ETHERTYPE ethertype) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION expects packets with ethernet headers. records timestamp, source MAC address, and the first few bytes of every packet to pass through. the list of recorded data can be dumped by repeated calls to the read handler 'packets'. this is for log… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/packetlogger2?rev=1236475442 This is automatically generated documentation. NAME PacketLogger2 -- Click element; Log packets for later dumping/analysis. SYNOPSIS PacketLogger2(KEYWORKDS) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION PacketLogger2 records the size, timestamp, user annotations, and the first few bytes of every packet to pass through. The list of recorded data can be dumped (and cleared) by repeated calls to the read handler 'log'. Keyword arguments are: <dl> <d… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/packetstore?rev=1236475441 This is automatically generated documentation. NAME PacketStore -- Click element; Log transmit feedback stats for later analysis. SYNOPSIS PacketStore(KEYWORKDS) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION PacketStore records the size, timestamp, and other infor for each packet that passed through. The list of recorded data can be dumped (and cleared) by repeated calls to the read handler 'log'. <dl> <dt> </dt> <dd> Print as much of the list of … text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/packettest?rev=1140460876 This is automatically generated documentation. NAME PacketTest -- Click element; runs regression tests for Packet SYNOPSIS PacketTest() Ports: none Package: test (core) DESCRIPTION PacketTest runs Packet regression tests at initialization time. It does not route packets. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/pad?rev=1140460876 This is automatically generated documentation. NAME Pad -- Click element; SYNOPSIS Pad Ports: 1 input, 1 output Processing: agnostic Package: local (core) Generated by 'click-elem2man' from '../elements/local/pad.hh' on 20/Feb/2006. COMMENTS text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/paint?rev=1236475441 This is automatically generated documentation. NAME Paint -- Click element; sets packet paint annotations SYNOPSIS Paint(COLOR [, ANNO]) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Sets each packet's paint annotation to COLOR, an integer 0..255. Paint sets the packet's PAINT annotation by default, but the ANNO argument can specify any one-byte annotation. <dl> <dt> </dt> <dd> Get/set the color to paint.</dd> </dl> text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/paintswitch?rev=1236475442 This is automatically generated documentation. NAME PaintSwitch -- Click element; sends packet stream to output chosen per-packet SYNOPSIS PaintSwitch Ports: 1 input, any number of outputs Processing: push Package: standard (core) DESCRIPTION PaintSwitch sends every incoming packet to one of its output ports -- specifically, output port number K, where K is the value of the incoming packet's paint annotation. If the paint annotation is set to 255, the packet is duplicated and sen… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/painttee?rev=1236475442 This is automatically generated documentation. NAME PaintTee -- Click element; duplicates packets with given paint annotation SYNOPSIS PaintTee(COLOR [, ANNO]) Ports: 1 input, 2 outputs Processing: agnostic, but output 1 is push Package: standard (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/pep?rev=1236475441 This is automatically generated documentation. NAME PEP -- Click element; runs the Grid Position Estimation Protocol SYNOPSIS PEP(IP, [FIXED, LATITUDE, LONGITUDE]) Ports: 1 input, 1 output Processing: push Drivers: userlevel Package: grid (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/perfcountaccum?rev=1236475442 This is automatically generated documentation. NAME PerfCountAccum -- Click element; collects differences in Pentium Pro performance metrics SYNOPSIS PerfCountAccum(METRIC) Ports: 1 input, 1 output Processing: agnostic Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Returns the number of packets that have passed.</dd> </dl> <dl> <dt> </dt> <dd> Returns the accumulated changes in the metric TYPE for all passing packets.</dd> </dl> <dl> <dt> </dt> <dd> Resets … text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/perfcountinfo?rev=1236475441 This is automatically generated documentation. NAME PerfCountInfo -- Click element; turn on Pentium Pro performance metrics SYNOPSIS PerfCountInfo([METRIC0, METRIC1]) Drivers: linuxmodule Package: linuxmodule (core) DESCRIPTION The Pentium Pro CPU can maintain up to two performance counters. PerfCountInfo turns on those counters. METRIC0 is the type of performance counter 0, METRIC1 is the type of performance counter 1. Either type may be empty, in which case that counter will not b… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/pflood?rev=1140460875 This is automatically generated documentation. NAME PFlood -- Click element SYNOPSIS PFlood(ETHTYPE eth, IP ip, BCAST_IP ip, ETH eth, P int, MAX_DELAY int, N<> [DEBUG bool], [HISTORY int]); Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) <dl> <dt> </dt> <dd> value of 0 to 100 where P is the probability that thiselement will forward any particular packet. It will onlyforward it once.</dd> </dl> <dl> <dt> </dt> <dd> max time to wait after 1… text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/pim?rev=1148086840 This is automatically generated documentation. NAME PIM -- Click element; IP Multicast SYNOPSIS PIM(IPMulticastTable, PIMForwardingTable, PIMControl, Interfaceaddress) Ports: 1 input, 2 outputs Package: multicast DESCRIPTION Handles PIM messages. Arriving PIM messages are checked and processed. A working Click multicast configuration must have a PIM element attached to each incoming interface. This element manages the PIMForwardingTable. It manages the databank of PIM receivers kept… text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/pimcontrol?rev=1148086840 This is automatically generated documentation. NAME PIMControl -- Click element; IPv4 Multicast SYNOPSIS PIMControl(PIMForwardingTable) Ports: no inputs, 2 outputs Package: multicast DESCRIPTION Handles the PIM protocol, i.e. generation of Hello-messages and detection of connected PIM routers. This management information is needed for PIMForwardingTable. text/html 2006-05-19T18:00:40-08:00 http://www.read.cs.ucla.edu/click/elements/pimforwardingtable?rev=1148086840 This is automatically generated documentation. NAME PIMForwardingTable -- Click element; IPv4 Multicast SYNOPSIS PIMForwardingTable() Ports: 1 input, 1 output Processing: push Package: multicast DESCRIPTION Takes care of arriving multicast traffic. Streams are duplicated and forwarded to neighbouring routers which are connected to Rendezvous Point or Source Path Trees. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/pingpong?rev=1236475441 This is automatically generated documentation. NAME PingPong -- Click element; SYNOPSIS PingPong(LINKSTAT) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION Expects Grid packets as input. Places ping-pong link stats, acquired from LINKSTAT, a LinkStat element, into outgoing unicast packets. On the other side of the link a LinkTracker element will aggregate these statistics as neccessary. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/pokehandlers?rev=1179990969 This is automatically generated documentation. NAME PokeHandlers -- Click element; calls write handlers at specified times SYNOPSIS PokeHandlers(DIRECTIVE, ...) Ports: none Package: standard (core) DESCRIPTION This element is deprecated. Use the Script element instead. Runs read and write handlers at specified times. Each configuration argument is a directive, taken from this list: <dl> <dt> </dt> <dd> Call a read handler and report its result. At user level, the result isprinted o… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/polldevice?rev=1236475442 This is automatically generated documentation. NAME PollDevice -- Click element; polls packets from network device (kernel) SYNOPSIS PollDevice(DEVNAME [, keywords PROMISC, BURST, TIMESTAMP...]) Ports: no inputs, 1 output Processing: push Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Boolean. If true, the device is put into promiscuous mode while isactive. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Unsigned integer. Sets the BURST parameter.</dd>… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/portinfo?rev=1140460876 This is automatically generated documentation. NAME PortInfo -- Click element; stores named TCP/UDP port information SYNOPSIS PortInfo(NAME PORT[/PROTOCOL], ...) Ports: None Package: standard (core) DESCRIPTION Lets you use mnemonic names for TCP and UDP ports. Each argument has the form `NAME PORT[/PROTOCOL]', which associates the given PORT/PROTOCOL pair with the NAME. If PROTOCOL is left off, the NAME applies to both TCP and UDP. For example, in a configuration containing text/html 2006-05-19T18:00:36-08:00 http://www.read.cs.ucla.edu/click/elements/pppcontrolprotocol?rev=1148086836 This is automatically generated documentation. NAME PPPControlProtocol -- Click element; virtual class for PPP control protocols SYNOPSIS PPPControlProtocol([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: @CLICKPACKAGENAME@ <dl> <dt> </dt> <dd> Boolean. When true, PPPControlProtocol will print messages whenever itreceives a packet. Default is false.</dd> </dl> text/html 2006-05-19T18:00:36-08:00 http://www.read.cs.ucla.edu/click/elements/pppencap?rev=1148086836 This is automatically generated documentation. NAME PPPEncap -- Click element; encapsulates packets in static PPP header SYNOPSIS PPPEncap(PROTOCOL, KEYWORDS) Ports: 1 input, 1 output Processing: agnostic Package: @CLICKPACKAGENAME@ DESCRIPTION Encapsulates each incoming packet in a PPP packet with protocol PROTOCOL. Default protocol is 0x0021 (IPv4-in-PPP). Keyword arguments are: <dl> <dt> </dt> <dd> Byte. Sets the Address field to the specified value. Default is 0xff(all station… text/html 2006-05-19T18:00:36-08:00 http://www.read.cs.ucla.edu/click/elements/pptpserver?rev=1148086836 This is automatically generated documentation. NAME PPTPServer -- Click element; Handles PPTP-over-TCP connections. SYNOPSIS PPTPServer([KEYWORDS]) Ports: any number of inputs, any number of outputs Processing: push Drivers: userlevel Package: @CLICKPACKAGENAME@ <dl> <dt> </dt> <dd> Boolean. When true, PPTPServer will print messages whenever it accepts anew connection or drops an old one. Default is false.</dd> </dl> text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/print?rev=1236475442 This is automatically generated documentation. NAME Print -- Click element; prints packet contents SYNOPSIS Print([LABEL, MAXLENGTH, keywords]) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Prints up to MAXLENGTH bytes of data from each packet, in hex, preceded by the LABEL text. Default MAXLENGTH is 24. Keyword arguments are: <dl> <dt> </dt> <dd> Maximum number of content bytes to print. If negative, print entirepacket. Default is 24.</dd> </d… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/printgrid?rev=1236475442 This is automatically generated documentation. NAME PrintGrid -- Click element; SYNOPSIS PrintGrid([LABEL] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION Assumes input packets have Ethernet headers enclosing Grid packets, as described by grid_hdr in grid.hh. Prints out a description of the Grid payload. Keyword arguments are: <dl> <dt> </dt> <dd> Boolean. Default false. If true, print all the entries in each route advertisement.</dd>… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/printpower?rev=1140460875 This is automatically generated documentation. NAME PrintPower -- Click element; SYNOPSIS PrintPower([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are Wifi packets (ie a wifi_pkt struct from wifi.hh). Prints out a description of those packets. Keyword arguments are: text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/printrate?rev=1140460872 This is automatically generated documentation. NAME PrintRate -- Click element; SYNOPSIS PrintRate([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are Wifi packets (ie a wifi_pkt struct from wifi.hh). Prints out a description of those packets. Keyword arguments are: text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/printseq?rev=1140460875 This is automatically generated documentation. NAME PrintSeq -- Click element; SYNOPSIS PrintSeq([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are Wifi packets (ie a wifi_pkt struct from wifi.hh). Prints out a description of those packets. Keyword arguments are: text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/printsr?rev=1140460875 This is automatically generated documentation. NAME PrintSR -- Click element; SYNOPSIS PrintSR([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are SR packets (ie a sr_pkt struct from sr.hh). Prints out a description of those packets. Keyword arguments are: text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/printtxfeedback?rev=1236475441 This is automatically generated documentation. NAME PrintTXFeedback -- Click element; SYNOPSIS PrintTXFeedback([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are Wifi packets (ie a wifi_pkt struct from wifi.hh). Prints out a description of those packets. Keyword arguments are: text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/printwifi?rev=1236475441 This is automatically generated documentation. NAME PrintWifi -- Click element; SYNOPSIS PrintWifi([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are Wifi packets (ie a wifi_pkt struct from wifi.hh). Prints out a description of those packets. Keyword arguments are: text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/priosched?rev=1140460874 This is automatically generated documentation. NAME PrioSched -- Click element; pulls from priority-scheduled inputs SYNOPSIS PrioSched Ports: any number of inputs, 1 output Processing: pull Package: standard (core) DESCRIPTION Each time a pull comes in the output, PrioSched pulls from each of the inputs starting from input 0. The packet from the first successful pull is returned. This amounts to a strict priority scheduler. The inputs usually come from Queues or other pull schedu… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/prism2decap?rev=1140460875 This is automatically generated documentation. NAME Prism2Decap -- Click element; Pulls the prism2 header from a packet and store information in Packet::anno() SYNOPSIS Prism2Decap Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/prism2encap?rev=1140460876 This is automatically generated documentation. NAME Prism2Encap -- Click element; Pushes a Prism2 header onto a packet based on information stored in Packet::anno() SYNOPSIS Prism2Encap Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/proberesponder?rev=1236475442 This is automatically generated documentation. NAME ProbeResponder -- Click element; Respond to 802.11 probe packets. SYNOPSIS ProbeResponder([, KEYWORDS]) Ports: 1 input, 1 output Processing: push Package: wifi (core) DESCRIPTION Keyword arguments are: <dl> <dt> </dt> <dd> The wireless channel it is operating on.</dd> </dl> <dl> <dt> </dt> <dd> The SSID of the access point.</dd> </dl> <dl> <dt> </dt> <dd> An Ethernet Address (usually the same as the ethernet address of the wire… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/probetxrate?rev=1179990969 This is automatically generated documentation. NAME ProbeTXRate -- Click element; Madwifi wireless bit-rate selection algorithm SYNOPSIS ProbeTXRate([KEYWORDS]) Ports: 2 inputs, at most 2 outputs Package: wifi (core) DESCRIPTION Probematically determine the txrate for a give ethernet dst <dl> <dt> </dt> <dd> How long to remember tx packets</dd> </dl> <dl> <dt> </dt> <dd> a value from 0 to 100 of what the percentage must be beforethe rate is increased</dd> </dl> <dl> <dt> </dt> <dd… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/progressbar?rev=1236475442 This is automatically generated documentation. NAME ProgressBar -- Click element; prints a progress bar to standard error SYNOPSIS ProgressBar(POSHANDLER [, SIZEHANDLER, KEYWORDS]) Ports: none Drivers: userlevel Package: userlevel (core) DESCRIPTION Reads progress information from handlers, and displays an ASCII-art progress bar on standard error, indicating how much progress has been made and how much remains to go. POSHANDLER and SIZEHANDLER are read handlers. Each of them shoul… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/protocoltranslator46?rev=1236475441 This is automatically generated documentation. NAME ProtocolTranslator46 -- Click element; translate IP/ICMP, TCP, and UDP packets between IPv4 and IPv6 protocols SYNOPSIS ProtocolTranslator46() Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/protocoltranslator64?rev=1236475441 This is automatically generated documentation. NAME ProtocolTranslator64 -- Click element; translate IP/ICMP, TCP, and UDP packets from the IPv6 to the IPv4 protocol SYNOPSIS ProtocolTranslator64() Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/pullnull?rev=1140460872 This is automatically generated documentation. NAME PullNull -- Click element; passes packets unchanged SYNOPSIS PullNull Ports: 1 input, 1 output Processing: pull Package: standard (core) DESCRIPTION Responds to each pull request by pulling a packet from its input and returning that packet unchanged. text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/pullswitch?rev=1190150828 This is automatically generated documentation. NAME PullSwitch -- Click element; forwards pull requests to settable input SYNOPSIS PullSwitch([INPUT]) Ports: any number of inputs, 1 output Processing: pull Package: standard (core) DESCRIPTION On every pull, PullSwitch returns the packet pulled from one of its input ports -- specifically, INPUT. The default INPUT is zero; negative INPUTs mean always return a null packet. You can change INPUT with a write handler. PullSwitch has an … text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/pulltee?rev=1140460873 This is automatically generated documentation. NAME Tee, PullTee -- Click elements; duplicates packets SYNOPSIS Tee([N]) PullTee([N]) Ports: 1 input, 1 or more outputs Processing: push Package: standard (core) DESCRIPTION Tee sends a copy of each incoming packet out each output. PullTee's input and its first output are pull; its other outputs are push. Each time the pull output pulls a packet, it sends a copy out the push outputs. Tee and PullTee have however many outputs are us… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/pushanno?rev=1140460872 This is automatically generated documentation. NAME PushAnno -- Click element; Pushes Packet::anno() onto front of packet. SYNOPSIS PushAnno([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Pushes Packet::USER_ANNO_SIZE bytes on a packet and copies Packet::anno() to the beginning of the packet. text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/pushnull?rev=1140460872 This is automatically generated documentation. NAME PushNull -- Click element; passes packets unchanged SYNOPSIS PushNull Ports: 1 input, 1 output Processing: push Package: standard (core) DESCRIPTION Responds to each pushed packet by pushing it unchanged out its first output. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/queue?rev=1236475441 This is automatically generated documentation. NAME Queue -- Click element; stores packets in a FIFO queue SYNOPSIS Queue Queue(CAPACITY) Ports: 1 input, 1-2 outputs Package: standard (core) DESCRIPTION Stores incoming packets in a first-in-first-out queue. Drops incoming packets if the queue already holds CAPACITY packets. The default for CAPACITY is 1000. Queue notifies interested parties when it becomes empty and when a formerly-empty queue receives a packet. The empty notifica… text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/queuethreadtest1?rev=1190150828 This is automatically generated documentation. NAME QueueThreadTest1 -- Click element; runs regression tests for Queue threading SYNOPSIS QueueThreadTest1() Ports: no inputs, 1 output Processing: agnostic Drivers: userlevel Package: test (core) text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/queuethreadtest2?rev=1190150828 This is automatically generated documentation. NAME QueueThreadTest2 -- Click element; runs regression tests for Queue threading SYNOPSIS QueueThreadTest2() Ports: 1 input, no outputs Processing: pull Drivers: userlevel Package: test (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/queueyanktest?rev=1179990969 This is automatically generated documentation. NAME QueueYankTest -- Click element; check packets against a specification SYNOPSIS QueueYankTest(QUEUE) Ports: none Package: test (core) DESCRIPTION QueueYankTest compares all received packets against a specification provided by keyword arguments. It prints error messages when incoming packets don't match the spec. Keyword arguments are as follows. Tests are performed for the keyword arguments you specify. If you don't want to run a te… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/quitwatcher?rev=1140460873 This is automatically generated documentation. NAME QuitWatcher -- Click element; stops router processing SYNOPSIS QuitWatcher(ELEMENT, ...) Ports: none Package: standard (core) DESCRIPTION Stops router processing when at least one of the ELEMENTs is no longer scheduled. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/radiosim?rev=1179990969 This is automatically generated documentation. NAME RadioSim -- Click element; simulates reachability and broadcast in an 802.11-like radio network SYNOPSIS RadioSim([keywords,] [lat1 lon1, lat2 lon2, ...]) Ports: any number of inputs, any number of outputs Processing: pull inputs, push outputs Drivers: userlevel Package: grid (core) <dl> <dt> </dt> <dd> Boolean. Defaults to false. Use x,y coordinates in metres insteadof lat,lon in degrees. lat is treated as x, and lon is treate… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/radiotapdecap?rev=1140460876 This is automatically generated documentation. NAME RadiotapDecap -- Click element; Pulls the click_wifi_radiotap header from a packet and stores it in Packet::anno() SYNOPSIS RadiotapDecap() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/radiotapencap?rev=1140460873 This is automatically generated documentation. NAME RadiotapEncap -- Click element; Pushes the click_wifi_radiotap header on a packet based on information in Packet::anno() SYNOPSIS RadiotapEncap() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/radixiplookup?rev=1179990969 This is automatically generated documentation. NAME RadixIPLookup -- Click element; IP lookup using a radix trie SYNOPSIS RadixIPLookup(ADDR1/MASK1 [GW1] OUT1, ADDR2/MASK2 [GW2] OUT2, ...) Ports: 1 input, any number of outputs Processing: push Package: ip (core) <dl> <dt> </dt> <dd> Outputs a human-readable version of the current routing table.</dd> </dl> <dl> <dt> </dt> <dd> Reports the OUTput port and GW corresponding to an address.</dd> </dl> <dl> <dt> </dt> <dd> Adds a route to… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/radixipseclookup?rev=1179990969 This is automatically generated documentation. NAME RadixIPsecLookup -- Click element; IP lookup using a radix trie SYNOPSIS RadixIPsecLookup(ADDR1/MASK1 [GW1] OUT1, ADDR2/MASK2 [GW2] OUT2, ...) Ports: 1 input, any number of outputs Processing: push Package: ipsec (core) <dl> <dt> </dt> <dd> Outputs a human-readable version of the current routing table.</dd> </dl> <dl> <dt> </dt> <dd> Reports the OUTput port and GW corresponding to an address.</dd> </dl> <dl> <dt> </dt> <dd> Adds a… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/randombiterrors?rev=1179990969 This is automatically generated documentation. NAME RandomBitErrors -- Click element; changes packet data with some probability SYNOPSIS RandomBitErrors(P [, KIND, ACTIVE]) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) <dl> <dt> </dt> <dd> Returns or sets the P probability parameter.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the KIND parameter.</dd> </dl> <dl> <dt> </dt> <dd> Makes the element active or inactive.</dd> </dl> text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/randomsample?rev=1179990969 This is automatically generated documentation. NAME RandomSample -- Click element; samples packets with some probability SYNOPSIS RandomSample([P, KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: standard (core) <dl> <dt> </dt> <dd> Sets the sampling probability to .</dd> </dl> <dl> <dt> </dt> <dd> The element will drop packets with probability . Same as suppling (1 -) as the sampling probability.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. Ra… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/randomseed?rev=1179990969 This is automatically generated documentation. NAME RandomSeed -- Click element; sets random seed SYNOPSIS RandomSeed([SEED]) Ports: none Package: test (core) DESCRIPTION RandomSeed sets the random seed to the SEED argument. If not supplied, the random seed is set to a truly random value. <dl> <dt> </dt> <dd> Write this handler to reset the random seed, either to a particular value or(if you supply an empty argument) randomly.</dd> </dl> text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/randomsource?rev=1140460875 This is automatically generated documentation. NAME RandomSource -- Click element; generates random packets whenever scheduled SYNOPSIS RandomSource(LENGTH) Ports: no inputs, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Creates packets, of the indicated length, filled with random bytes. Packets' timestamp annotations are set to the current time. text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/randomswitch?rev=1140460873 This is automatically generated documentation. NAME RandomSwitch -- Click element; sends packets to random outputs SYNOPSIS RandomSwitch Ports: one input, one or more outputs Processing: push Package: standard (core) DESCRIPTION Pushes each arriving packet to one of the N outputs, choosing outputs randomly. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/rangeiplookup?rev=1179990969 This is automatically generated documentation. NAME RangeIPLookup -- Click element; IP routing lookup through binary search in a very compact table SYNOPSIS RangeIPLookup(ADDR1/MASK1 [GW1] OUT1, ADDR2/MASK2 [GW2] OUT2, ...) Ports: 1 input, any number of outputs Processing: push Drivers: userlevel, bsdmodule Package: ip (core) <dl> <dt> </dt> <dd> Outputs a human-readable version of the current routing table.</dd> </dl> <dl> <dt> </dt> <dd> Reports the OUTput port and GW correspond… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/ratedsource?rev=1236475441 This is automatically generated documentation. NAME RatedSource -- Click element; generates packets at specified rate SYNOPSIS RatedSource([DATA, RATE, LIMIT, ACTIVE, KEYWORDS]) Ports: no inputs, 1 output Processing: agnostic Package: standard (core) <dl> <dt> </dt> <dd> String. Same as the DATA argument.</dd> </dl> <dl> <dt> </dt> <dd> Integer. If set, the outgoing packet will have this length.</dd> </dl> <dl> <dt> </dt> <dd> Integer. Same as the RATE argument.</dd> </dl> <dl> <d… text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/ratedsplitter?rev=1190150828 This is automatically generated documentation. NAME RatedSplitter -- Click element; splits flow of packets at specified rate SYNOPSIS RatedSplitter(RATE) Ports: 1 input, 2 outputs Processing: push Package: standard (core) DESCRIPTION RatedSplitter has two output ports. All incoming packets up to a maximum of RATE packets per second are emitted on output port 0. Any remaining packets are emitted on output port 1. Unlike Meter, RATE packets per second are emitted on output port 0 ev… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/ratedunqueue?rev=1236475442 This is automatically generated documentation. NAME RatedUnqueue -- Click element; pull-to-push converter SYNOPSIS RatedUnqueue(RATE) Ports: 1 input, 1 output Processing: pull inputs, push outputs Package: standard (core) DESCRIPTION Pulls packets at the given RATE in packets per second, and pushes them out its single output. RatedUnqueue will use a lot of CPU if given a low RATE. This is because it maintains the RATE by constantly rescheduling itself until it's time for a packet… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/rawsocket?rev=1236475442 This is automatically generated documentation. NAME RawSocket -- Click element; transports raw IP packets via safe raw sockets (user-level) SYNOPSIS RawSocket("TCP", <TCP source port number> [, KEYWORDS]) RawSocket("UDP", <UDP source port number> [, KEYWORDS]) RawSocket("GRE", <GRE key or PPTP call ID> [, KEYWORDS]) RawSocket("ICMP", <ICMP identifier> [, KEYWORDS]) <dl> <dt> </dt> <dd> Unsigned integer. Maximum packet length. This valuerepresents the MRU of the RawSocket if it is used as… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/readanno?rev=1140460875 This is automatically generated documentation. NAME ReadAnno -- Click element; Pulls annotation from packet and stores it in Packet::anno() SYNOPSIS ReadAnno([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Pulls Packet::USER_ANNO_SIZE bytes from a packet and copies them to Packet::anno() text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/red?rev=1179990969 This is automatically generated documentation. NAME RED -- Click element; drops packets according to RED SYNOPSIS RED(MIN_THRESH, MAX_THRESH, MAX_P [, KEYWORDS]) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: aqm (core) <dl> <dt> </dt> <dd> This argument is a space-separated list of Storage element names. RED will usethose elements' queue lengths, rather than any elements found via flow-basedrouter context.</dd> </dl> <dl> <dt> </dt> <dd> Unsigned. T… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/rfc2507comp?rev=1140460873 This is automatically generated documentation. NAME RFC2507Comp -- Click element; RFC2507 IPv4/TCP header compressor. SYNOPSIS RFC2507Comp Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Input packets need to be IPv4 (no ether header &c). It's OK if they're not TCP. How to specify various kinds of output? There is not really a useful general standard. Perhaps emit each different format of output on a different output() and let further modules sort it o… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/rfc2507decomp?rev=1140460874 This is automatically generated documentation. NAME RFC2507Decomp -- Click element; RFC2507 IPv4/TCP header decompressor. SYNOPSIS RFC2507Decomp Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Input packets should be as produced by RFC2507c. Spits out IP packets. text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/ripsend?rev=1190150829 This is automatically generated documentation. NAME RIPSend -- Click element; periodically generates specified RIP II packet SYNOPSIS RIPSend(SRC, DST, PREFIX, METRIC) Ports: no inputs, 1 output Processing: push Package: ip (core) DESCRIPTION Sends periodic RIP II packets with specified contents, including UDP and IP headers. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/roundrobinipmapper?rev=1140460874 This is automatically generated documentation. NAME RoundRobinIPMapper -- Click element; round-robin mapper for IPRewriter SYNOPSIS RoundRobinIPMapper(PATTERN1, ..., PATTERNn) Ports: none Package: ip (core) DESCRIPTION Works in tandem with IPRewriter to provide round-robin rewriting. This is useful, for example, in load-balancing applications. Implements the IPMapper interface. Responds to mapping requests from an IPRewriter by trying the PATTERNs in round-robin order and returning … text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/roundrobinsched?rev=1140460876 This is automatically generated documentation. NAME RoundRobinSched -- Click element; pulls from round-robin inputs SYNOPSIS RoundRobinSched Ports: one output, zero or more inputs Processing: pull Package: standard (core) DESCRIPTION Each time a pull comes in the output, pulls from its inputs in turn until one produces a packet. When the next pull comes in, it starts from the input after the one that last produced a packet. This amounts to a round robin scheduler. The inputs usual… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/roundrobinswitch?rev=1140460873 This is automatically generated documentation. NAME RoundRobinSwitch -- Click element; sends packets to round-robin outputs SYNOPSIS RoundRobinSwitch Ports: one input, one or more outputs Processing: push Package: standard (core) DESCRIPTION Pushes each arriving packet to one of the N outputs. The next packet will be pushed to the following output in round-robin order. text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/roundrobinunqueue?rev=1140460873 This is automatically generated documentation. NAME RoundRobinUnqueue -- Click element; pull-to-push converter SYNOPSIS RoundRobinUnqueue([BURSTSIZE]) Ports: any number of inputs, any number of outputs Processing: pull inputs, push outputs Package: local (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/roundtripcyclecount?rev=1179990969 This is automatically generated documentation. NAME RoundTripCycleCount -- Click element; measures round trip cycles on a push or pull path SYNOPSIS RoundTripCycleCount() Ports: 1 input, 1 output Processing: agnostic Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Returns the number of packets that have passed.</dd> </dl> <dl> <dt> </dt> <dd> Returns the accumulated round-trip cycles for all passing packets.</dd> </dl> <dl> <dt> </dt> <dd> Resets and count… text/html 2006-05-19T18:00:43-08:00 http://www.read.cs.ucla.edu/click/elements/rtpclassifier?rev=1148086843 This is automatically generated documentation. NAME RTPClassifier -- Click element; splits packets pertaining to an RTP flow from other BE traffic. SYNOPSIS RTPClassifier Ports: 1 input, 2 outputs Processing: Push Drivers: linuxmodule Package: unibo_qos text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/rxstats?rev=1179990969 This is automatically generated documentation. NAME RXStats -- Click element; Track RSSI for each ethernet source. SYNOPSIS RXStats Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Accumulate RSSI, noise for each ethernet source you hear a packet from. <dl> <dt> </dt> <dd> Print information accumulated for each source</dd> </dl> <dl> <dt> </dt> <dd> Clear all information for each source</dd> </dl> text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/schedordertest?rev=1179990969 This is automatically generated documentation. NAME SchedOrderTest -- Click element; remembers scheduling order SYNOPSIS SchedOrderTest(ID, [<keyword> SIZE, LIMIT, STOP]) Ports: none Package: test (core) DESCRIPTION SchedOrderTest elements repeatedly schedule themselves, and keep track of the order in which they were scheduled. ID is an integer used to distinguish between different SchedOrderTest elements. The "order" handler reports the sequence of IDs corresponding to the order … text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/scheduleinfo?rev=1236475441 This is automatically generated documentation. NAME ScheduleInfo -- Click element; specifies scheduling parameters SYNOPSIS ScheduleInfo(ELEMENT PARAM, ...) Ports: None Package: standard (core) DESCRIPTION Provides scheduling parameters for specified elements. Each configuration argument has the form `ELEMENT PARAM', meaning that the element named ELEMENT has scheduling parameter PARAM. Scheduling parameters are real numbers that set how often one element should be scheduled in rela… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/schedulelinux?rev=1140460876 This is automatically generated documentation. NAME ScheduleLinux -- Click element; returns to Linux scheduler SYNOPSIS ScheduleLinux Ports: none Drivers: linuxmodule Package: linuxmodule (core) DESCRIPTION Returns to Linux's scheduler every time it is scheduled by Click. Use ScheduleInfo to specify how often this should happen. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/script?rev=1236475442 This is automatically generated documentation. NAME Script -- Click element; script a Click router configuration SYNOPSIS Script(INSTRUCTIONS...) Ports: normally none Package: standard (core) DESCRIPTION The Script element implements a simple scripting language useful for controlling Click configurations. Scripts can set variables, call handlers, wait for prodding from other elements, and stop the router. <dl> <dt> </dt> <dd> Sets the script variable $VAR to TEXT.</dd> </dl> <dl> … text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/sendgridhello?rev=1140460874 This is automatically generated documentation. NAME SendGridHello -- Click element; SYNOPSIS SendGridHello(PERIOD, JITTER, ETH, IP); Ports: no inputs, 1 output Processing: push Drivers: userlevel Package: grid (core) DESCRIPTION Every PERIOD millseconds (+/- a jitter bounded by JITTER milliseconds), emit a Grid protocol ``Hello'' packet for the Grid node at address IP with MAC address ETH. PERIOD must be greater than 0, JITTER must be positive and less than JITTER. Produces Gr… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/sendgridlrhello?rev=1236475442 This is automatically generated documentation. NAME SendGridLRHello -- Click element; SYNOPSIS SendGridLRHello(PERIOD, JITTER, ETH, IP, UpdateGridRoutes [, MAXHOPS]) Ports: no inputs, 1 output Processing: push Drivers: userlevel Package: grid (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/setannobyte?rev=1236475442 This is automatically generated documentation. NAME SetAnnoByte -- Click element; sets packet user annotations SYNOPSIS SetAnnoByte(ANNO, VALUE) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Sets each packet's user annotation byte at ANNO to VALUE, an integer 0..255. Permissible values for ANNO are 0 to n-1, inclusive, where n is typically 48, or the name of a one-byte annotation. <dl> <dt> </dt> <dd> Returns ANNO as an integer offset</dd> </d… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/setcrc32?rev=1140460874 This is automatically generated documentation. NAME SetCRC32 -- Click element; calculates CRC32 and prepends to packet SYNOPSIS SetCRC32() Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Computes a CRC32 over each packet and appends the 4 CRC bytes to the packet. text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/setcyclecount?rev=1140460875 This is automatically generated documentation. NAME SetCycleCount -- Click element; stores cycle count in annotation SYNOPSIS SetCycleCount() Ports: 1 input, 1 output Processing: agnostic Drivers: linuxmodule Package: linuxmodule (core) DESCRIPTION Stores the current cycle count in an annotation in each packet. In combination with CycleCountAccum, this lets you measure how many cycles it takes a packet to pass from one point to another. text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/setgateway?rev=1140460873 This is automatically generated documentation. NAME SetGateway -- Click element SYNOPSIS SetGateway([GW ipaddress], [SEL GatewaySelector element]) Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) DESCRIPTION This element marks the gateway for a packet to be sent to. Either manually specifiy an gw using the GW keyword or automatically select it using a GatewaySelector element. text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/setgridchecksum?rev=1140460872 This is automatically generated documentation. NAME SetGridChecksum -- Click element; SYNOPSIS SetGridChecksum() Ports: 1 input, 1 output Processing: agnostic Package: grid (core) DESCRIPTION Expects a Grid MAC packet as input. Calculates the Grid header's checksum and sets the version and checksum header fields. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/setip6address?rev=1140460874 This is automatically generated documentation. NAME SetIP6Address -- Click element; SYNOPSIS SetIP6Address(IP6) Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) DESCRIPTION Set the destination IP6 address annotation of incoming packets to the static IP6 address IP6 text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/setip6dscp?rev=1140460873 This is automatically generated documentation. NAME SetIP6DSCP -- Click element; sets IP6 packets' DSCP fields SYNOPSIS SetIP6DSCP(VAL) Ports: 1 input, 1 output Processing: agnostic Package: ip6 (core) DESCRIPTION Expects IP6 packets as input and sets their Differential Services Code Point to VAL and passes the packet to output 0. The DSCP is the upper 6 bits of the IP6 TRAFFIC CLASS field. text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/setipaddress?rev=1190150828 This is automatically generated documentation. NAME SetIPAddress -- Click element; sets destination IP address annotations SYNOPSIS SetIPAddress(IPADDR) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Set the destination IP address annotation of incoming packets to the static IP address IPADDR. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/setipchecksum?rev=1140460876 This is automatically generated documentation. NAME SetIPChecksum -- Click element; sets IP packets' checksums SYNOPSIS SetIPChecksum() Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Expects an IP packet as input. Calculates the IP header's checksum and sets the checksum header field. You will not normally need SetIPChecksum. Most elements that modify an IP header, like DecIPTTL, SetIPDSCP, and IPRewriter, already update the checksum incrementally. text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/setipdscp?rev=1190150828 This is automatically generated documentation. NAME SetIPDSCP -- Click element; sets IP packets' DSCP fields SYNOPSIS SetIPDSCP(DSCP) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Expects IP packets as input and sets their Differential Services Code Point to DSCP. Then it incrementally recalculates the IP checksum and passes the packet to output 0. The DSCP is the upper 6 bits of the IP TOS field. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/setpackettype?rev=1140460874 This is automatically generated documentation. NAME SetPacketType -- Click element; sets packet type annotation SYNOPSIS SetPacketType(TYPE) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION SetPacketType sets passing packets' packet type annotations to TYPE. The packet type annotation tells Linux about the packet's link-level characteristics. For example, was the packet sent directly to this host, or was it broadcast? TYPE should be one of `HOST',… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/setperfcount?rev=1236475441 This is automatically generated documentation. NAME SetPerfCount -- Click element; stores Pentium Pro performance metric in annotation SYNOPSIS SetPerfCount(METRIC) Ports: 1 input, 1 output Processing: agnostic Drivers: linuxmodule Package: linuxmodule (core) text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/setrandipaddress?rev=1190150828 This is automatically generated documentation. NAME SetRandIPAddress -- Click element; sets destination IP address annotations randomly SYNOPSIS SetRandIPAddress(PREFIX, [LIMIT]) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/setrts?rev=1179990969 This is automatically generated documentation. NAME SetRTS -- Click element; Enable/disable RTS/CTS for a packet SYNOPSIS SetRTS(Bool) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Enable/disable RTS/CTS for a packet <dl> <dt> </dt> <dd> Enable/disable rts/cts for a packet.</dd> </dl> text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/setsourceroute?rev=1140460873 This is automatically generated documentation. NAME SetSourceRoute -- Click element; SYNOPSIS SetSourceRoute(IP, SRForwarder element) Ports: 1 input, 1-2 outputs Processing: agnostic Package: wifi (core) DESCRIPTION Set the Source Route for packet's destination inside the source route header based on the destination ip annotation. If no source route is found for a given packet, the unmodified packet is sent to output 1 if the output is present. Regular Arguments: <dl> <dt> </dt> <… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/setsrchecksum?rev=1140460873 This is automatically generated documentation. NAME SetSRChecksum -- Click element; Set Checksum for Source Routed packet. SYNOPSIS SetSRChecksum() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Expects a SR MAC packet as input. Calculates the SR header's checksum and sets the version and checksum header fields. text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/setsrflag?rev=1140460872 This is automatically generated documentation. NAME SetSRFlag -- Click element; SYNOPSIS SetSRFlag([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are SR packets (ie a sr_pkt struct from sr.hh). Prints out a description of those packets. Keyword arguments are: text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/settcpchecksum?rev=1190150829 This is automatically generated documentation. NAME SetTCPChecksum -- Click element; sets TCP packets' checksums SYNOPSIS SetTCPChecksum([FIXOFF]) Ports: 1 input, 1 output Processing: agnostic Package: tcpudp (core) DESCRIPTION Input packets should be TCP in IP. Calculates the TCP header's checksum and sets the checksum header field. Uses the IP header fields to generate the pseudo-header. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/settimestamp?rev=1179990969 This is automatically generated documentation. NAME SetTimestamp -- Click element; store the time in the packet's timestamp annotation SYNOPSIS SetTimestamp([TIMESTAMP, keyword FIRST, DELTA]) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) <dl> <dt> </dt> <dd> Boolean. If true, then set the packet's &quot;first timestamp&quot; annotation, not itstimestamp annotation. Default is true.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If true, then set the packet's ti… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/settimestampdelta?rev=1179990969 This is automatically generated documentation. NAME SetTimestampDelta -- Click element; replace packet timestamps with deltas SYNOPSIS SetTimestampDelta([keywords TYPE]) Ports: 1 input, 1 output Processing: agnostic Package: analysis (core) <dl> <dt> </dt> <dd> Sets the type of delta. The default is , which means the deltarelative to the first nonzero packet timestamp encountered. Otherpossibilities are , which means the delta between its current timestampand now, and , which means… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/settxpower?rev=1179990969 This is automatically generated documentation. NAME SetTXPower -- Click element; Sets the transmit power for a packet. SYNOPSIS SetTXPower([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Sets the Wifi TXPower Annotation on a packet. Regular Arguments: <dl> <dt> </dt> <dd> Unsigned integer. from 0 to 63</dd> </dl> <dl> <dt> </dt> <dd> Same as POWER argument.</dd> </dl> text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/settxrate?rev=1236475441 This is automatically generated documentation. NAME SetTXRate -- Click element; Sets the bit-rate for a packet. SYNOPSIS SetTXRate([KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Sets the Wifi TXRate Annotation on a packet. Regular Arguments: <dl> <dt> </dt> <dd> Unsigned integer. Rate value is multiplied by 2 (i.e. 2means 1 Mbps, 11 means 5.5 Mbps)</dd> </dl> <dl> <dt> </dt> <dd> Same as RATE Argument</dd> </dl> text/html 2007-05-24T00:09:21-08:00 http://www.read.cs.ucla.edu/click/elements/setudpchecksum?rev=1179990561 This is automatically generated documentation. NAME SetUDPChecksum -- Click element; sets UDP packets' checksums SYNOPSIS SetUDPChecksum() Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: tcpudp (core) DESCRIPTION Input packets must be UDP in IP (the protocol field isn't checked). Calculates the UDP checksum and sets the UDP header's checksum field. Uses IP header fields to generate the pseudo-header. If input packets are IP fragments, or the UDP len… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/setwifiextraflag?rev=1140460872 This is automatically generated documentation. NAME SetWifiExtraFlag -- Click element; Sets the Wifi flags on a packet. SYNOPSIS SetWifiExtraFlag(Unsigned) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) Generated by 'click-elem2man' from '../elements/wifi/setwifiextraflag.hh' on 20/Feb/2006. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/shaper?rev=1236475441 This is automatically generated documentation. NAME Shaper -- Click element; shapes traffic to maximum rate (pkt/s) SYNOPSIS Shaper(RATE) Ports: 1 input, 1 output Processing: pull Package: standard (core) DESCRIPTION Shaper is a pull element that allows a maximum of RATE packets per second to pass through. That is, traffic is shaped to RATE packets per second. Shaper is dependent on the timing of its pull requests; if it receives only sporadic pull requests, then it will emit pack… text/html 2006-03-02T23:07:28-08:00 http://www.read.cs.ucla.edu/click/elements/simpacketanalyzer?rev=1141369648 This is automatically generated documentation. NAME SimPacketAnalyzer -- Click element; superclass for entering packet analyses in an ns2 trace SYNOPSIS SimPacketAnalyzer() Ports: none Drivers: ns Package: ns (core) DESCRIPTION Implement this interface for specific protocols to allow analysis of packets in ToSimTrace. text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/simplelocquerier?rev=1140460875 This is automatically generated documentation. NAME SimpleLocQuerier -- Click element; Sets Grid destination location by looking in a static table SYNOPSIS SimpleLocQuerier(DEST-IP LAT LON [, ...]) Ports: 1 input, 1 output Processing: push Drivers: userlevel Package: grid (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/simplepriosched?rev=1140460875 This is automatically generated documentation. NAME SimplePrioSched -- Click element; pulls from priority-scheduled inputs SYNOPSIS SimplePrioSched Ports: any number of inputs, 1 output Processing: pull Package: simple (core) DESCRIPTION Each time a pull comes in the output, SimplePrioSched pulls from each of the inputs starting from input 0. The packet from the first successful pull is returned. This amounts to a strict priority scheduler. The inputs usually come from Queues or o… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/simplequeue?rev=1236475441 This is automatically generated documentation. NAME SimpleQueue -- Click element; stores packets in a FIFO queue SYNOPSIS SimpleQueue SimpleQueue(CAPACITY) Ports: 1 input, 1-2 outputs Package: standard (core) DESCRIPTION Stores incoming packets in a first-in-first-out queue. Drops incoming packets if the queue already holds CAPACITY packets. The default for CAPACITY is 1000. Multithreaded Click note: SimpleQueue is designed to be used in an environment with at most one concurrent p… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/simpleroundrobinsched?rev=1140460875 This is automatically generated documentation. NAME SimpleRoundRobinSched -- Click element; pulls from round-robin inputs SYNOPSIS SimpleRoundRobinSched Ports: one output, zero or more inputs Processing: pull Package: simple (core) DESCRIPTION Each time a pull comes in the output, pulls from its inputs in turn until one produces a packet. When the next pull comes in, it starts from the input after the one that last produced a packet. This amounts to a round robin scheduler. The in… text/html 2006-05-19T18:00:42-08:00 http://www.read.cs.ucla.edu/click/elements/snmpoidinfo?rev=1148086842 This is automatically generated documentation. NAME SNMPOidInfo -- Click element; assigns names to SNMP object identifiers SYNOPSIS SNMPOidInfo(NAME OID, ...) Ports: None Package: snmp DESCRIPTION SNMPOidInfo introduces shorthand names for SNMP object identifiers. An SNMP object identifier, or "OID", represents a variable interesting to some SNMP manager or agent. It is a sequence of nonnegative 32-bit integers separated by periods. For example: text/html 2006-05-19T18:00:42-08:00 http://www.read.cs.ucla.edu/click/elements/snmptrapsource?rev=1148086842 This is automatically generated documentation. NAME SNMPTrapSource -- Click element; generates SNMP traps on demand SYNOPSIS SNMPTrapSource(KEYWORDS) Ports: no inputs, 1 output Processing: push Package: snmp DESCRIPTION SNMPTrapSource generates SNMP traps on demand. When the user writes to one of its trap-generation handlers, SNMPTrapSource constructs the corresponding trap, optionally including the values of some SNMP variables, and emits it on its first output. Keyword arguments… text/html 2006-05-19T18:00:42-08:00 http://www.read.cs.ucla.edu/click/elements/snmpvariableinfo?rev=1148086842 This is automatically generated documentation. NAME SNMPVariableInfo -- Click element; assigns variable semantics to SNMP OIDs SYNOPSIS SNMPVariableInfo(OID TYPE [HANDLER], ...) Ports: None Package: snmp DESCRIPTION SNMPVariableInfo sets up a correspondence between SNMP OIDs and Click handlers. When an element like SNMPTrapSource wants to generate an SNMP variable binding, it will call the handler specified by SNMPVariableInfo. Each argument specifies an SNMP OID and the SNMP type o… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/socket?rev=1236475441 This is automatically generated documentation. NAME Socket -- Click element; a socket transport (user-level) SYNOPSIS Socket("TCP", IP, PORTNUMBER [, LOCALIP] [, LOCALPORTNUMBER] [, KEYWORDS]) Socket("UDP", IP, PORTNUMBER [, LOCALIP] [, LOCALPORTNUMBER] [, KEYWORDS]) Socket("UNIX", FILENAME [, LOCALFILENAME] [, KEYWORDS]) Socket("UNIX_DGRAM", FILENAME [, LOCALFILENAME] [, KEYWORDS]) <dl> <dt> </dt> <dd> Unsigned integer. Maximum length of packets that can bereceived. Default is 2048 byte… text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/sortediplookup?rev=1140460874 This is automatically generated documentation. NAME SortedIPLookup -- Click element; simple IP routing table SYNOPSIS SortedIPLookup(ADDR1/MASK1 [GW1] OUT1, ADDR2/MASK2 [GW2] OUT2, ...) Ports: 1 input, any number of outputs Processing: push Package: ip (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/sorttest?rev=1236475442 This is automatically generated documentation. NAME SortTest -- Click element; runs regression tests for click_qsort SYNOPSIS SortTest([keywords]) Ports: none Package: test (core) DESCRIPTION SortTest runs click_qsort regression tests at initialization time. It does not route packets. If additional arguments are provided, SortTest will not perform its normal tests. Instead, it will sort those arguments and optionally print out the results. At userlevel a file can be sorted as well… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/sourceiphashmapper?rev=1236475441 This is automatically generated documentation. NAME SourceIPHashMapper -- Click element; Source IP Hash mapper for IPRewriter SYNOPSIS SourceIPHashMapper(NNODES SEED, PATTERN1, ..., PATTERNn) Ports: none Package: ip (core) DESCRIPTION Works in tandem with IPRewriter to provide source IP-based rewriting. This is useful, for example, in load-balancing applications. Implements the IPMapper interface. Like RoundRobinIPMapper, but also uses consistent hashing to map map elements by sourc… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/spinlockacquire?rev=1236475442 This is automatically generated documentation. NAME SpinlockAcquire -- Click element; acquires spinlock SYNOPSIS SpinlockAcquire(LOCK) Ports: 1 input, 1 output Processing: agnostic Package: threads DESCRIPTION Acquires the spinlock named LOCK. LOCK must be defined in a SpinlockInfo element. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/spinlockinfo?rev=1236475442 This is automatically generated documentation. NAME SpinlockInfo -- Click element; specifies names of spinlocks SYNOPSIS SpinlockInfo(NAME, ...) Ports: none Package: threads DESCRIPTION Lets you use mnemonic names for spinlocks. Each name names a spinlock that the SpinlockAcquire and SpinlockRelease elements can use to reference a spinlock. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/spinlockrelease?rev=1236475442 This is automatically generated documentation. NAME SpinlockRelease -- Click element; releases spinlock SYNOPSIS SpinlockRelease(LOCK) Ports: 1 input, 1 output Processing: agnostic Package: threads DESCRIPTION Releases the spinlock named LOCK. LOCK must be defined in a SpinlockInfo element. text/html 2006-05-19T18:00:43-08:00 http://www.read.cs.ucla.edu/click/elements/splitfirst?rev=1148086843 This is automatically generated documentation. NAME SplitFirst -- Click element; splits the first N packets to output port 1, to port 0 otherwise. SYNOPSIS SplitFirst(THRESHOLD) Ports: 1 input, 2 outputs Processing: Push Drivers: linuxmodule Package: unibo_qos <dl> <dt> </dt> <dd> Number of first incoming packets to filter out.</dd> </dl> text/html 2006-03-02T23:07:27-08:00 http://www.read.cs.ucla.edu/click/elements/sr1gatewayresponder?rev=1141369647 This is automatically generated documentation. NAME SR1GatewayResponder -- Click element; Responds to queries destined for this node. SYNOPSIS SR1GatewayResponder(IP, ETH, ETHERTYPE, SR1GatewayResponder element, LinkTable element, ARPtable element, text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/sr2checkheader?rev=1140460875 This is automatically generated documentation. NAME SR2CheckHeader -- Click element; Check the Source Route header of a packet. SYNOPSIS SR2CheckHeader() Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: wifi (core) text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/sr2destcache?rev=1140460876 This is automatically generated documentation. NAME SR2DestCache -- Click element SYNOPSIS SR2DestCache([GW ipaddress], [SEL GatewaySelector element]) Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) DESCRIPTION This element marks the gateway for a packet to be sent to. Either manually specifiy an gw using the GW keyword or automatically select it using a GatewaySelector element. text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/sr2ettmetric?rev=1140460873 This is automatically generated documentation. NAME SR2ETTMetric -- Click element; Estimated Transmission Time (ETT) metric SYNOPSIS SR2ETTMetric Ports: None Package: wifi (core) Generated by 'click-elem2man' from '../elements/wifi/sr2/sr2ettmetric.hh' on 20/Feb/2006. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/sr2ettstat?rev=1140460874 This is automatically generated documentation. NAME SR2ETTStat -- Click element; Track broadcast loss rates at different bitrates. SYNOPSIS SR2ETTStat([KEYWORDS]) Ports: 1 input, at most 1 output Processing: push Package: wifi (core) DESCRIPTION Expects probe packets as input. Records the last WINDOW unique (not neccessarily sequential) sequence numbers of link probes from each host, and calculates loss rates over the last TAU milliseconds for each host. If the output is connect… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/sr2forwarder?rev=1140460875 This is automatically generated documentation. NAME SR2Forwarder -- Click element; Forwards source-routed packets. SYNOPSIS SR2Forwarder(ETHERTYPE, IP, ETH, ARPTable element, LT LinkTable element [ETT element], [METRIC GridGenericMetric] ) Ports: 1 input, 2 outputs Processing: push Package: wifi (core) text/html 2006-03-02T23:07:28-08:00 http://www.read.cs.ucla.edu/click/elements/sr2gatewayresponder?rev=1141369648 This is automatically generated documentation. NAME SR2GatewayResponder -- Click element; Responds to queries destined for this node. SYNOPSIS SR2GatewayResponder(IP, ETH, ETHERTYPE, SR2GatewayResponder element, LinkTable element, ARPtable element, text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/sr2gatewayselector?rev=1140460874 This is automatically generated documentation. NAME SR2GatewaySelector -- Click element; Select a gateway to send a packet to based on TCP connection state and metric to gateway. SYNOPSIS SR2GatewaySelector(IP, ETH, ETHERTYPE, LinkTable, ARPTable, text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/sr2localbroadcast?rev=1140460876 This is automatically generated documentation. NAME SR2LocalBroadcast -- Click element; Floods a packet to 1-hop neighbors. SYNOPSIS SR2LocalBroadcast(IP, ETH, ETHERTYPE, SR2LocalBroadcast element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/sr2metricflood?rev=1140460875 This is automatically generated documentation. NAME SR2MetricFlood -- Click element; Floods a packet with previous hops based on Link Metrics. SYNOPSIS SR2MetricFlood(IP, ETH, ETHERTYPE, SR2MetricFlood element, LinkTable element, ARPtable element, text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/sr2print?rev=1140460873 This is automatically generated documentation. NAME SR2Print -- Click element; SYNOPSIS SR2Print([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Assumes input packets are SR packets (ie a sr_pkt struct from sr.hh). Prints out a description of those packets. Keyword arguments are: text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/sr2querier?rev=1140460873 This is automatically generated documentation. NAME SR2Querier -- Click element; Sends route queries if it can't find a valid source route. SYNOPSIS SR2Querier(IP, ETH, ETHERTYPE, SR2Querier element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 1 input, 2 outputs Processing: push Package: wifi (core) text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/sr2queryforwarder?rev=1140460874 This is automatically generated documentation. NAME SR2QueryForwarder -- Click element; Forwards Route Queries SYNOPSIS SR2QueryForwarder(IP, ETH, ETHERTYPE, SR2QueryForwarder element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 1 input, 1 output Processing: push Package: wifi (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/sr2queryresponder?rev=1140460875 This is automatically generated documentation. NAME SR2QueryResponder -- Click element; Responds to queries destined for this node. SYNOPSIS SR2QueryResponder(IP, ETH, ETHERTYPE, SR2QueryResponder element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 1 input, 1 output Processing: push Package: wifi (core) text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/sr2setchecksum?rev=1140460875 This is automatically generated documentation. NAME SR2SetChecksum -- Click element; Set Checksum for Source Routed packet. SYNOPSIS SR2SetChecksum() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Expects a SR MAC packet as input. Calculates the SR header's checksum and sets the version and checksum header fields. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/sr2setgateway?rev=1140460876 This is automatically generated documentation. NAME SR2SetGateway -- Click element SYNOPSIS SR2SetGateway([GW ipaddress], [SEL GatewaySelector element]) Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) DESCRIPTION This element marks the gateway for a packet to be sent to. Either manually specifiy an gw using the GW keyword or automatically select it using a GatewaySelector element. text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/sr2setsourceroute?rev=1140460875 This is automatically generated documentation. NAME SR2SetSourceRoute -- Click element; SYNOPSIS SR2SetSourceRoute(IP, SRForwarder element) Ports: 1 input, 1-2 outputs Processing: agnostic Package: wifi (core) DESCRIPTION Set the Source Route for packet's destination inside the source route header based on the destination ip annotation. If no source route is found for a given packet, the unmodified packet is sent to output 1 if the output is present. Regular Arguments: <dl> <dt> <… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/sr2stripheader?rev=1140460876 This is automatically generated documentation. NAME SR2StripHeader -- Click element; Strips outermost SR header SYNOPSIS SR2StripHeader() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Removes the outermost SR header from SR packets based on the SR Header annotation. text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/sr2txcountmetric?rev=1140460873 This is automatically generated documentation. NAME SR2TXCountMetric -- Click element; The Estimated Transmission Count metric (ETX). SYNOPSIS SR2TXCountMetric(LinkStat, LinkStat) Processing: agnostic Package: wifi (core) SEE ALSO ETTMetric text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/srdestcache?rev=1140460876 This is automatically generated documentation. NAME SRDestCache -- Click element SYNOPSIS SRDestCache([GW ipaddress], [SEL GatewaySelector element]) Ports: 2 inputs, 2 outputs Processing: push Package: wifi (core) DESCRIPTION This element marks the gateway for a packet to be sent to. Either manually specifiy an gw using the GW keyword or automatically select it using a GatewaySelector element. text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/srforwarder?rev=1140460872 This is automatically generated documentation. NAME SRForwarder -- Click element; Forwards source-routed packets. SYNOPSIS SRForwarder(ETHERTYPE, IP, ETH, ARPTable element, LT LinkTable element [ETT element], [METRIC GridGenericMetric] ) Ports: 1 input, 2 outputs Processing: push Package: wifi (core) text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/srlog?rev=1140460876 This is automatically generated documentation. NAME SRLog -- Click element; Log transmit feedback stats for later analysis. SYNOPSIS SRLog(KEYWORKDS) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION SRLog records the size, timestamp, and other infor for each packet that passed through. The list of recorded data can be dumped (and cleared) by repeated calls to the read handler 'log'. <dl> <dt> </dt> <dd> Print as much of the list of logged packets as … text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/srquerier?rev=1140460876 This is automatically generated documentation. NAME SRQuerier -- Click element; Sends route queries if it can't find a valid source route. SYNOPSIS SRQuerier(IP, ETH, ETHERTYPE, SRQuerier element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 1 input, 2 outputs Processing: push Package: wifi (core) text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/srqueryforwarder?rev=1140460874 This is automatically generated documentation. NAME SRQueryForwarder -- Click element; Forwards Route Queries SYNOPSIS SRQueryForwarder(IP, ETH, ETHERTYPE, SRQueryForwarder element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 1 input, 1 output Processing: push Package: wifi (core) text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/srqueryresponder?rev=1140460873 This is automatically generated documentation. NAME SRQueryResponder -- Click element; Responds to queries destined for this node. SYNOPSIS SRQueryResponder(IP, ETH, ETHERTYPE, SRQueryResponder element, LinkTable element, ARPtable element, [METRIC GridGenericMetric], [WARMUP period in seconds]) Ports: 1 input, 1 output Processing: push Package: wifi (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/staticiplookup?rev=1179990969 This is automatically generated documentation. NAME StaticIPLookup -- Click element; simple static IP routing table SYNOPSIS StaticIPLookup(ADDR1/MASK1 [GW1] OUT1, ADDR2/MASK2 [GW2] OUT2, ...) Ports: 1 input, any number of outputs Processing: push Package: ip (core) <dl> <dt> </dt> <dd> Outputs a human-readable version of the current routing table.</dd> </dl> <dl> <dt> </dt> <dd> Reports the OUTput port and GW corresponding to an address.</dd> </dl> text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/staticpullswitch?rev=1190150828 This is automatically generated documentation. NAME StaticPullSwitch -- Click element; forwards pull requests to fixed input SYNOPSIS StaticPullSwitch(INPUT) Ports: any number of inputs, 1 output Processing: pull Package: standard (core) DESCRIPTION On every pull, StaticPullSwitch returns the packet pulled from one of its input ports -- specifically, INPUT. Negative INPUTs mean always return a null packet. StaticPullSwitch has an unlimited number of inputs. text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/staticswitch?rev=1190150829 This is automatically generated documentation. NAME StaticSwitch -- Click element; sends packet stream to fixed output SYNOPSIS StaticSwitch(OUTPUT) Ports: 1 input, any number of outputs Processing: push Package: standard (core) DESCRIPTION StaticSwitch sends every incoming packet to one of its output ports -- specifically, OUTPUT. Negative OUTPUT means to destroy input packets instead of forwarding them. StaticSwitch has an unlimited number of outputs. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/staticthreadsched?rev=1236475441 This is automatically generated documentation. NAME StaticThreadSched -- Click element; specifies element and thread scheduling parameters SYNOPSIS StaticThreadSched(ELEMENT THREAD, ...) Ports: none Package: threads DESCRIPTION Statically binds elements to threads. If more than one StaticThreadSched is specified, they will all run. The one that runs later may override an earlier run. text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/storedata?rev=1140460876 This is automatically generated documentation. NAME StoreData -- Click element; changes packet data SYNOPSIS StoreData(OFFSET, DATA) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Changes packet data starting at OFFSET to DATA. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/storeetheraddress?rev=1236475442 This is automatically generated documentation. NAME StoreEtherAddress -- Click element; stores Ethernet address in packet SYNOPSIS StoreEtherAddress(ADDR, OFFSET) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ethernet (core) <dl> <dt> </dt> <dd> Return or set the ADDR argument.</dd> </dl> text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/storeipaddress?rev=1236475441 This is automatically generated documentation. NAME StoreIPAddress -- Click element; stores IP address in packet SYNOPSIS StoreIPAddress(OFFSET) StoreIPAddress(ADDR, OFFSET) Ports: 1 input, 1-2 outputs Processing: agnostic, but output 1 is push Package: ip (core) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/storetimestamp?rev=1179990969 This is automatically generated documentation. NAME StoreTimestamp -- Click element; store packet timestamps in packet data SYNOPSIS StoreTimestamp([keywords OFFSET, TAIL]) Ports: 1 input, 1 output Processing: agnostic Package: analysis (core) <dl> <dt> </dt> <dd> Integer. Store the timestamp starting OFFSET bytes into the packet. Thepacket will be extended, if necessary, so that it's at least OFFSET+8 byteslong.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If true, the timestamp wil… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/stridesched?rev=1179990969 This is automatically generated documentation. NAME StrideSched -- Click element; pulls from stride-scheduled inputs SYNOPSIS StrideSched(TICKETS0, ..., TICKETSN-1) Ports: 1 or more inputs, 1 output Processing: pull Package: standard (core) <dl> <dt> </dt> <dd> Returns or sets the number of tickets for each input port.</dd> </dl> text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/strideswitch?rev=1179990969 This is automatically generated documentation. NAME StrideSwitch -- Click element; sends packets to stride-scheduled outputs SYNOPSIS StrideSwitch(TICKETS0, ..., TICKETSN-1) Ports: 1 input, 1 or more outputs Processing: push Package: standard (core) <dl> <dt> </dt> <dd> Returns or sets the number of tickets for each output port.</dd> </dl> text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/strip?rev=1190150828 This is automatically generated documentation. NAME Strip -- Click element; strips bytes from front of packets SYNOPSIS Strip(LENGTH) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Deletes the first LENGTH bytes from each packet. text/html 2006-05-19T18:00:36-08:00 http://www.read.cs.ucla.edu/click/elements/stripgreheader?rev=1148086836 This is automatically generated documentation. NAME StripGREHeader -- Click element; strips outermost GRE header SYNOPSIS StripGREHeader() Ports: 1 input, 1 output Processing: agnostic Package: @CLICKPACKAGENAME@ DESCRIPTION Removes the outermost GRE header from GRE packets. text/html 2006-03-02T23:07:27-08:00 http://www.read.cs.ucla.edu/click/elements/stripipheader?rev=1141369647 This is automatically generated documentation. NAME StripIPHeader -- Click element; strips outermost IP header SYNOPSIS StripIPHeader() Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Strips the outermost IP header from IP packets, based on the IP Header annotation. Note that the packet's annotations are not changed. Thus, the packet's IP header annotation continues to point at the IP header, even though the IP header's data is now out of range. To c… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/stripsrheader?rev=1140460873 This is automatically generated documentation. NAME StripSRHeader -- Click element; Strips outermost SR header SYNOPSIS StripSRHeader() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Removes the outermost SR header from SR packets based on the SR Header annotation. text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/striptonetworkheader?rev=1140460872 This is automatically generated documentation. NAME StripToNetworkHeader -- Click element; strips everything preceding network header SYNOPSIS StripToNetworkHeader() Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Strips any data preceding the network header from every passing packet. Requires a network header annotation, such as an IP header annotation, on every packet. If the packet's network header annotation points before the start of the pac… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/suppressor?rev=1179990969 This is automatically generated documentation. NAME Suppressor -- Click element; passes packets unchanged, optionally dropping some input ports SYNOPSIS Suppressor Ports: any number of inputs, the same number of outputs Processing: agnostic Package: standard (core) <dl> <dt> </dt> <dd> Returns or sets whether each port is active (that is, not suppressed).Every port starts out active.</dd> </dl> <dl> <dt> </dt> <dd> Resets every port to active.</dd> </dl> text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/switch?rev=1190150829 This is automatically generated documentation. NAME Switch -- Click element; sends packet stream to settable output SYNOPSIS Switch([OUTPUT]) Ports: 1 input, any number of outputs Processing: push Package: standard (core) DESCRIPTION Switch sends every incoming packet to one of its output ports -- specifically, OUTPUT. The default OUTPUT is zero; negative OUTPUT means to destroy input packets instead of forwarding them. You can change OUTPUT with a write handler. Switch has an unl… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/tcpack?rev=1140460875 This is automatically generated documentation. NAME TCPAck -- Click element; acknowledge TCP packets SYNOPSIS TCPAck([ACK_DELAY]) Ports: 2 inputs, 3 outputs Package: local (core) DESCRIPTION performs TCP style acknowledgement. marked TCP/IP packets are expected on both input and output ports. use MarkIPHeader to mark packets. input port 0 is TCP input. a packet that arrives on this input may trigger an acknowledgement. the acknowledgement acknowledges the latest in-order packet rece… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/tcpbuffer?rev=1140460872 This is automatically generated documentation. NAME TCPBuffer -- Click element; buffer TCP packets SYNOPSIS TCPBuffer([SKIP]) Ports: 1 input, 1 output Processing: push inputs, pull outputs Package: local (core) DESCRIPTION provides in order TCP buffer. expects TCP packets on input. packets arriving at the input push port are inserted into a linked list, sorted increasingly on the tcp sequence number. packets with a sequence number already on the list will be dropped. packets are p… text/html 2007-01-27T23:34:40-08:00 http://www.read.cs.ucla.edu/click/elements/tcpcollector?rev=1169969680 This is automatically generated documentation. NAME TCPCollector -- Click element; collects information about TCP flows SYNOPSIS TCPCollector([TRACEINFO, keywords TRACEINFO, SOURCE, NOTIFIER, IP_ID, PACKET, FULLRCVWINDOW, WINDOWPROBE, INTERARRIVAL]) <dl> <dt> </dt> <dd> Filename. If given, then output information about each aggregate to thatfile, in an XML format. See below for an example.</dd> </dl> <dl> <dt> </dt> <dd> Element. If provided, the results of that element's and read handl… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/tcpconn?rev=1140460873 This is automatically generated documentation. NAME TCPConn -- Click element; manage tcp connections SYNOPSIS TCPConn() Ports: 2 inputs, 3 outputs Package: local (core) DESCRIPTION can either start a tcp connection or listen for connections. input and output 0 carry incoming packets; input and output 1 carry outgoing packets; output 2 send out SYNs and SYN ACKs. incoming packets are pushed onto input 0, but outgoing packets are pulled thru input/output 1. does not allow output pull … text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/tcpdemux?rev=1140460874 This is automatically generated documentation. NAME TCPDemux -- Click element; demultiplexes TCP flows SYNOPSIS TCPDemux() Ports: 1 input, 1 output Processing: push Package: local (core) DESCRIPTION for now, output 0 = SYN output 1 = FIN | RST output 2 = others text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/tcpipsend?rev=1179990969 This is automatically generated documentation. NAME TCPIPSend -- Click element; generates TCP/IP packets when requested SYNOPSIS TCPIPSend() Ports: no inputs, 1 output Processing: push Package: tcpudp (core) DESCRIPTION Sends TCP/IP packets when asked to do so. No inputs. One output. <dl> <dt> </dt> <dd> Expects a string &quot;saddr sport daddr dport seqn ackn bits&quot; with theirobvious meaning. Bits is the value of the 6 TCP flags.</dd> </dl> text/html 2006-02-24T10:50:51-08:00 http://www.read.cs.ucla.edu/click/elements/tcpmystery?rev=1140807051 This is automatically generated documentation. NAME TCPMystery -- Click element; analyzes TCP flows SYNOPSIS TCPMystery(TCPCOLLECTOR [, keywords RTT, SEMIRTT, ACKCAUSATION]) Ports: None Drivers: userlevel Package: models DESCRIPTION Analyzes TCP flows and dumps various flow information to an XML trace info file. Both the flows and the trace info file are handled through a TCPCollector collector element elsewhere in the connection; TCPMystery itself has no inputs or outputs. Keywo… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/tcpreflector?rev=1140460875 This is automatically generated documentation. NAME TCPReflector -- Click element; pretend to be a TCP server SYNOPSIS TCPReflector() Ports: 1 input, 1 output Processing: agnostic Package: local (core) DESCRIPTION Pretend to be a TCP server; emit a plausible reply packet to each incoming TCP/IP packet. Maintains no state, so should be very fast. text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/tcprewriter?rev=1179990969 This is automatically generated documentation. NAME TCPRewriter -- Click element; rewrites TCP packets' addresses, ports, and sequence numbers SYNOPSIS TCPRewriter(INPUTSPEC1, ..., INPUTSPECn [, KEYWORDS]) Ports: 1 or more inputs, 1-256 outputs Processing: push Package: tcpudp (core) <dl> <dt> </dt> <dd> Time out TCP connections every seconds. Default is 24 hours.</dd> </dl> <dl> <dt> </dt> <dd> Time out completed TCP connections every seconds. Default is 30seconds. FIN and RST fl… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/tee?rev=1140460873 This is automatically generated documentation. NAME Tee, PullTee -- Click elements; duplicates packets SYNOPSIS Tee([N]) PullTee([N]) Ports: 1 input, 1 or more outputs Processing: push Package: standard (core) DESCRIPTION Tee sends a copy of each incoming packet out each output. PullTee's input and its first output are pull; its other outputs are push. Each time the pull output pulls a packet, it sends a copy out the push outputs. Tee and PullTee have however many outputs are us… text/html 2006-02-24T10:50:51-08:00 http://www.read.cs.ucla.edu/click/elements/testipaddrcolors?rev=1140807051 This is automatically generated documentation. NAME TestIPAddrColors -- Click element; tests an IP address coloring SYNOPSIS TestIPAddrColors(FILENAME, KEYWORDS) Ports: 1 input, 1 output Processing: agnostic Drivers: userlevel Package: models <dl> <dt> </dt> <dd> Boolean. If true, then print a message on every coloring error. Default isfalse.</dd> </dl> <dl> <dt> </dt> <dd> Returns the number of packets seen.</dd> </dl> <dl> <dt> </dt> <dd> Returns the number of packets seen with… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/threadmonitor?rev=1140460875 This is automatically generated documentation. NAME ThreadMonitor -- Click element; print out thread status SYNOPSIS ThreadMonitor([INTERVAL, THRESH]) Ports: none Drivers: linuxmodule Package: linuxmodule (core) DESCRIPTION Every INTERVAL number of ms, print out tasks scheduled on each thread if tasks are busy. INTERVAL by default is 1000 ms. Only tasks with cycle count of at least THRESH are printed. By default THRESH is 1000 cycles. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/threadsafequeue?rev=1236475442 This is automatically generated documentation. NAME ThreadSafeQueue -- Click element; stores packets in a FIFO queue SYNOPSIS ThreadSafeQueue ThreadSafeQueue(CAPACITY) Ports: 1 input, 1-2 outputs Package: standard (core) DESCRIPTION Stores incoming packets in a first-in-first-out queue. Drops incoming packets if the queue already holds CAPACITY packets. The default for CAPACITY is 1000. This variant of the default Queue is (should be) completely thread safe, in that it supports mul… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/thresholdmetric?rev=1236475441 This is automatically generated documentation. NAME ThresholdMetric -- Click element; SYNOPSIS ThresholdMetric(LINKSTAT, [, KEYWORDS]) Ports: None Package: grid (core) DESCRIPTION Child class of GridGenericMetric that implements the delivery ratio threshold metric. Links with a delivery ratio larger than a given threshold (specified by the THRESH keyword argument) are considered good; links with a smaller delivery ratio are considered bad. The metric of a route with all good links… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/timedsink?rev=1236475441 This is automatically generated documentation. NAME TimedSink -- Click element; periodically pulls and drops a packet SYNOPSIS TimedSink([INTERVAL]) Ports: 1 input, no outputs Processing: pull Package: standard (core) DESCRIPTION Pulls one packet every INTERVAL seconds from its input. Discards the packet. Default INTERVAL is 500 milliseconds. <dl> <dt> </dt> <dd> Returns or sets the INTERVAL parameter.</dd> </dl> text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/timedsource?rev=1236475442 This is automatically generated documentation. NAME TimedSource -- Click element; periodically generates a packet SYNOPSIS TimedSource([INTERVAL, DATA, KEYWORDS]) Ports: no inputs, 1 output Processing: push Package: standard (core) DESCRIPTION Creates packets consisting of DATA. Pushes such a packet out its single output about once every INTERVAL seconds. Default INTERVAL is 500 milliseconds; default DATA is at least 64 bytes long. Keyword arguments are: <dl> <dt> </dt> <dd> Strin… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/timedunqueue?rev=1236475442 This is automatically generated documentation. NAME TimedUnqueue -- Click element; pull-to-push converter SYNOPSIS TimedUnqueue(INTERVAL [, BURST]) Ports: 1 input, 1 output Processing: pull inputs, push outputs Package: standard (core) DESCRIPTION Pulls at most BURST packets per INTERVAL (seconds) from its input, pushing them out its single output. Default BURST is 1. If BURST is 1, and packets arrive upstream at a rate of less than 1 packet per INTERVAL, then in steady state Tim… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/timefilter?rev=1236475442 This is automatically generated documentation. NAME TimeFilter -- Click element; filter packets by timestamp SYNOPSIS 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) <dl> <dt> </dt> <dd> is absolute time in seconds since the epoch. Output packets withtimestamps at least .</dd> </dl> <dl> <dt> </dt> <dd> is relative time in second… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/timerange?rev=1179990969 This is automatically generated documentation. NAME TimeRange -- Click element; monitor range of packet timestamps SYNOPSIS TimeRange(keyword SIMPLE) Ports: 1 input, 1 output Processing: agnostic Package: analysis (core) DESCRIPTION TimeRange passes packets along unchanged, monitoring the smallest range that contains all of their timestamps. You can access that range with handlers. Keyword arguments are: <dl> <dt> </dt> <dd> Boolean. If true, then packets arrive at TimeRange with … text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/timesortedsched?rev=1179990969 This is automatically generated documentation. NAME TimeSortedSched -- Click element; merge sorted packet streams by timestamp SYNOPSIS TimeSortedSched(KEYWORDS) Ports: one output, zero or more inputs Processing: pull Package: analysis (core) <dl> <dt> </dt> <dd> Boolean. If true, stop the driver when there are no packets available (and theupstream notifiers indicate that no packets will become available soon).Default is false.</dd> </dl> text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/timestampaccum?rev=1236475441 This is automatically generated documentation. NAME TimestampAccum -- Click element; collects differences in timestamps SYNOPSIS TimestampAccum() Ports: 1 input, 1 output Processing: agnostic Drivers: userlevel Package: analysis (core) DESCRIPTION For each passing packet, measures the elapsed time since the packet's timestamp. Keeps track of the total elapsed time accumulated over all packets. <dl> <dt> </dt> <dd> Returns the number of packets that have passed.</dd> </dl> <dl> … text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/todevice.b?rev=1236475442 This is automatically generated documentation. NAME ToDevice.b -- Click element; sends packets to network device (BSD kernel) SYNOPSIS ToDevice(DEVNAME [, BURST, KEYWORDS]) Ports: 1 input, no outputs Processing: pull Drivers: bsdmodule Package: bsdmodule (core) <dl> <dt> </dt> <dd> Unsigned integer. Same as the BURST argument.</dd> </dl> <dl> <dt> </dt> <dd> Allow nonexistent devices. If true, and no device named DEVNAME exists whenthe router is initialized, then will report a wa… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/todevice?rev=1236475442 This is automatically generated documentation. NAME ToDevice -- Click element; sends packets to network device (Linux kernel) SYNOPSIS ToDevice(DEVNAME [, BURST, KEYWORDS]) Ports: 1 input, no outputs Processing: pull Drivers: linuxmodule Package: linuxmodule (core) <dl> <dt> </dt> <dd> Unsigned integer. Same as the BURST argument.</dd> </dl> <dl> <dt> </dt> <dd> Boolean. If true, then suppress device up/down messages. Default is false.</dd> </dl> <dl> <dt> </dt> <dd> Allow none… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/todevice.u?rev=1236475442 This is automatically generated documentation. NAME ToDevice.u -- Click element; sends packets to network device (user-level) SYNOPSIS ToDevice(DEVNAME [, KEYWORDS]) Ports: 1 input, at most 2 outputs Processing: pull inputs, push outputs Drivers: userlevel Package: userlevel (core) <dl> <dt> </dt> <dd> Boolean. If true, print out debug messages.This element is only available at user level.</dd> </dl> text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/todump?rev=1179990969 This is automatically generated 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) <dl> <dt> </dt> <dd> Integer. See above.</dd> </dl> <dl> <dt> </dt> <dd> The encapsulation type to store in the dump. See above.</dd> </dl> <dl> <dt> </dt> <dd> Argument is a space-sepa… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/tohost?rev=1236475442 This is automatically generated documentation. NAME ToHost -- Click element; sends packets to Linux SYNOPSIS ToHost([DEVNAME, keywords]) Ports: 1 input, no outputs Processing: push Drivers: linuxmodule Package: linuxmodule (core) DESCRIPTION Hands packets to the ordinary Linux protocol stack. You should probably give Linux IP packets addressed to the local machine (including broadcasts), and a copy of each ARP reply. If DEVNAME is present, each packet is marked to appear as if i… text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/tohost.u?rev=1179990969 This is automatically generated documentation. NAME ToHost.u -- Click element; sends packets to Linux via Universal TUN/TAP device. SYNOPSIS ToHost([DEVNAME]) Ports: 1 input, no outputs Processing: push Drivers: userlevel Package: userlevel (core) <dl> <dt> </dt> <dd> Reports the number of packets has dropped because they had a nulldevice annotation.</dd> </dl> text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/tohostsniffers?rev=1236475441 This is automatically generated documentation. NAME ToHostSniffers -- Click element; sends packets to Linux packet sniffers SYNOPSIS ToHostSniffers([DEVNAME, keywords]) Ports: 1 input, no outputs Processing: push Drivers: linuxmodule Package: linuxmodule (core) text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/toipflowdumps?rev=1190150829 This is automatically generated documentation. NAME ToIPFlowDumps -- Click element; creates separate trace files for each TCP/UDP flow SYNOPSIS ToIPFlowDumps(FILEPATTERN [, KEYWORDS]) Ports: 1 input, at most 1 output Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> The name of an AggregateNotifier element, like . If given,then ToIPFlowDumps will ask the element for notification when flows aredeleted. It uses that notification to free its state e… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/toipsummarydump?rev=1236475442 This is automatically generated documentation. NAME ToIPSummaryDump -- Click element; writes packet summary information to an ASCII file SYNOPSIS ToIPSummaryDump(FILENAME [, keywords]) Ports: 1 input, no outputs Processing: agnostic Drivers: userlevel Package: analysis (core) <dl> <dt> </dt> <dd> Space-separated list of field names. Each line of the summary dump willcontain those fields. Valid field names, with examples, are: timestamp Packet timestamp: '996033261.451094' (e… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/torawsocket?rev=1140460872 This is automatically generated documentation. NAME ToRawSocket -- Click element; sends IP packets through a safe raw socket (user-level) SYNOPSIS ToRawSocket("TCP", <TCP source port number>) ToRawSocket("UDP", <UDP source port number>) ToRawSocket("GRE", <GRE key or PPTP call ID>) ToRawSocket("ICMP", <ICMP identifier>) text/html 2007-05-24T00:16:09-08:00 http://www.read.cs.ucla.edu/click/elements/tosimdevice.u?rev=1179990969 This is automatically generated documentation. NAME ToSimDevice.u -- Click element; sends packets to simulated network device SYNOPSIS ToSimDevice(DEVNAME [, ENCAP]) Ports: 1 input, no outputs Processing: agnostic Drivers: ns Package: ns (core) <dl> <dt> </dt> <dd> Word. The interface's encapsulation type. Options are ETHER, IP, andUNKNOWN; default is ETHER.</dd> </dl> text/html 2006-03-02T23:07:27-08:00 http://www.read.cs.ucla.edu/click/elements/tosimtrace?rev=1141369647 This is automatically generated documentation. NAME ToSimTrace -- Click element; adds trace entries to an ns2 trace file SYNOPSIS ToSimTrace() Ports: One input, one output Processing: push Drivers: ns Package: ns (core) DESCRIPTION This element allows you to add trace entries to an ns2 trace file. The event id is used to set "r" (receive), "f" (forward), "D" (drop), "s" (send) or any other id. The timestamp is set to the current time. The packet length that is traced is obtained… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/tosocket?rev=1140460875 This is automatically generated documentation. NAME ToSocket -- Click element; sends data to socket (user-level) SYNOPSIS ToSocket("TCP", IP, PORTNUMBER [, KEYWORDS]) ToSocket("UDP", IP, PORTNUMBER [, KEYWORDS]) ToSocket("UNIX", FILENAME [, KEYWORDS]) ToSocket("UNIX_DGRAM", FILENAME [, KEYWORDS]) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/touserdevice?rev=1236475442 This is automatically generated documentation. NAME ToUserDevice -- Click element; Writes packets from the click into a device's ring buffer, which can be then read by a userlevel application. SYNOPSIS ToUserDevice(DEV_MINOR, [<keywords> CAPACITY, BURST]) <dl> <dt> </dt> <dd> Unsigned integer. Sets the capacity of the internal ring buffer that storesthe packets.</dd> </dl> <dl> <dt> </dt> <dd> Sets the maximum number of packets returned per multipacket read. Default is0, which means no l… text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/toytcp?rev=1140460876 This is automatically generated documentation. NAME ToyTCP -- Click element; SYNOPSIS ToyTCP(dport) Ports: 1 input, 1 output Processing: push Package: local (core) DESCRIPTION EXAMPLES FromDevice(...) * > Strip(34) * > ToyTCP(80) * > IPEncap(6, 1.0.0.1, 1.0.0.2) * > SetTCPChecksum * > EtherEncap(0x0800, ..., ...) * > ToDevice(...) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/truncate?rev=1236475442 This is automatically generated documentation. NAME Truncate -- Click element; limit packet length. SYNOPSIS Truncate(LENGTH) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Shorten packets to at most LENGTH bytes. The EXTRA_LENGTH keyword argument determines whether packets' extra length annotations are updated to account for any dropped bytes. Default is true. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/truncateippayload?rev=1236475441 This is automatically generated documentation. NAME TruncateIPPayload -- Click element; limit payload length SYNOPSIS TruncateIPPayload([LENGTH, TRANSPORT]) Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Shorten IP packets to have payload of at most LENGTH bytes. Normally "payload" begins at the end of the transport header (TruncateIPPayload understands TCP, UDP, and ICMP headers). If TRANSPORT is false, "payload" begins at the end of the IP header.… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/txcountmetric?rev=1140460875 This is automatically generated documentation. NAME TXCountMetric -- Click element; The Estimated Transmission Count metric (ETX). SYNOPSIS TXCountMetric(LinkStat, LinkStat) Processing: agnostic Package: wifi (core) SEE ALSO ETTMetric Generated by 'click-elem2man' from '../elements/wifi/sr/txcountmetric.hh' on 20/Feb/2006. text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/txflog?rev=1140460873 This is automatically generated documentation. NAME TXFLog -- Click element; Log transmit feedback stats for later analysis. SYNOPSIS TXFLog(KEYWORKDS) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION TXFLog records the size, timestamp, and other infor for each packet that passed through. The list of recorded data can be dumped (and cleared) by repeated calls to the read handler 'log'. <dl> <dt> </dt> <dd> Print as much of the list of logged packets … text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/txstat?rev=1140460873 This is automatically generated documentation. NAME TXStat -- Click element; Track tx stats SYNOPSIS TXStat([KEYWORDS]) Ports: 1 input, at most 1 output Processing: push Package: wifi (core) DESCRIPTION blah blah blah. Keyword arguments are: <dl> <dt> </dt> <dd> Ethernet and IP addresses of this node, respectively; required ifoutput is connected.</dd> </dl> text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/udpipencap?rev=1190150828 This is automatically generated documentation. NAME UDPIPEncap -- Click element; encapsulates packets in static UDP/IP headers SYNOPSIS UDPIPEncap(SRC, SPORT, DST, DPORT [, CHECKSUM]) Ports: 1 input, 1 output Processing: agnostic Package: tcpudp (core) <dl> <dt> </dt> <dd> Returns or sets the SRC source address argument.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the SPORT source port argument.</dd> </dl> <dl> <dt> </dt> <dd> Returns or sets the DST destination address argumen… text/html 2007-01-27T23:32:31-08:00 http://www.read.cs.ucla.edu/click/elements/umlswitch?rev=1169969551 This is automatically generated documentation. NAME UMLSwitch -- Click element; Connects to a UML switch daemon SYNOPSIS UMLSwitch([FILENAME]) Ports: at most 1 input, at most 1 output Processing: pull inputs, push outputs Drivers: userlevel Package: userlevel (core) text/html 2007-09-18T14:27:08-08:00 http://www.read.cs.ucla.edu/click/elements/unqueue?rev=1190150828 This is automatically generated documentation. NAME Unqueue -- Click element; pull-to-push converter SYNOPSIS Unqueue([BURST, KEYWORDS]) Ports: 1 input, 1 output Processing: pull inputs, push outputs Package: standard (core) DESCRIPTION Pulls packets whenever they are available, then pushes them out its single output. Pulls a maximum of BURST packets every time it is scheduled. Default BURST is 1. If BURST is less than 0, pull until nothing comes back. Keyword arguments are: <dl> … text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/unqueue2?rev=1140460873 This is automatically generated documentation. NAME Unqueue2 -- Click element; pull-to-push converter SYNOPSIS Unqueue2([BURSTSIZE]) Ports: 1 input, 1 output Processing: pull inputs, push outputs Package: standard (core) DESCRIPTION Pulls packets whenever they are available, then pushes them out its single output. Pulls a maximum of BURSTSIZE packets every time it is scheduled, unless downstream queues are full. Default BURSTSIZE is 1. If BURSTSIZE is 0, pull until nothing comes b… text/html 2007-09-18T14:27:09-08:00 http://www.read.cs.ucla.edu/click/elements/unstrip?rev=1190150829 This is automatically generated documentation. NAME Unstrip -- Click element; unstrips bytes from front of packets SYNOPSIS Unstrip(LENGTH) Ports: 1 input, 1 output Processing: agnostic Package: standard (core) DESCRIPTION Put LENGTH bytes at the front of the packet. These LENGTH bytes may be bytes previously removed by Strip. text/html 2006-03-02T23:07:28-08:00 http://www.read.cs.ucla.edu/click/elements/unstripipheader?rev=1141369648 This is automatically generated documentation. NAME UnstripIPHeader -- Click element; restores outermost IP header SYNOPSIS UnstripIPHeader() Ports: 1 input, 1 output Processing: agnostic Package: ip (core) DESCRIPTION Put outermost IP header back onto a stripped packet, based on the IP Header annotation from MarkIPHeader or CheckIPHeader. If IP header already on, forwards packet unmodified. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/updategridroutes?rev=1236475442 This is automatically generated documentation. NAME UpdateGridRoutes -- Click element; Run DSDV-like local routing protocol. SYNOPSIS UpdateGridRoutes(TIMEOUT, PERIOD, JITTER, ETH, IP [, MAXHOPS]) Ports: 1 input, 2 outputs Processing: agnostic Drivers: userlevel Package: grid (core) text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/upstreamnotifier?rev=1236475441 This is automatically generated documentation. NAME UpstreamNotifier -- Click element; passes packets unchanged. Has an upstream notifier. Generally used for testing upstream notification. SYNOPSIS UpstreamNotifier([SIGNAL]) Ports: 1 input, 1 output Processing: push Package: test (core) <dl> <dt> </dt> <dd> Boolean. Whether to set the upstream signal to active.</dd> </dl> <dl> <dt> </dt> <dd> Returns if the signal is active. Same as the SIGNAL argument.</dd> </dl> text/html 2006-02-20T10:41:16-08:00 http://www.read.cs.ucla.edu/click/elements/vectortest?rev=1140460876 This is automatically generated documentation. NAME VectorTest -- Click element; runs regression tests for Vector SYNOPSIS VectorTest() Ports: none Package: test (core) DESCRIPTION VectorTest runs Vector regression tests at initialization time. It does not route packets. text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/webgen?rev=1140460875 This is automatically generated documentation. NAME WebGen -- Click element; SYNOPSIS WebGen(PREFIX/LEN, DST) Ports: 1 input, 1 output Processing: push Package: local (core) DESCRIPTION Ask for a random web pages over and over with repeated HTTP connections. Generate them with random source IP addresses starting with PREFIX. text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/wepdecap?rev=1236475441 This is automatically generated documentation. NAME WepDecap -- Click element; Turns 802.11 packets into ethernet packets SYNOPSIS WepDecap Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION EXAMPLES wifi_cl :: Classifier (0/00%0c, 0/04%0c, 0/08%0c); wifi_cl [0] -> Discard; //mgt wifi_cl [1] -> Discard; //ctl wifi_cl [2] -> wifi_decap :: WepDecap() -> ... SEE ALSO WifiEncap text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/wepencap?rev=1236475441 This is automatically generated documentation. NAME WepEncap -- Click element; Turns 802.11 packets into ethernet packets SYNOPSIS WepEncap Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION EXAMPLES wifi_cl :: Classifier (0/00%0c, 0/04%0c, 0/08%0c); wifi_cl [0] -> Discard; //mgt wifi_cl [1] -> Discard; //ctl wifi_cl [2] -> wifi_decap :: WepEncap() -> ... SEE ALSO WifiEncap text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/wificounter?rev=1140460872 This is automatically generated documentation. NAME WifiCounter -- Click element; Accumulate wificounter for each ethernet src you hear a packet from. SYNOPSIS WifiCounter() Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/wifidecap?rev=1140460873 This is automatically generated documentation. NAME WifiDecap -- Click element; Turns 802.11 packets into ethernet packets. SYNOPSIS WifiDecap Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION Strips the 802.11 frame header and llc header off the packet and pushes an ethernet header onto the packet. Discards packets that are shorter than the length of the 802.11 frame header and llc header. text/html 2006-02-20T10:41:14-08:00 http://www.read.cs.ucla.edu/click/elements/wifidefrag?rev=1140460874 This is automatically generated documentation. NAME WifiDefrag -- Click element; Reassembles 802.11 fragments. SYNOPSIS WifiDefrag Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) DESCRIPTION This element reassembles 802.11 fragments and pushes the reassembled packet out when the last fragment is received. It does not affect packets that are not fragmented, and passes them through its output unmodified. In accordance with the 802.11 spec, it supports a single pa… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/wifidupefilter?rev=1140460875 This is automatically generated documentation. NAME WifiDupeFilter -- Click element; Filters out duplicate 802.11 packets based on their sequence number. SYNOPSIS WifiDupeFilter([TAG] [, KEYWORDS]) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/wifiencap?rev=1236475442 This is automatically generated documentation. NAME WifiEncap -- Click element; Converts ethernet packets to 802.11 packets with a LLC header. SYNOPSIS WifiEncap(MODE, BSSID) Ports: 1 input, 1 output Processing: agnostic Package: wifi (core) <dl> <dt> </dt> <dd> is an ethernet address. This ususally the access point's ethernet address.If you are using Mode 0, this is usually set to 00:00:00:00:00:00 for&quot;psuedo-ibss&quot; mode.</dd> </dl> <dl> <dt> </dt> <dd> This specifies whic… text/html 2006-02-20T10:41:13-08:00 http://www.read.cs.ucla.edu/click/elements/wififragment?rev=1140460873 This is automatically generated documentation. NAME WifiFragment -- Click element; Reassembles 802.11 fragments. SYNOPSIS WifiFragment Ports: 1 input, 1 output Processing: push Package: wifi (core) DESCRIPTION This element reassembles 802.11 fragments and pushes the reassembled packet out when the last fragment is received. It does not affect packets that are not fragmented, and passes them through its output unmodified. In accordance with the 802.11 spec, it supports a single pa… text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/wifiseq?rev=1236475442 This is automatically generated documentation. NAME WifiSeq -- Click element; Sets the 802.11 sequence number in a packet. SYNOPSIS WifiSeq() Ports: 1 input, any number of outputs Processing: agnostic Package: wifi (core) DESCRIPTION Arguments are: <dl> <dt> </dt> <dd> How many bytes in the packet to put the seuqnce number. Default is 22.</dd> </dl> <dl> <dt> </dt> <dd> How many bytes the sequence number should use. Values can be2 or 4. Default is 2.</dd> </dl> <dl> <dt> </dt> <… text/html 2009-03-07T17:24:01-08:00 http://www.read.cs.ucla.edu/click/elements/wirelessinfo?rev=1236475441 This is automatically generated documentation. NAME WirelessInfo -- Click element; Tracks 802.11 configuration information (ssid, etc). SYNOPSIS WirelessInfo([I<keywords CHANNEL, SSID, BSSID, INTERVAL]) Ports: none Package: wifi (core) DESCRIPTION Tracks 80.211 configuration. Similar to what you can specify with 'iwconfig' in linux. Does not process packets. Keyword arguments are: <dl> <dt> </dt> <dd> Argument is an integer for what channel this configuration is operating on.</dd> <… text/html 2006-02-20T10:41:12-08:00 http://www.read.cs.ucla.edu/click/elements/xokreader?rev=1140460872 This is automatically generated documentation. NAME xokReader -- Click element SYNOPSIS xokReader(pktring_size, off0a/val0a off0b/val0b ..., ..., offNa/valNa) Ports: no inputs, 1 output Processing: push Package: exopc DESCRIPTION Read network packets from xok by inserting DPF filters. Configuration string specifies the size of the packet ring and filter to insert. Configuration strings for filters are similar to the configuration strings in the Classifier element, but the expressi… text/html 2006-02-20T10:41:15-08:00 http://www.read.cs.ucla.edu/click/elements/xokwriter?rev=1140460875 This is automatically generated documentation. NAME xokWriter -- Click element SYNOPSIS xokWriter(devname) Ports: 1 input, no outputs Processing: agnostic Package: exopc DESCRIPTION Write packets to the ethernet via xok ethernet interface. Expects packets that already have an ether header. text/html 2009-03-07T17:24:02-08:00 http://www.read.cs.ucla.edu/click/elements/yarvismetric?rev=1236475442 This is automatically generated documentation. NAME YarvisMetric -- Click element; SYNOPSIS YarvisMetric(LINKSTAT) Ports: None Package: grid (core) DESCRIPTION Child class of GridGenericMetric that implements the end-to-end cumulative link loss ratio metric. The metric is the sum of the quantized logs of link loss ratios, and is described in `Real-World Experiences with an Interactive Ad Hoc Sensor Network', Yarvis et al., in Proceedings of the International Workshup on Ad Hoc Netw…