Dialog for displaying RPC service response time statistics. More...

#include <rpc_service_response_time_dialog.h>

Inheritance diagram for RpcServiceResponseTimeDialog:

Public Types
enum	RpcFamily { DceRpc , OncRpc }
	Defines the supported RPC families. More...

Public Slots
void	dceRpcProgramChanged (const QString &program_name)
	Slot triggered when the DCE-RPC program selection changes.

void	oncRpcProgramChanged (const QString &program_name)
	Slot triggered when the ONC-RPC program selection changes.

Public Slots inherited from ServiceResponseTimeDialog
void	endRetapPackets ()
	Slot called when the retap of packets finishes.

Public Member Functions
	RpcServiceResponseTimeDialog (QWidget &parent, CaptureFile &cf, struct register_srt *srt, RpcFamily dlg_type, const QString filter)
	Constructs an RpcServiceResponseTimeDialog.

void	addDceRpcProgram (_guid_key key, struct _dcerpc_uuid_value value)
	Adds a DCE-RPC program to the dialog.

void	addDceRpcProgramVersion (_guid_key *key)
	Adds a specific version of a DCE-RPC program.

void	addOncRpcProgram (uint32_t program, struct _rpc_prog_info_value *value)
	Adds an ONC-RPC program to the dialog.

void	addOncRpcProgramVersion (uint32_t program, uint32_t version)
	Adds a specific version of an ONC-RPC program.

void	setDceRpcUuidAndVersion (const QUuid &uuid, int version)
	Sets the selected DCE-RPC UUID and version.

void	setOncRpcProgramAndVersion (int program, int version)
	Sets the selected ONC-RPC program and version.

void	setRpcNameAndVersion (const QString &program_name, int version)
	Sets the RPC program by name and selects its version.

Public Member Functions inherited from ServiceResponseTimeDialog
	ServiceResponseTimeDialog (QWidget &parent, CaptureFile &cf, struct register_srt *srt, const QString filter, int help_topic=0)
	Constructs a new ServiceResponseTimeDialog object.

	~ServiceResponseTimeDialog ()
	Destroys the ServiceResponseTimeDialog object.

Public Member Functions inherited from TapParameterDialog
	TapParameterDialog (QWidget &parent, CaptureFile &cf, int help_topic=0)
	Constructs the tap parameter dialog and registers it for retapping.

	~TapParameterDialog ()
	Destroys the dialog, deregisters the tap, and releases UI resources.

QTreeWidget *	statsTreeWidget ()
	Returns the statistics results tree widget for use by subclasses.

QLineEdit *	displayFilterLineEdit ()
	Returns the display filter line edit widget for use by subclasses.

QPushButton *	applyFilterButton ()
	Returns the Apply Filter button for use by subclasses.

QVBoxLayout *	verticalLayout ()
	Returns the main vertical layout for use by subclasses that need to insert additional widgets.

QHBoxLayout *	filterLayout ()
	Returns the filter bar horizontal layout for use by subclasses.

void	drawTreeItems ()
	Triggers a full redraw of all tree items, typically called after the tap has finished accumulating data.

Public Member Functions inherited from WiresharkDialog
	WiresharkDialog (QWidget &parent, CaptureFile &capture_file)
	Constructs a new WiresharkDialog object.

bool	fileClosed () const
	Checks if the capture file has been closed.

Public Member Functions inherited from GeometryStateDialog
	GeometryStateDialog (QWidget *parent, Qt::WindowFlags f=Qt::Window)
	Constructs a new GeometryStateDialog with the specified parent and window flags.

	~GeometryStateDialog ()
	Save the geometry and splitter state and then destroy the GeometryStateDialog.

void	setWindowModality (Qt::WindowModality windowModality)
	Sets the window modality for the dialog. On non-macOS platforms, this also sets the parent to ensure modal dialogs are always on top of their parent.

Static Public Member Functions
static TapParameterDialog *	createDceRpcSrtDialog (QWidget &parent, const QString, const QString opt_arg, CaptureFile &cf)
	Factory method to create a DCE-RPC SRT dialog.

static TapParameterDialog *	createOncRpcSrtDialog (QWidget &parent, const QString, const QString opt_arg, CaptureFile &cf)
	Factory method to create an ONC-RPC SRT dialog.

Static Public Member Functions inherited from ServiceResponseTimeDialog
static TapParameterDialog *	createSrtDialog (QWidget &parent, const QString cfg_str, const QString filter, CaptureFile &cf)
	Factory method to create an SRT dialog.

Static Public Member Functions inherited from TapParameterDialog
static const QString &	actionName ()
	Returns the action name string used to identify this dialog type in menus.

static void	registerDialog (const QString title, const char *cfg_abbr, register_stat_group_t group, stat_tap_init_cb tap_init_cb, tpdCreator creator)
	Registers a TapParameterDialog subclass so it can be opened via the statistics menu or the "-z" command-line option.

static TapParameterDialog *	showTapParameterStatistics (QWidget &parent, CaptureFile &cf, const QString cfg_str, const QString arg, void *)
	Finds or creates and shows the tap statistics dialog matching `cfg_str`.

Protected Member Functions
virtual void	provideParameterData ()
	Provides parameter data required for the underlying SRT dialog.

Protected Member Functions inherited from ServiceResponseTimeDialog
void	addSrtTable (const struct _srt_stat_table *srt_table)

Protected Member Functions inherited from TapParameterDialog
void	contextMenuEvent (QContextMenuEvent *event)
	Shows the context menu with filter and tree collapse/expand actions.

void	addFilterActions ()
	Populates the context menu with filter actions for the selected tree item.

void	addTreeCollapseAllActions ()
	Adds "Collapse All" and "Expand All" actions to the context menu.

QString	displayFilter ()
	Returns the current display filter string from the filter line edit.

void	setDisplayFilter (const QString &filter)
	Sets the display filter line edit to the given expression.

void	setHint (const QString &hint)
	Sets the hint text shown below the tree widget.

void	setRetapOnShow (bool retap)
	Controls whether packets are retapped when the dialog is first shown. RPC statistics dialogs should disable this to manage their own retap timing.

Protected Member Functions inherited from WiresharkDialog
virtual void	keyPressEvent (QKeyEvent *event)
	Handles key press events.

virtual void	accept ()
	Accepts the dialog.

virtual void	reject ()
	Rejects the dialog.

virtual void	beginRetapPackets ()
	Mark the start of a code block that retaps packets. If the user closes the dialog while tapping, the dialog will not be destroyed until endRetapPackets is called.

virtual void	endRetapPackets ()
	Mark the end of a code block that retaps packets. If the user has closed the dialog it will be destroyed at this point.

void	setWindowSubtitle (const QString &subtitle)
	Set the window subtitle, e.g. "Foo Timeouts". The subtitle and file name will be added to the dialog window title.

const QString &	windowSubtitle ()
	Retrieves the current window subtitle.

virtual void	updateWidgets ()
	Updates the state and contents of the dialog's widgets.

bool	registerTapListener (const char tap_name, void tap_data, const char *filter, unsigned flags, tap_reset_cb tap_reset, tap_packet_cb tap_packet, tap_draw_cb tap_draw)
	Convenience wrapper for register_tap_listener. Tap listeners registered via this function are automatically removed during destruction. They can also be explicitly removed using remove_tap_listener or removeTapListeners.

virtual void	removeTapListeners ()
	Remove all tap listeners registered via registerTapListener.

bool	dialogClosed () const
	Check to see if the user has closed (and not minimized) the dialog.

int	retapDepth () const
	Check to see if we're currently retapping. If this is positive, tapping will fail in process_specified_records.

virtual void	captureFileClosing ()
	Called when the capture file is about to close. This can be used to disconnect taps and similar actions. updateWidgets() is called at the end. To enable/disable widgets captureFileClosed() is more suitable.

virtual void	captureFileClosed ()
	Called when the capture file was closed. This can be used to enable or disable widgets according to the state of file_closed_. updateWidgets() is called at the end.

Protected Member Functions inherited from GeometryStateDialog
void	loadGeometry (int width=0, int height=0, const QString &dialog_name=QString())
	Loads the geometry and splitter state for the dialog.

void	loadSplitterState (QSplitter *splitter=nullptr)
	Loads the state of a splitter for the dialog.

Additional Inherited Members
Signals inherited from TapParameterDialog
void	filterAction (QString filter, FilterAction::Action action, FilterAction::ActionType type)
	Emitted when the user triggers a filter action from the context menu.

void	updateFilter (QString filter)
	Emitted to push a new display filter to the main window filter bar.

Protected Slots inherited from ServiceResponseTimeDialog
void	fillTree ()
	Fills the tree widget with the collected SRT statistics.

Protected Slots inherited from TapParameterDialog
void	filterActionTriggered ()
	Applies the filter action associated with the triggered context menu action.

void	collapseAllActionTriggered ()
	Collapses all items in the statistics tree.

void	expandAllActionTriggered ()
	Expands all items in the statistics tree.

void	updateWidgets ()
	Refreshes the enabled/disabled state of UI widgets based on current capture and filter state.

Protected Slots inherited from WiresharkDialog
void	captureEvent (CaptureEvent e)
	Handles capture events.

Protected Attributes inherited from ServiceResponseTimeDialog
struct register_srt *	srt_
	Pointer to the registered SRT data structure.

Protected Attributes inherited from WiresharkDialog
CaptureFile &	cap_file_
	Reference to the underlying capture file.

bool	file_closed_
	Flag indicating if the capture file has been closed.

Detailed Description

Dialog for displaying RPC service response time statistics.

Member Enumeration Documentation

◆ RpcFamily

enum RpcServiceResponseTimeDialog::RpcFamily

Defines the supported RPC families.

Enumerator
DceRpc	DCE-RPC protocol family.
OncRpc	ONC-RPC protocol family.

Constructor & Destructor Documentation

◆ RpcServiceResponseTimeDialog()

RpcServiceResponseTimeDialog::RpcServiceResponseTimeDialog	(	QWidget &	parent,
		CaptureFile &	cf,
		struct register_srt *	srt,
		RpcFamily	dlg_type,
		const QString	filter
	)

Constructs an RpcServiceResponseTimeDialog.

Parameters

parent	The parent widget.
cf	The capture file context.
srt	Pointer to the registered SRT tap structure.
dlg_type	The specific RPC family type.
filter	The display filter string to apply.

Member Function Documentation

◆ addDceRpcProgram()

void RpcServiceResponseTimeDialog::addDceRpcProgram	(	_guid_key *	key,
		struct _dcerpc_uuid_value *	value
	)

Adds a DCE-RPC program to the dialog.

Parameters

key	Pointer to the GUID key.
value	Pointer to the DCE-RPC UUID value structure.

◆ addDceRpcProgramVersion()

void RpcServiceResponseTimeDialog::addDceRpcProgramVersion ( _guid_key * key )

Adds a specific version of a DCE-RPC program.

Parameters

key	Pointer to the GUID key specifying the program version.

◆ addOncRpcProgram()

void RpcServiceResponseTimeDialog::addOncRpcProgram	(	uint32_t	program,
		struct _rpc_prog_info_value *	value
	)

Adds an ONC-RPC program to the dialog.

Parameters

program	The ONC-RPC program number.
value	Pointer to the RPC program info value structure.

◆ addOncRpcProgramVersion()

void RpcServiceResponseTimeDialog::addOncRpcProgramVersion	(	uint32_t	program,
		uint32_t	version
	)

Adds a specific version of an ONC-RPC program.

Parameters

program	The ONC-RPC program number.
version	The program version number.

◆ createDceRpcSrtDialog()

TapParameterDialog * RpcServiceResponseTimeDialog::createDceRpcSrtDialog	(	QWidget &	parent,
		const QString	,
		const QString	opt_arg,
		CaptureFile &	cf
	)

static

Factory method to create a DCE-RPC SRT dialog.

Parameters

parent	The parent widget.
opt_arg	Optional argument string.
cf	The capture file context.

Returns: Pointer to the created TapParameterDialog.

◆ createOncRpcSrtDialog()

TapParameterDialog * RpcServiceResponseTimeDialog::createOncRpcSrtDialog	(	QWidget &	parent,
		const QString	,
		const QString	opt_arg,
		CaptureFile &	cf
	)

static

Factory method to create an ONC-RPC SRT dialog.

Parameters

parent	The parent widget.
opt_arg	Optional argument string.
cf	The capture file context.

Returns: Pointer to the created TapParameterDialog.

◆ dceRpcProgramChanged

void RpcServiceResponseTimeDialog::dceRpcProgramChanged ( const QString & program_name )

slot

Slot triggered when the DCE-RPC program selection changes.

Parameters

program_name The new DCE-RPC program name.

◆ oncRpcProgramChanged

void RpcServiceResponseTimeDialog::oncRpcProgramChanged ( const QString & program_name )

slot

Slot triggered when the ONC-RPC program selection changes.

Parameters

program_name The new ONC-RPC program name.

◆ provideParameterData()

void RpcServiceResponseTimeDialog::provideParameterData ( )

protectedvirtual

Provides parameter data required for the underlying SRT dialog.

Reimplemented from ServiceResponseTimeDialog.

◆ setDceRpcUuidAndVersion()

void RpcServiceResponseTimeDialog::setDceRpcUuidAndVersion	(	const QUuid &	uuid,
		int	version
	)

Sets the selected DCE-RPC UUID and version.

Parameters

uuid	The UUID of the DCE-RPC program.
version	The version number.

◆ setOncRpcProgramAndVersion()

void RpcServiceResponseTimeDialog::setOncRpcProgramAndVersion	(	int	program,
		int	version
	)

Sets the selected ONC-RPC program and version.

Parameters

program	The ONC-RPC program number.
version	The version number.

◆ setRpcNameAndVersion()

void RpcServiceResponseTimeDialog::setRpcNameAndVersion	(	const QString &	program_name,
		int	version
	)

Sets the RPC program by name and selects its version.

Parameters

program_name	The string name of the RPC program.
version	The version number.

The documentation for this class was generated from the following files:

/builds/wireshark/wireshark/ui/qt/rpc_service_response_time_dialog.h
/builds/wireshark/wireshark/ui/qt/rpc_service_response_time_dialog.cpp

Public Types

Public Slots

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ RpcFamily

Constructor & Destructor Documentation

◆ RpcServiceResponseTimeDialog()

Member Function Documentation

◆ addDceRpcProgram()

◆ addDceRpcProgramVersion()

◆ addOncRpcProgram()

◆ addOncRpcProgramVersion()

◆ createDceRpcSrtDialog()

◆ createOncRpcSrtDialog()

◆ dceRpcProgramChanged

◆ oncRpcProgramChanged

◆ provideParameterData()

◆ setDceRpcUuidAndVersion()

◆ setOncRpcProgramAndVersion()

◆ setRpcNameAndVersion()