JS8Call-Improved master
Loading...
Searching...
No Matches
SpotClient Class Referencefinal

Sends spots and spot-related commands to a remote host. More...

#include <SpotClient.h>

Inheritance diagram for SpotClient:
Collaboration diagram for SpotClient:

Public Member Functions

 SpotClient (QString const &host, quint16 port, QString const &version, QObject *parent=nullptr)
 Construct a SpotClient.
void start ()
void setLocalStation (QString const &callsign, QString const &grid, QString const &info)
 Set local station identity included in outgoing messages.
void enqueueCmd (QString const &cmd, QString const &from, QString const &to, QString const &relayPath, QString const &text, QString const &grid, QString const &extra, int const submode, Radio::Frequency const dial, int const offset, int const snr)
 Enqueue a command-style message for transmission.
void enqueueSpot (QString const &callsign, QString const &grid, int const submode, Radio::Frequency const dial, int const offset, int const snr)
 Enqueue a simple spot (callsign/grid) for transmission.
Q_SIGNAL void error (QString const &) const

Detailed Description

Sends spots and spot-related commands to a remote host.

Constructor & Destructor Documentation

◆ SpotClient()

SpotClient::SpotClient ( QString const & name,
quint16 port,
QString const & version,
QObject * parent = nullptr )

Construct a SpotClient.

Constructs a SpotClient object.

Parameters
hostRemote host name or IP.
portRemote TCP port.
versionProtocol/version string included in handshakes.
parentOptional QObject parent.
nameThe hostname of the spot server.
portThe port number of the spot server.
versionThe version string of the client.
parentThe parent QObject.

Member Function Documentation

◆ enqueueCmd()

void SpotClient::enqueueCmd ( QString const & cmd,
QString const & from,
QString const & to,
QString const & relayPath,
QString const & text,
QString const & grid,
QString const & extra,
int const submode,
Radio::Frequency const dial,
int const offset,
int const snr )

Enqueue a command-style message for transmission.

Enqueues a command to be sent to the spot server.

Parameters
cmdCommand verb.
fromOriginator callsign.
toDestination callsign (or group).
relayPathRelay path string.
textMessage payload.
gridMaidenhead grid for the sender.
extraExtra data string.
submodeNumeric submode identifier.
dialDial frequency.
offsetOffset from dial in Hz.
snrMeasured SNR value.
cmdThe command string.
fromThe sender callsign.
toThe recipient callsign.
relayPathThe relay path.
textThe message text.
gridThe grid locator.
extraAdditional information.
submodeThe submode identifier.
dialThe dial frequency.
offsetThe frequency offset.
snrThe signal-to-noise ratio.
Here is the caller graph for this function:

◆ enqueueSpot()

void SpotClient::enqueueSpot ( QString const & callsign,
QString const & grid,
int const submode,
Radio::Frequency const dial,
int const offset,
int const snr )

Enqueue a simple spot (callsign/grid) for transmission.

Enqueues a spot to be sent to the spot server.

Parameters
callsignThe callsign of the spotted station.
gridThe grid locator of the spotted station.
submodeThe submode identifier.
dialThe dial frequency.
offsetThe frequency offset.
snrThe signal-to-noise ratio.
Here is the caller graph for this function:

◆ error()

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

Emitted when an error occurs while sending or connecting.

◆ setLocalStation()

void SpotClient::setLocalStation ( QString const & callsign,
QString const & grid,
QString const & info )

Set local station identity included in outgoing messages.

Sets the local station information.

Parameters
callsignLocal callsign.
gridLocal Maidenhead grid.
infoOptional free-form station info string.
callsignThe callsign of the local station.
gridThe grid locator of the local station.
infoAdditional info about the local station.
Here is the caller graph for this function:

◆ start()

void SpotClient::start ( )

Start the client and establish the network connection.

Here is the caller graph for this function:

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