Dialog for displaying and managing VoIP and SIP calls. More...

#include <voip_calls_dialog.h>

Inheritance diagram for VoipCallsDialog:

Public Slots
void	rtpPlayerReplace ()
	Slot to trigger replacing streams in the RTP player.

void	rtpPlayerAdd ()
	Slot to trigger adding streams to the RTP player.

void	rtpPlayerRemove ()
	Slot to trigger removing streams from the RTP player.

Signals
void	updateFilter (QString filter, bool force=false)
	Signal emitted to update the display filter.

void	captureFileChanged (capture_file *cf)
	Signal emitted when the capture file changes.

void	goToPacket (int packet_num)
	Signal emitted to navigate to a specific packet.

void	rtpPlayerDialogReplaceRtpStreams (QVector< rtpstream_id_t * > stream_ids)
	Signal emitted to request replacing RTP streams in the player dialog.

void	rtpPlayerDialogAddRtpStreams (QVector< rtpstream_id_t * > stream_ids)
	Signal emitted to request adding RTP streams to the player dialog.

void	rtpPlayerDialogRemoveRtpStreams (QVector< rtpstream_id_t * > stream_ids)
	Signal emitted to request removing RTP streams from the player dialog.

void	rtpStreamsDialogSelectRtpStreams (QVector< rtpstream_id_t * > stream_ids)
	Signal emitted to request selecting specific RTP streams in the streams dialog.

void	rtpStreamsDialogDeselectRtpStreams (QVector< rtpstream_id_t * > stream_ids)
	Signal emitted to request deselecting specific RTP streams in the streams dialog.

Public Member Functions
	VoipCallsDialog (VoipCallsDialog &other)=delete
	Should not be cloneable.

void	operator= (const VoipCallsDialog &)=delete
	Should not be assignable.

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 VoipCallsDialog *	openVoipCallsDialogVoip (QWidget &parent, CaptureFile &cf, QObject *packet_list)
	Returns singleton instance for VoIP calls.

static VoipCallsDialog *	openVoipCallsDialogSip (QWidget &parent, CaptureFile &cf, QObject *packet_list)
	Returns singleton instance for SIP calls.

Protected Slots
void	changeEvent (QEvent *event)
	Handles generic state change events.

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

Protected Member Functions
	VoipCallsDialog (QWidget &parent, CaptureFile &cf, bool all_flows=false)
	Constructs a new VoipCallsDialog object. Protected to enforce singleton pattern.

	~VoipCallsDialog ()
	Destroys the VoipCallsDialog object.

void	contextMenuEvent (QContextMenuEvent *event)
	Handles context menu events.

virtual void	removeTapListeners ()
	Safely removes all tap listeners used by the dialog.

void	captureFileClosing ()
	Handles operations required just before the capture file closes.

void	captureFileClosed ()
	Handles cleanup after the capture file is fully closed.

bool	eventFilter (QObject obj, QEvent event)
	Event filter for capturing specific events.

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.

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.

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
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 and managing VoIP and SIP calls.

Constructor & Destructor Documentation

◆ VoipCallsDialog()

VoipCallsDialog::VoipCallsDialog	(	QWidget &	parent,
		CaptureFile &	cf,
		bool	all_flows = `false`
	)

explicitprotected

Constructs a new VoipCallsDialog object. Protected to enforce singleton pattern.

Parameters

parent	The parent widget.
cf	The capture file context.
all_flows	True if tracking all flows, false for specific SIP flows.

Member Function Documentation

◆ captureFileChanged

void VoipCallsDialog::captureFileChanged ( capture_file * cf )

signal

Signal emitted when the capture file changes.

Parameters

cf	Pointer to the new capture file.

◆ captureFileClosed()

void VoipCallsDialog::captureFileClosed ( )

protectedvirtual

Handles cleanup after the capture file is fully closed.

Reimplemented from WiresharkDialog.

◆ captureFileClosing()

void VoipCallsDialog::captureFileClosing ( )

protectedvirtual

Handles operations required just before the capture file closes.

Reimplemented from WiresharkDialog.

◆ changeEvent

void VoipCallsDialog::changeEvent ( QEvent * event )

protectedslot

Handles generic state change events.

Parameters

event The change event.

◆ contextMenuEvent()

void VoipCallsDialog::contextMenuEvent ( QContextMenuEvent * event )

protected

Handles context menu events.

Parameters

event The context menu event.

◆ eventFilter()

bool VoipCallsDialog::eventFilter	(	QObject *	obj,
		QEvent *	event
	)

protected

Event filter for capturing specific events.

Parameters

obj	The watched object.
event	The intercepted event.

Returns: True if the event was filtered, false otherwise.

◆ goToPacket

void VoipCallsDialog::goToPacket ( int packet_num )

signal

Signal emitted to navigate to a specific packet.

Parameters

packet_num The packet number to jump to.

◆ openVoipCallsDialogSip()

VoipCallsDialog * VoipCallsDialog::openVoipCallsDialogSip	(	QWidget &	parent,
		CaptureFile &	cf,
		QObject *	packet_list
	)

static

Returns singleton instance for SIP calls.

Parameters

parent	The parent widget.
cf	The capture file.
packet_list	Pointer to the packet list object.

Returns: Pointer to the singleton VoipCallsDialog instance.

◆ openVoipCallsDialogVoip()

VoipCallsDialog * VoipCallsDialog::openVoipCallsDialogVoip	(	QWidget &	parent,
		CaptureFile &	cf,
		QObject *	packet_list
	)

static

Returns singleton instance for VoIP calls.

Parameters

parent	The parent widget.
cf	The capture file.
packet_list	Pointer to the packet list object.

Returns: Pointer to the singleton VoipCallsDialog instance.

◆ removeTapListeners()

void VoipCallsDialog::removeTapListeners ( )

protectedvirtual

Safely removes all tap listeners used by the dialog.

Reimplemented from WiresharkDialog.

◆ rtpPlayerDialogAddRtpStreams

void VoipCallsDialog::rtpPlayerDialogAddRtpStreams ( QVector< rtpstream_id_t * > stream_ids )

signal

Signal emitted to request adding RTP streams to the player dialog.

Parameters

stream_ids The RTP streams to add.

◆ rtpPlayerDialogRemoveRtpStreams

void VoipCallsDialog::rtpPlayerDialogRemoveRtpStreams ( QVector< rtpstream_id_t * > stream_ids )

signal

Signal emitted to request removing RTP streams from the player dialog.

Parameters

stream_ids The RTP streams to remove.

◆ rtpPlayerDialogReplaceRtpStreams

void VoipCallsDialog::rtpPlayerDialogReplaceRtpStreams ( QVector< rtpstream_id_t * > stream_ids )

signal

Signal emitted to request replacing RTP streams in the player dialog.

Parameters

stream_ids The RTP streams to replace.

◆ rtpStreamsDialogDeselectRtpStreams

void VoipCallsDialog::rtpStreamsDialogDeselectRtpStreams ( QVector< rtpstream_id_t * > stream_ids )

signal

Signal emitted to request deselecting specific RTP streams in the streams dialog.

Parameters

stream_ids The RTP streams to deselect.

◆ rtpStreamsDialogSelectRtpStreams

void VoipCallsDialog::rtpStreamsDialogSelectRtpStreams ( QVector< rtpstream_id_t * > stream_ids )

signal

Signal emitted to request selecting specific RTP streams in the streams dialog.

Parameters

stream_ids The RTP streams to select.

◆ updateFilter

void VoipCallsDialog::updateFilter	(	QString	filter,
		bool	force = `false`
	)

signal

Signal emitted to update the display filter.

Parameters

filter	The display filter string to apply.
force	True to force the filter application.

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

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

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VoipCallsDialog()

Member Function Documentation

◆ captureFileChanged

◆ captureFileClosed()

◆ captureFileClosing()

◆ changeEvent

◆ contextMenuEvent()

◆ eventFilter()

◆ goToPacket

◆ openVoipCallsDialogSip()

◆ openVoipCallsDialogVoip()

◆ removeTapListeners()

◆ rtpPlayerDialogAddRtpStreams

◆ rtpPlayerDialogRemoveRtpStreams

◆ rtpPlayerDialogReplaceRtpStreams

◆ rtpStreamsDialogDeselectRtpStreams

◆ rtpStreamsDialogSelectRtpStreams

◆ updateFilter