Skip to content
Eddie Kohler edited this page Oct 18, 2017 · 5 revisions

Elements

This page lists Click element classes that have manual page documentation.

By function: Basic Sources and Sinks - Basic Classification and Selection - Basic Packet Transfer - Counters - Timestamps - Basic Packet Modification - Packet Storage - Active Queue Management - Packet Scheduling - Traffic Shaping - Information Elements - Network Devices - Host and Socket Communication - Ethernet - ARP - IPv4 - IPv4 Routing - ICMP - Network Address Translation - TCP - UDP - Applications - Trace Manipulation - TCP/IP Measurement - Aggregates - IPv6 - IPsec - CRCs - Paint Annotations - Annotations - Debugging - Control - Thread Management - Regression Tests - devices - Grid - packet framing - Wifi - Wireless AccessPoint - Wireless Station - Miscellaneous

Alphabetical list

Basic Sources and Sinks

Basic Classification and Selection

  • Bypass — sends packet stream through optional bypass with zero overhead
  • CheckLength — drops large packets
  • Classifier — classifies packets by contents
  • HashSwitch — classifies packets by hash of contents
  • InputSwitch — accepts packet stream from settable input
  • RandomSample — samples packets with some probability
  • RandomSwitch — sends packets to random outputs
  • RoundRobinSwitch — sends packets to round-robin outputs
  • StaticSwitch — sends packet stream to fixed output
  • StrideSwitch — sends packets to stride-scheduled outputs
  • Suppressor — passes packets unchanged, optionally dropping some input ports
  • Switch — sends packet stream to settable output

Basic Packet Transfer

  • Hub — duplicates packets like a hub
  • Null — null element: passes packets unchanged
  • Null1 — copy of Null
  • PullNull — pull-only null element
  • PushNull — push-only null element
  • Tee — duplicates packets

Counters

Timestamps

Basic Packet Modification

Packet Storage

Active Queue Management

  • AdaptiveRED — drops packets according to Adaptive RED
  • CoDel — drops packets according to CoDel
  • RED — drops packets according to RED

Packet Scheduling

Traffic Shaping

Information Elements

Network Devices

  • DPDKInfo — Set DPDK global parameters.
  • FromDevice — reads packets from network device (Linux kernel)
  • FromDevice.u — reads packets from network device (user-level)
  • FromDPDKDevice — reads packets from network device using Intel's DPDK (user-level)
  • FromSimDevice.u — reads packets from a simulator device
  • FromUserDevice — Emit packets written to a character device.
  • PollDevice — polls packets from network device (kernel)
  • ToDevice — sends packets to network device (Linux kernel)
  • ToDevice.u — sends packets to network device (user-level)
  • ToDPDKDevice — sends packets to network device using Intel's DPDK (user-level)
  • ToSimDevice.u — sends packets to simulated network device
  • ToUserDevice — Pass packets to user-level programs via a character device.

Host and Socket Communication

  • FromHost — reads packets from Linux
  • FromHost.u — interface to /dev/net/tun or ethertap (user-level)
  • FromRawSocket — reads raw IP packets from safe raw socket (user-level)
  • FromSocket — reads data from socket (user-level)
  • IPFlowRawSockets — creates separate sockets for each TCP/UDP flow
  • KernelFilter — block kernel from handling packets
  • KernelTap — interface to /dev/tap or ethertap (user-level)
  • KernelTun — interface to /dev/tun or ethertap (user-level)
  • McastSocket — a multicast UDP socket transport (user-level)
  • RawSocket — transports raw IP packets via safe raw sockets (user-level)
  • Socket — a socket transport (user-level)
  • ToHost — sends packets to Linux
  • ToHost.u — sends packets to Linux via Universal TUN/TAP device.
  • ToHostSniffers — sends packets to Linux packet sniffers
  • ToRawSocket — sends IP packets through a safe raw socket (user-level)
  • ToSocket — sends data to socket (user-level)

Ethernet

ARP

  • ARPFaker — periodically generates an ARP reply
  • ARPPrint — pretty-prints ARP packets a la tcpdump
  • ARPQuerier — encapsulates IP packets in Ethernet headers found via ARP
  • ARPResponder — generates responses to ARP queries
  • ARPTable — stores IP-to-Ethernet mappings
  • CheckARPHeader — checks ARP header

IPv4

IPv4 Routing

ICMP

Network Address Translation

TCP

UDP

Applications

Trace Manipulation

TCP/IP Measurement

Aggregates

IPv6

IPsec

CRCs

  • CheckCRC32 — checks packet CRC32s
  • SetCRC32 — calculates CRC32 and prepends to packet

Paint Annotations

  • CheckPaint — checks packets' paint annotation
  • Paint — sets packet paint annotations
  • PaintSwitch — sends packet stream to output chosen per-packet
  • PaintTee — duplicates packets with given paint annotation

Annotations

Debugging

Control

Thread Management

Regression Tests

devices

  • UMLSwitch — Connects to a UML switch daemon

Grid

packet framing

  • Reframe — reframes a fragmented stream of packets

Wifi

  • AssociationRequester — Sends 802.11 association requests when poked.
  • AssociationResponder — Respond to 802.11 association requests.
  • AthdescDecap — Pulls the click_wifi_athdesc header from a packet and stores it in Packet::anno()
  • AthdescEncap — Pushes the click_wifi_radiotap header on a packet based on information in Packet::anno()
  • AutoRateFallback — ARF wireless bit-rate selection algorithm
  • AvailableRates — Tracks bit-rate capabilities of other stations.
  • BeaconScanner — Listens for 802.11 beacons and sends probe requests.
  • BeaconSource — Send 802.11 beacons.
  • BeaconTracker — Tracks beacon from an Access Point
  • EtherCount — Track each ethernet source.
  • ExtraDecap — Pulls the click_wifi_extra header from a packet and stores it in Packet::anno()
  • ExtraEncap — Pushes the click_wifi_extra header on a packet based on information in Packet::anno()
  • FilterFailures — Filters unicast packets that failed to be acknowledged
  • FilterPhyErr — Filters packets that failed the 802.11 CRC check.
  • FilterTX — Filter out wireless transmission feedback packets
  • LinkTable — Keeps a Link state database and calculates Weighted Shortest Path for other elements
  • MadwifiRate — Madwifi wireless bit-rate selection algorithm
  • OpenAuthRequeser — Sends 802.11 open authentication requests when poked.
  • OpenAuthResponder — Respond to 802.11 open authentication requests.
  • PacketStore — Log transmit feedback stats for later analysis.
  • Prism2Decap — Pulls the prism2 header from a packet and store information in Packet::anno()
  • Prism2Encap — Pushes a Prism2 header onto a packet based on information stored in Packet::anno()
  • ProbeRequester — Sends 802.11 probe requests
  • ProbeResponder — Respond to 802.11 probe packets.
  • ProbeTXRate — Madwifi wireless bit-rate selection algorithm
  • PushAnno — Pushes Packet::anno() onto front of packet.
  • RadiotapDecap — Pulls the click_wifi_radiotap header from a packet and stores it in Packet::anno()
  • RadiotapEncap — Pushes the click_wifi_radiotap header on a packet based on information in Packet::anno()
  • ReadAnno — Pulls annotation from packet and stores it in Packet::anno()
  • RXStats — Track RSSI for each ethernet source.
  • SetNoAck — Sets the No-Ack bit in tx-flags
  • SetRTS — Enable/disable RTS/CTS for a packet
  • SetTXPower — Sets the transmit power for a packet.
  • SetTXRate — Sets the bit-rate for a packet.
  • WepDecap — Turns 802.11 packets into ethernet packets
  • WepEncap — Turns 802.11 packets into ethernet packets
  • WifiDecap — Turns 802.11 packets into ethernet packets.
  • WifiDefrag — Reassembles 802.11 fragments.
  • WifiDupeFilter — Filters out duplicate 802.11 packets based on their sequence number.
  • WifiEncap — Converts ethernet packets to 802.11 packets with a LLC header.
  • WifiFragment — Reassembles 802.11 fragments.
  • WifiSeq — Sets the 802.11 sequence number in a packet.
  • WirelessInfo — Tracks 802.11 configuration information (ssid, etc).

Wireless AccessPoint

Wireless Station

Miscellaneous

Alphabetical list

Clone this wiki locally