mirror of
https://github.com/saitohirga/WSJT-X.git
synced 2024-10-31 23:57:10 -04:00
c5c6feb41c
To facilitate interaction with other applications WSJT-X now sends status updates to a predefined UDP server or multicast group address. The status updates include the information currently posted to the decodes.txt and wsjtx_status.txt files. An optional back communications channel is also implemented allowing the UDP server application to control some basic actions in WSJT-X. A reference implementaion of a typical UDP server written in C++ using Qt is provided to demonstrate these facilities. This application is not intended as a user tool but only as an example of how a third party application may interact with WSJT-X. The UDP messages Use QDataStream based serialization. Messages are documented in NetworkMessage.hpp along with some helper classes that simplify the building and decoding of messages. Two message handling classes are introduced, MessageClient and MessageServer. WSJT-X uses the MessageClient class to manage outgoing and incoming UDP messages that allow communication with other applications. The MessageServer class implements the kind of code that a potential cooperating application might use. Although these classes use Qt serialization facilities, the message formats are easily read and written by applications that do not use the Qt framework. MessageAggregator is a demonstration application that uses MessageServer and presents a GUI that displays messages from one or more WSJT-X instances and allows sending back a CQ or QRZ reply invocation by double clicking a decode. This application is not intended as a user facing tool but rather as a demonstration of the WSJT-X UDP messaging facility. It also demonstrates being a multicast UDP server by allowing multiple instances to run concurrently. This is enabled by using an appropriate multicast group address as the server address. Cooperating applications need not implement multicast techniques but it is recomended otherwise only a single appliaction can act as a broadcast message (from WSJT-X) recipient. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5225 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
74 lines
2.7 KiB
C++
74 lines
2.7 KiB
C++
#ifndef MESSAGE_SERVER_HPP__
|
|
#define MESSAGE_SERVER_HPP__
|
|
|
|
#include <QObject>
|
|
#include <QTime>
|
|
#include <QDateTime>
|
|
#include <QString>
|
|
#include <QByteArray>
|
|
#include <QHostAddress>
|
|
|
|
#include "Radio.hpp"
|
|
|
|
#include "pimpl_h.hpp"
|
|
|
|
//
|
|
// MessageServer - a reference implementation of a message server
|
|
// matching the MessageClient class at the other end
|
|
// of the wire
|
|
//
|
|
// This class is fully functioning and suitable for use in C++
|
|
// applications that use the Qt framework. Other applications should
|
|
// use this classes' implementation as a reference implementation.
|
|
//
|
|
class MessageServer
|
|
: public QObject
|
|
{
|
|
Q_OBJECT;
|
|
|
|
public:
|
|
using port_type = quint16;
|
|
using Frequency = Radio::Frequency;
|
|
|
|
MessageServer (QObject * parent = nullptr);
|
|
|
|
// start or restart the server, if the multicast_group_address
|
|
// argument is given it is assumed to be a multicast group address
|
|
// which the server will join
|
|
Q_SLOT void start (port_type port, QHostAddress const& multicast_group_address = QHostAddress {});
|
|
|
|
// ask the client with identification 'id' to make the same action
|
|
// as a double click on the decode would
|
|
//
|
|
// note that the client is not obliged to take any action and only
|
|
// takes any action if the decode is present and is a CQ or QRZ message
|
|
Q_SLOT void reply (QString const& id, QTime time, qint32 snr, float delta_time, quint32 delta_frequency
|
|
, QString const& mode, QString const& message);
|
|
|
|
// ask the client with identification 'id' to replay all decodes
|
|
Q_SLOT void replay (QString const& id);
|
|
|
|
// the following signals are emitted when a client broadcasts the
|
|
// matching message
|
|
Q_SIGNAL void client_opened (QString const& id);
|
|
Q_SIGNAL void status_update (QString const& id, Frequency, QString const& mode, QString const& dx_call
|
|
, QString const& report, QString const& tx_mode);
|
|
Q_SIGNAL void client_closed (QString const& id);
|
|
Q_SIGNAL void decode (bool is_new, QString const& id, QTime time, qint32 snr, float delta_time
|
|
, quint32 delta_frequency, QString const& mode, QString const& message);
|
|
Q_SIGNAL void qso_logged (QString const& id, QDateTime time, 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);
|
|
Q_SIGNAL void clear_decodes (QString const& id);
|
|
|
|
// this signal is emitted when a network error occurs
|
|
Q_SIGNAL void error (QString const&) const;
|
|
|
|
private:
|
|
class impl;
|
|
pimpl<impl> m_;
|
|
};
|
|
|
|
#endif
|