Expand description
Module to interact with the controls for the extcap program. There are two aspects of “controls” handled in this module:
- 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. - 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§
- Boolean
Control - A checkbox which lets the user set a true / false value.
- Button
Control - Button that sends a signal when pressed. The button is only enabled when capturing.
- Control
Packet - Control packets for the extcap interface. This is used for communication of control data between Wireshark and this extcap program.
- Help
Button Control - A button in the toolbar that opens the help URL when clicked. The URL it
opens is defined in
Metadata::help_url
. - Logger
Control - 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.
- Restore
Button Control - This button will restore all control values to default. The button is only enabled when not capturing.
- Selector
Control - A dropdown selector with fixed values which can be selected.
- Selector
Control Option - An option in a
SelectorControl
. - String
Control - A text field toolbar control element.
Enums§
- Control
Command - The control command for the control packet. Note that a
ControlCommand
is not valid for all control types, for example, theRemove
command is applicable only toSelectorControls
, andInitialized
is only sent by Wireshark to this extcap program.
Traits§
- Control
With Label - A
ToolbarControl
that has a customizable label. - Enableable
Control - A
ToolbarControl
that can be enabled or disabled. - Toolbar
Control - 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.