RtpPlayerDialog Class Reference

Singleton dialog for playing and analyzing RTP audio streams. Singleton pattern based on https://refactoring.guru/design-patterns/singleton/cpp/example#example-1. More...

#include <rtp_player_dialog.h>

Inheritance diagram for RtpPlayerDialog:

Public Member Functions
	RtpPlayerDialog (RtpPlayerDialog &other)=delete
	Should not be cloneable.
void	operator= (const RtpPlayerDialog &)=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 RtpPlayerDialog *	openRtpPlayerDialog (QWidget &parent, CaptureFile &cf, QObject *packet_list, bool capture_running)
	Opens or retrieves the singleton instance of the RTP Player Dialog.
static QToolButton *	addPlayerButton (QDialogButtonBox *button_box, QDialog *dialog)
	Common routine to add a "Play call" button to a QDialogButtonBox.

Protected Member Functions
	RtpPlayerDialog (QWidget &parent, CaptureFile &cf, bool capture_running)
	Constructs an RtpPlayerDialog. Protected to enforce singleton pattern.
Protected Member Functions inherited from RtpBaseDialog
	RtpBaseDialog (QWidget &parent, CaptureFile &cf)
	Constructs an RtpBaseDialog.
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
Protected Slots inherited from WiresharkDialog
void	captureEvent (CaptureEvent e)
	Handles capture events.
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

Singleton dialog for playing and analyzing RTP audio streams. Singleton pattern based on https://refactoring.guru/design-patterns/singleton/cpp/example#example-1.

Constructor & Destructor Documentation

RtpPlayerDialog()

RtpPlayerDialog::RtpPlayerDialog ( QWidget &  parent, CaptureFile &  cf, bool capture_running  _U_  )

explicitprotected

Constructs an RtpPlayerDialog. Protected to enforce singleton pattern.

Parameters

parent	The parent widget.
cf	The associated capture file.
capture_running	True if a capture is currently running.

Member Function Documentation

addPlayerButton()

QToolButton * RtpPlayerDialog::addPlayerButton ( QDialogButtonBox *  button_box, QDialog *  dialog  )

static

Common routine to add a "Play call" button to a QDialogButtonBox.

Parameters

button_box	Caller's QDialogButtonBox.
dialog	The dialog the button belongs to.

Returns

Pointer to the new "Play call" QToolButton.

openRtpPlayerDialog()

RtpPlayerDialog * RtpPlayerDialog::openRtpPlayerDialog ( QWidget &  parent, CaptureFile &  cf, QObject *  packet_list, bool  capture_running  )

static

Opens or retrieves the singleton instance of the RTP Player Dialog.

Parameters

parent	The parent widget.
cf	The capture file containing the streams.
packet_list	Pointer to the packet list object.
capture_running	True if a capture is currently running.

Returns

Pointer to the singleton RtpPlayerDialog instance.

---

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

• /builds/wireshark/wireshark/ui/qt/rtp_player_dialog.h
• /builds/wireshark/wireshark/ui/qt/rtp_player_dialog.cpp