Inheritance diagram for WSJTXMessageClient:

Collaboration diagram for WSJTXMessageClient:

Classes
class	impl

Public Types
using	Frequency = Radio::Frequency
using	port_type = quint16

Public Member Functions
	WSJTXMessageClient (QString const &id, QString const &version, QString const &revision, QString const &server_name, port_type server_port, QStringList const &network_interface_names, int TTL, QObject *parent=nullptr)
	Construct a WSJT-X message client.
QHostAddress	server_address () const
	Get the server address.
port_type	server_port () const
	Get the server port.
Q_SLOT void	set_server (QString const &server_name, QStringList const &network_interface_names)
	Set the server address and network interfaces.
Q_SLOT void	set_server_port (port_type server_port=0u)
	Set the server port.
Q_SLOT void	set_TTL (int TTL)
	Set the TTL for multicast packets.
Q_SLOT void	enable (bool)
	Enable or disable incoming message processing.
Q_SLOT void	status_update (Frequency, QString const &mode, QString const &dx_call, QString const &report, QString const &tx_mode, bool tx_enabled, bool transmitting, bool decoding, quint32 rx_df, quint32 tx_df, QString const &de_call, QString const &de_grid, QString const &dx_grid, bool watchdog_timeout, QString const &sub_mode, bool fast_mode, quint8 special_op_mode, quint32 frequency_tolerance, quint32 tr_period, QString const &configuration_name, QString const &tx_message)
	Send a Status message.
Q_SLOT void	decode (bool is_new, QTime time, qint32 snr, float delta_time, quint32 delta_frequency, QString const &mode, QString const &message, bool low_confidence, bool off_air)
	Send a Decode message.
Q_SLOT void	decodes_cleared ()
	Send a Clear Decodes message.
Q_SLOT void	qso_logged (QDateTime time_off, QString const &dx_call, QString const &dx_grid, Frequency dial_frequency, QString const &mode, QString const &report_sent, QString const &report_received, QString const &tx_power, QString const &comments, QString const &name, QDateTime time_on, QString const &operator_call, QString const &my_call, QString const &my_grid, QString const &exchange_sent, QString const &exchange_rcvd, QString const &propmode)
	Send a QSO Logged message.
Q_SLOT void	logged_ADIF (QByteArray const &ADIF_record)
	Send a Logged ADIF message.
Signals for incoming messages
Q_SIGNAL void	clear_decodes (quint8 window)
	Emitted when a Clear Decodes message is received.
Q_SIGNAL void	reply (QTime, qint32 snr, float delta_time, quint32 delta_frequency, QString const &mode, QString const &message_text, bool low_confidence, quint8 modifiers)
	Emitted when a Reply message is received.
Q_SIGNAL void	close ()
	Emitted when a Close message is received.
Q_SIGNAL void	replay ()
	Emitted when a Replay message is received.
Q_SIGNAL void	halt_tx (bool auto_only)
	Emitted when a Halt TX message is received.
Q_SIGNAL void	free_text (QString const &, bool send)
	Emitted when a Free Text message is received.
Q_SIGNAL void	location (QString const &)
	Emitted when a Location message is received.
Q_SIGNAL void	error (QString const &) const
	Emitted when an error occurs.

Constructor & Destructor Documentation

◆ WSJTXMessageClient()

WSJTXMessageClient::WSJTXMessageClient	(	QString const &	id,
		QString const &	version,
		QString const &	revision,
		QString const &	server_name,
		port_type	server_port,
		QStringList const &	network_interface_names,
		int	TTL,
		QObject *	parent = nullptr )

Construct a WSJT-X message client.

Instantiates the client and initiates a host lookup on the server.

Parameters

id	Application identifier (e.g., "JS8Call")
version	Application version string
revision	Application revision string
server_name	Server hostname or IP address (supports multicast)
server_port	UDP port number for communication
network_interface_names	List of network interface names for multicast
TTL	Time-to-live for multicast packets
parent	Parent QObject

Here is the call graph for this function:

Member Function Documentation

◆ clear_decodes()

Q_SIGNAL void WSJTXMessageClient::clear_decodes ( quint8 window )

Emitted when a Clear Decodes message is received.

Parameters

window Window number to clear (0 = all windows)

◆ decode()

void WSJTXMessageClient::decode	(	bool	is_new,
		QTime	time,
		qint32	snr,
		float	delta_time,
		quint32	delta_frequency,
		QString const &	mode,
		QString const &	message_text,
		bool	low_confidence,
		bool	off_air )

Send a Decode message.

Sends information about a decoded message.

Parameters

is_new	Whether this is a new decode
time	Decode time
snr	Signal-to-noise ratio (dB)
delta_time	Time offset from expected time (seconds)
delta_frequency	Frequency offset from nominal (Hz)
mode	Operating mode string
message	Decoded message text
low_confidence	Whether decode confidence is low
off_air	Whether this is an off-air decode

Sends information about a decoded message to WSJT-X protocol clients.

Parameters

is_new	Whether this is a new decode
time	Decode time
snr	Signal-to-noise ratio (dB)
delta_time	Time offset from expected time (seconds)
delta_frequency	Frequency offset from nominal (Hz)
mode	Operating mode string
message_text	Decoded message text
low_confidence	Whether decode confidence is low
off_air	Whether this is an off-air decode

◆ decodes_cleared()

void WSJTXMessageClient::decodes_cleared ( )

Send a Clear Decodes message.

Notifies clients to clear the decode window.

Notifies WSJT-X protocol clients to clear the decode window.

◆ enable()

void WSJTXMessageClient::enable ( bool flag )

Enable or disable incoming message processing.

Parameters

flag	true to enable, false to disable

Here is the caller graph for this function:

◆ error()

Q_SIGNAL void WSJTXMessageClient::error ( QString const & ) const

Emitted when an error occurs.

Parameters

message Error message

Here is the caller graph for this function:

◆ free_text()

Q_SIGNAL void WSJTXMessageClient::free_text	(	QString const &	,
		bool	send )

Emitted when a Free Text message is received.

Parameters

text	Free text to send
send	Whether to send immediately

◆ halt_tx()

Q_SIGNAL void WSJTXMessageClient::halt_tx ( bool auto_only )

Emitted when a Halt TX message is received.

Parameters

auto_only If true, only halt auto sequences

◆ location()

Q_SIGNAL void WSJTXMessageClient::location ( QString const & )

Emitted when a Location message is received.

Parameters

location Grid square or location string

◆ logged_ADIF()

void WSJTXMessageClient::logged_ADIF ( QByteArray const & ADIF_record )

Send a Logged ADIF message.

Sends the ADIF record for a logged QSO. This is sent in addition to the QSOLogged message and uses the WSJT-X LoggedADIF message format.

Parameters

ADIF_record ADIF formatted record for the logged QSO

Sends the ADIF record for a logged QSO. This is sent in addition to the QSOLogged message and uses the WSJT-X LoggedADIF message format (type 12). The ADIF record is formatted with a header that includes the ADIF version and program ID for compatibility with WSJT-X clients.

Parameters

ADIF_record ADIF formatted record for the logged QSO (without header)

◆ qso_logged()

void WSJTXMessageClient::qso_logged	(	QDateTime	time_off,
		QString const &	dx_call,
		QString const &	dx_grid,
		Frequency	dial_frequency,
		QString const &	mode,
		QString const &	report_sent,
		QString const &	report_received,
		QString const &	tx_power,
		QString const &	comments,
		QString const &	name,
		QDateTime	time_on,
		QString const &	operator_call,
		QString const &	my_call,
		QString const &	my_grid,
		QString const &	exchange_sent,
		QString const &	exchange_rcvd,
		QString const &	propmode )

Send a QSO Logged message.

Sends information about a logged QSO.

Parameters

time_off	QSO end time
dx_call	DX station callsign
dx_grid	DX station grid square
dial_frequency	Dial frequency (Hz)
mode	Operating mode
report_sent	Report sent to DX station
report_received	Report received from DX station
tx_power	Transmit power
comments	QSO comments
name	DX station name
time_on	QSO start time
operator_call	Operator callsign
my_call	My callsign
my_grid	My grid square
exchange_sent	Exchange sent
exchange_rcvd	Exchange received
propmode	Propagation mode

Sends information about a logged QSO to WSJT-X protocol clients.

Parameters

time_off	QSO end time
dx_call	DX station callsign
dx_grid	DX station grid square
dial_frequency	Dial frequency (Hz)
mode	Operating mode
report_sent	Report sent to DX station
report_received	Report received from DX station
tx_power	Transmit power
comments	QSO comments
name	DX station name
time_on	QSO start time
operator_call	Operator callsign
my_call	My callsign
my_grid	My grid square
exchange_sent	Exchange sent
exchange_rcvd	Exchange received
propmode	Propagation mode

◆ reply()

Q_SIGNAL void WSJTXMessageClient::reply	(	QTime	,
		qint32	snr,
		float	delta_time,
		quint32	delta_frequency,
		QString const &	mode,
		QString const &	message_text,
		bool	low_confidence,
		quint8	modifiers )

Emitted when a Reply message is received.

Parameters

time	Reply time
snr	Signal-to-noise ratio (dB)
delta_time	Time offset (seconds)
delta_frequency	Frequency offset (Hz)
mode	Operating mode
message_text	Reply message text
low_confidence	Whether decode confidence is low
modifiers	Message modifiers

◆ server_address()

QHostAddress WSJTXMessageClient::server_address ( ) const

Get the server address.

Returns: QHostAddress of the server, or null if not resolved

◆ server_port()

auto WSJTXMessageClient::server_port ( ) const

Get the server port.

Returns: UDP port number

Here is the caller graph for this function:

◆ set_server()

void WSJTXMessageClient::set_server	(	QString const &	server_name,
		QStringList const &	network_interface_names )

Set the server address and network interfaces.

Initiates a new server host lookup and updates the network interfaces used for multicast transmission.

Parameters

server_name	Server hostname or IP address
network_interface_names	List of network interface names for multicast

◆ set_server_port()

void WSJTXMessageClient::set_server_port ( port_type server_port = 0u )

Set the server port.

Parameters

server_port UDP port number (0 to disable)

Here is the call graph for this function:

◆ set_TTL()

void WSJTXMessageClient::set_TTL ( int TTL )

Set the TTL for multicast packets.

Parameters

TTL	Time-to-live value

◆ status_update()

void WSJTXMessageClient::status_update	(	Frequency	f,
		QString const &	mode,
		QString const &	dx_call,
		QString const &	report,
		QString const &	tx_mode,
		bool	tx_enabled,
		bool	transmitting,
		bool	decoding,
		quint32	rx_df,
		quint32	tx_df,
		QString const &	de_call,
		QString const &	de_grid,
		QString const &	dx_grid,
		bool	watchdog_timeout,
		QString const &	sub_mode,
		bool	fast_mode,
		quint8	special_op_mode,
		quint32	frequency_tolerance,
		quint32	tr_period,
		QString const &	configuration_name,
		QString const &	tx_message )

Send a Status message.

Sends the current station status including frequency, mode, callsigns, and operational state.

Parameters

f	Operating frequency (Hz)
mode	Operating mode string
dx_call	DX station callsign (selected station)
report	Report string
tx_mode	TX mode string
tx_enabled	Whether TX is enabled
transmitting	Whether currently transmitting
decoding	Whether currently decoding
rx_df	Receive frequency offset (Hz)
tx_df	Transmit frequency offset (Hz)
de_call	My callsign
de_grid	My grid square
dx_grid	DX station grid square
watchdog_timeout	Whether watchdog has timed out
sub_mode	Sub-mode string
fast_mode	Whether fast mode is enabled
special_op_mode	Special operating mode
frequency_tolerance	Frequency tolerance (Hz)
tr_period	Transmit/receive period (seconds)
configuration_name	Configuration name
tx_message	Current TX message text

Sends the current station status including frequency, mode, callsigns, and operational state to WSJT-X protocol clients.

Parameters

f	Operating frequency (Hz)
mode	Operating mode string
dx_call	DX station callsign (selected station)
report	Report string
tx_mode	TX mode string
tx_enabled	Whether TX is enabled
transmitting	Whether currently transmitting
decoding	Whether currently decoding
rx_df	Receive frequency offset (Hz)
tx_df	Transmit frequency offset (Hz)
de_call	My callsign
de_grid	My grid square
dx_grid	DX station grid square
watchdog_timeout	Whether watchdog has timed out
sub_mode	Sub-mode string
fast_mode	Whether fast mode is enabled
special_op_mode	Special operating mode
frequency_tolerance	Frequency tolerance (Hz)
tr_period	Transmit/receive period (seconds)
configuration_name	Configuration name
tx_message	Current TX message text

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

JS8_UDP/WSJTXMessageClient.h
JS8_UDP/WSJTXMessageClient.cpp

Classes

Public Types

Public Member Functions

Constructor & Destructor Documentation

◆ WSJTXMessageClient()

Member Function Documentation

◆ clear_decodes()

◆ decode()

◆ decodes_cleared()

◆ enable()

◆ error()

◆ free_text()

◆ halt_tx()

◆ location()

◆ logged_ADIF()

◆ qso_logged()

◆ reply()

◆ server_address()

◆ server_port()

◆ set_server()

◆ set_server_port()

◆ set_TTL()

◆ status_update()