Module controls

Module controls 

Source
Expand description

Module to interact with the controls for the extcap program. There are two aspects of “controls” handled in this module:

  1. The toolbar controls in the Wireshark interface, when the user selects View > Interface Toolbars. This module helps define UI elements on that toolbar and react to user interactions performed on them.
  2. The control packets exchanged between this extcap program and Wireshark. Besides the UI toolbar elements above, control packets are also used for things like displaying status bar and dialog messages, as well as for Wireshark to send events like Initialized.

Modules§

asynchronous
Tools for handling the Control Pipe with async (tokio).
synchronous
Tools for handling the Control Pipe synchrnously.

Structs§

BooleanControl
A checkbox which lets the user set a true / false value.
ButtonControl
Button that sends a signal when pressed. The button is only enabled when capturing.
ControlPacket
Control packets for the extcap interface. This is used for communication of control data between Wireshark and this extcap program.
HelpButtonControl
A button in the toolbar that opens the help URL when clicked. The URL it opens is defined in Metadata::help_url.
LoggerControl
A logger mechanism where the extcap utility can send log entries to be presented in a log window. This communication is unidirectional from this extcap program to Wireshark.
RestoreButtonControl
This button will restore all control values to default. The button is only enabled when not capturing.
SelectorControl
A dropdown selector with fixed values which can be selected.
SelectorControlOption
An option in a SelectorControl.
StringControl
A text field toolbar control element.

Enums§

ControlCommand
The control command for the control packet. Note that a ControlCommand is not valid for all control types, for example, the Remove command is applicable only to SelectorControls, and Initialized is only sent by Wireshark to this extcap program.

Traits§

ControlWithLabel
A ToolbarControl that has a customizable label.
EnableableControl
A ToolbarControl that can be enabled or disabled.
ToolbarControl
Controls provided by this extcap utility to use in a toolbar in the UI. These controls are bidirectional and can be used to control the extcap utility while capturing.