PdCom::Process implementation for Qt. More...

#include <Process.h>

Inheritance diagram for QtPdCom::Process:

Collaboration diagram for QtPdCom::Process:

Classes
struct	Impl

Public Types
enum	SslCaMode { SslCaMode::NoTLS, SslCaMode::DefaultCAs, SslCaMode::CustomCAs, SslCaMode::IgnoreCertificate }

enum	ConnectionState { Disconnected, Connecting, Connected, ConnectError, ConnectedError }
	State of the process connection. More...

Signals
void	processConnected ()
	Connection established. More...

void	disconnected ()
	Disconnected gracefully. More...

void	error ()
	Connection error. More...

void	broadcastReceived (const QString &message, const QString &attr, std::uint64_t time_ns, const QString &user)

void	connectionStatusChanged ()

void	sslCaModeChanged ()

Public Member Functions
	Process (QObject *parent=nullptr)
	Constructor. More...

virtual	~Process ()
	Destructor. More...

void	setApplicationName (const QString &)
	Sets the application name. More...

QString	getApplicationName () const

Q_INVOKABLE void	connectToHost (const QString &, quint16=2345)
	Starts to connect to a process. More...

Q_INVOKABLE void	disconnectFromHost ()
	Disconnects from a process. More...

	Q_ENUM (ConnectionState)

ConnectionState	getConnectionState () const

bool	isConnected () const

const QString &	getErrorString () const

QString	getPeerName () const

QUrl	getUrl () const

int	getPort () const

QString	getHost () const

Q_INVOKABLE void	sendBroadcast (const QString &, const QString &attr="text")
	Send a broadcast message. More...

quint64	getRxBytes () const

quint64	getTxBytes () const

QFuture< PdCom::Variable >	find (const QString &)
	Find a Variable. More...

QFuture< VariableList >	list (const QString &="")
	Wrapper function for Process::list. More...

QFuture< void >	pingQt ()

QFuture< std::vector< PdCom::ClientStatistics > >	getClientStatisticsQt ()

template<class Class , class Function >
QFutureWatcher< PdCom::Variable > &	find (const QString &path, Class *obj, Function &&callback)
	Also find a Variable. More...

template<class Class , class Function >
QFutureWatcher< VariableList > &	list (const QString &path, Class *obj, Function &&callback)

template<class Class , class Function >
QFutureWatcher< void > &	ping (Class *obj, Function &&callback)

template<class Class , class Function >
QFutureWatcher< std::vector< PdCom::ClientStatistics > > &	getClientStatistics (Class *obj, Function &&callback)

void	setCaMode (SslCaMode mode)
	Set Traffic Encryption mode. More...

SslCaMode	getCaMode () const
	Get Traffic Encryption mode. More...

void	setClientCertificate (const QSslCertificate &cert, const QSslKey &key)
	Provide a client certificate. More...

void	setCustomCAs (QList< QSslCertificate > cas)
	Set list of trusted Certificate Authorities. More...

PdCom::MessageManagerBase *	getMessageManager () const

void	setLoginManager (LoginManager *lm)
	Set the Login Manager. More...

LoginManager *	getLoginManager () const

Static Public Member Functions
static QtPdCom::Process *	getDefaultProcess ()

static void	setDefaultProcess (QtPdCom::Process *)
	Set default process "manually". More...

Properties
bool	connected
	The process is connected and ready. More...

ConnectionState	connectionState

SslCaMode	sslCaMode

int	port

QString	host

QUrl	url

QString	applicationName

QtPdCom::LoginManager	loginManager

Private Slots
void	socketConnected ()
	Socket connection established. More...

void	socketDisconnected ()
	Socket disconnected. More...

void	socketError ()
	There was a socket error. More...

void	socketRead ()
	The socket has new data to read. More...

Private Member Functions
std::string	applicationName () const override
	Virtual from PdCom::Process. More...

std::string	hostname () const override

int	read (char *, int) override
	Read data from the socket. More...

void	write (const char *, size_t) override
	Sends data via the socket. More...

void	flush () override
	Flushed the socket. More...

void	connected () override

void	broadcastReply (const std::string &message, const std::string &attr, std::chrono::nanoseconds time_ns, const std::string &user) override
	Broadcast Reply. More...

void	pingReply () override
	Ping Reply. More...

void	findReply (PdCom::Variable const &var) override

void	listReply (std::vector< PdCom::Variable > vars, std::vector< std::string > dirs) override

void	clientStatisticsReply (std::vector< PdCom::ClientStatistics > statistics) override

void	reset ()
	Resets the PdCom process. More...

bool	disconnect (const char signal=0, const QObject receiver=0, const char *method=0)
	Disconnect method inherited from QObject. More...

Private Attributes
struct Q_DECL_HIDDEN	Impl

std::unique_ptr< Impl >	impl

Detailed Description

PdCom::Process implementation for Qt.

Member Enumeration Documentation

◆ ConnectionState

enum QtPdCom::Process::ConnectionState

State of the process connection.

Enumerator
Disconnected	Process disconnected.
Connecting	Currently connecting.
Connected	Process connection established.
ConnectError	An error happened while connecting.
ConnectedError	An error happened, after the connection was established.

◆ SslCaMode

enum QtPdCom::Process::SslCaMode

strong

Enumerator
NoTLS	Disable TLS, unencrypted traffic only.
DefaultCAs	Use system-default Certificate Authories.
CustomCAs	Use provided CAs only.
IgnoreCertificate	Accept any server certificate.

Constructor & Destructor Documentation

◆ Process()

Process::Process ( QObject * parent = nullptr )

Constructor.

◆ ~Process()

Process::~Process ( )

virtual

Destructor.

References disconnectFromHost(), impl, and reset().

Member Function Documentation

◆ applicationName()

std::string QtPdCom::Process::applicationName ( ) const

overrideprivate

Virtual from PdCom::Process.

◆ broadcastReceived

void QtPdCom::Process::broadcastReceived	(	const QString &	message,
		const QString &	attr,
		std::uint64_t	time_ns,
		const QString &	user
	)

signal

Referenced by QtPdCom::BroadcastModel::connectProcess().

◆ broadcastReply()

void Process::broadcastReply	(	const std::string &	message,
		const std::string &	attr,
		std::chrono::nanoseconds	time_ns,
		const std::string &	user
	)

overrideprivate

Broadcast Reply.

◆ clientStatisticsReply()

void QtPdCom::Process::clientStatisticsReply ( std::vector< PdCom::ClientStatistics > statistics )

overrideprivate

◆ connected()

void QtPdCom::Process::connected ( )

overrideprivate

◆ connectionStatusChanged

void QtPdCom::Process::connectionStatusChanged ( )

signal

Referenced by QtPdCom::Process::Impl::setConnectionState().

◆ connectToHost()

void Process::connectToHost	(	const QString &	address,
		quint16	port = `2345`
	)

Starts to connect to a process.

References impl, and port.

◆ disconnect()

bool QtPdCom::Process::disconnect	(	const char *	signal = `0`,
		const QObject *	receiver = `0`,
		const char *	method = `0`
	)

private

Disconnect method inherited from QObject.

This is made private, to avoid confusion.

Parameters

signal	Signal.
receiver	Receiver.
method	Method.

◆ disconnected

void QtPdCom::Process::disconnected ( )

signal

Disconnected gracefully.

This is only emitted, after the user called disconnectFromHost().

◆ disconnectFromHost()

void Process::disconnectFromHost ( )

Disconnects from a process.

Referenced by ~Process().

◆ error

void QtPdCom::Process::error ( )

signal

Connection error.

This is emitted after a connection error or when the connection was closed due to a parser error.

◆ find() [1/2]

QFuture< PdCom::Variable > Process::find ( const QString & path )

Find a Variable.

Wrapper function for Process::findVariable.

Finding a variable is asynchronous in general. If you need to write to a variable, a variable object is needed. To write a variable with a single call you can use futures and a lambda function. See the example in the overloaded method find(const QString&, Class *, Function&&).

Returns: A Future. You can use VariableWatcher to monitor it.

Referenced by find().

◆ find() [2/2]

template<class Class , class Function >

QFutureWatcher< PdCom::Variable > & QtPdCom::Process::find	(	const QString &	path,
		Class *	obj,
		Function &&	callback
	)

inline

Also find a Variable.

Here, a FutureWatcher is created on your behalf. Callback can be one of

a member Function of obj which takes a PdCom::Variable
a lambda which takes a reference to obj and a PdCom::Variable
a lambda which takes only a PdCom::Variable

The obj reference is needed to use it as a parent for the watcher and to make the connections disconnect automatically when the Process or the object itself goes away.

Below is an example of how to make use of a lambda function to find a variable and write to it once it is found:

const double val = 30.0;
const QString path = "/osc/amplitude/Setpoint";
process->find(path, this, [val](const PdCom::Variable& var) {
    if (var.empty()) {
        std::cerr << "Variable not found." << std::endl;
    }
    else {
        var.setValue(val);
        std::cerr << "Set " << var.getPath()
                  << " to " << val << std::endl;
    }
});

Parameters

path	Variable to find.
obj	QObject-derived class.
callback	Callback which receives the result.

Returns: A freshly created FutureWatcher instance with all signals connected.

References find().

◆ findReply()

void Process::findReply ( PdCom::Variable const & var )

overrideprivate

◆ flush()

void Process::flush ( )

overrideprivate

Flushed the socket.

◆ getApplicationName()

QString Process::getApplicationName ( ) const

References impl.

◆ getCaMode()

Process::SslCaMode Process::getCaMode ( ) const

Get Traffic Encryption mode.

Returns: Traffic Encryption mode.

◆ getClientStatistics()

template<class Class , class Function >

QFutureWatcher< std::vector< PdCom::ClientStatistics > > & QtPdCom::Process::getClientStatistics	(	Class *	obj,
		Function &&	callback
	)

inline

References getClientStatisticsQt().

◆ getClientStatisticsQt()

QFuture< std::vector< PdCom::ClientStatistics > > QtPdCom::Process::getClientStatisticsQt ( )

Referenced by getClientStatistics().

◆ getConnectionState()

Process::ConnectionState Process::getConnectionState ( ) const

Returns: The connection state.

◆ getDefaultProcess()

QtPdCom::Process * Process::getDefaultProcess ( )

static

References QtPdCom::Process::Impl::defaultProcess.

◆ getErrorString()

const QString & Process::getErrorString ( ) const

Returns: Error reason after the error() signal was emitted.

◆ getHost()

QString Process::getHost ( ) const

◆ getLoginManager()

QtPdCom::LoginManager * Process::getLoginManager ( ) const

References QtPdCom::LoginManagerPrivate::q_ptr.

◆ getMessageManager()

PdCom::MessageManagerBase * Process::getMessageManager ( ) const

Referenced by QtPdCom::MessageModel::connect().

◆ getPeerName()

QString Process::getPeerName ( ) const

Returns: Host name of the process.

◆ getPort()

int Process::getPort ( ) const

◆ getRxBytes()

quint64 Process::getRxBytes ( ) const

◆ getTxBytes()

quint64 Process::getTxBytes ( ) const

◆ getUrl()

QUrl Process::getUrl ( ) const

◆ hostname()

std::string Process::hostname ( ) const

overrideprivate

◆ isConnected()

bool Process::isConnected ( ) const

Returns: true, if the process is connected.

Referenced by QtPdCom::ClientStatisticsModel::setProcess().

◆ list() [1/2]

QFuture< QtPdCom::VariableList > Process::list ( const QString & path = "" )

Wrapper function for Process::list.

Referenced by list().

◆ list() [2/2]

template<class Class , class Function >

QFutureWatcher< VariableList > & QtPdCom::Process::list	(	const QString &	path,
		Class *	obj,
		Function &&	callback
	)

inline

References list().

◆ listReply()

void Process::listReply	(	std::vector< PdCom::Variable >	vars,
		std::vector< std::string >	dirs
	)

overrideprivate

◆ ping()

template<class Class , class Function >

QFutureWatcher< void > & QtPdCom::Process::ping	(	Class *	obj,
		Function &&	callback
	)

inline

References pingQt().

◆ pingQt()

QFuture< void > Process::pingQt ( )

Referenced by ping().

◆ pingReply()

void Process::pingReply ( )

overrideprivate

Ping Reply.

◆ processConnected

void QtPdCom::Process::processConnected ( )

signal

Connection established.

This is emitted after the connection is established.

Referenced by QtPdCom::MessageModel::connect().

◆ Q_ENUM()

QtPdCom::Process::Q_ENUM ( ConnectionState )

◆ read()

int Process::read	(	char *	buf,
		int	count
	)

overrideprivate

Read data from the socket.

◆ reset()

void Process::reset ( )

private

Resets the PdCom process.

Referenced by ~Process().

◆ sendBroadcast()

void Process::sendBroadcast	(	const QString &	msg,
		const QString &	attr = `"text"`
	)

Send a broadcast message.

◆ setApplicationName()

void Process::setApplicationName ( const QString & name )

Sets the application name.

References impl.

◆ setCaMode()

void QtPdCom::Process::setCaMode ( SslCaMode mode )

Set Traffic Encryption mode.

See the SslCaMode enum for details.

Parameters

mode Mode.

◆ setClientCertificate()

void QtPdCom::Process::setClientCertificate	(	const QSslCertificate &	cert,
		const QSslKey &	key
	)

Provide a client certificate.

Parameters

cert	Public certificate.
key	Private key.

◆ setCustomCAs()

void QtPdCom::Process::setCustomCAs ( QList< QSslCertificate > cas )

Set list of trusted Certificate Authorities.

For SslCaMode::CustomCAs mode.

Parameters

cas	List of trusted CAs.

◆ setDefaultProcess()

void Process::setDefaultProcess ( QtPdCom::Process * process )

static

Set default process "manually".

References QtPdCom::Process::Impl::defaultProcess.

◆ setLoginManager()

void QtPdCom::Process::setLoginManager ( LoginManager * lm )

Set the Login Manager.

Parameters

lm	The Login manager. May be `NULL`.

References QtPdCom::LoginManager::d_ptr.

◆ socketConnected

void Process::socketConnected ( )

privateslot

Socket connection established.

This is called, when the pure socket connection was established and the Process object can start using it.

◆ socketDisconnected

void Process::socketDisconnected ( )

privateslot

Socket disconnected.

The socket was closed and the process has to be told, that it is disconnected.

◆ socketError

void Process::socketError ( )

privateslot

There was a socket error.

The error could come up either while connecting the socket, or when the socket was already connected.

◆ socketRead

void Process::socketRead ( )

privateslot

The socket has new data to read.

◆ sslCaModeChanged

void QtPdCom::Process::sslCaModeChanged ( )

signal

◆ write()

void Process::write	(	const char *	buf,
		size_t	count
	)

overrideprivate

Sends data via the socket.

This is the implementation of the virtual PdCom::Process method to enable the Process object to send data to the process.

Member Data Documentation

◆ Impl

struct Q_DECL_HIDDEN QtPdCom::Process::Impl

private

◆ impl

std::unique_ptr<Impl> QtPdCom::Process::impl

private

Referenced by connectToHost(), getApplicationName(), setApplicationName(), and ~Process().

Property Documentation

◆ applicationName

std::string Process::applicationName

readwrite

◆ connected

void Process::connected

read

The process is connected and ready.

This virtual function from PdCom::Process has to be overloaded to let subclasses know about this event.

◆ connectionState

ConnectionState QtPdCom::Process::connectionState

read

◆ host

QString QtPdCom::Process::host

read

◆ loginManager

QtPdCom::LoginManager QtPdCom::Process::loginManager

readwrite

◆ port

int QtPdCom::Process::port

read

Referenced by connectToHost().

◆ sslCaMode

SslCaMode QtPdCom::Process::sslCaMode

readwrite

◆ url

QUrl QtPdCom::Process::url

read

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

QtPdCom1/Process.h
src/Process.cpp

Classes

Public Types

Signals

Public Member Functions

Static Public Member Functions

Properties

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ConnectionState

◆ SslCaMode

Constructor & Destructor Documentation

◆ Process()

◆ ~Process()

Member Function Documentation

◆ applicationName()

◆ broadcastReceived

◆ broadcastReply()

◆ clientStatisticsReply()

◆ connected()

◆ connectionStatusChanged

◆ connectToHost()

◆ disconnect()

◆ disconnected

◆ disconnectFromHost()

◆ error

◆ find() [1/2]

◆ find() [2/2]

◆ findReply()

◆ flush()

◆ getApplicationName()

◆ getCaMode()

◆ getClientStatistics()

◆ getClientStatisticsQt()

◆ getConnectionState()

◆ getDefaultProcess()

◆ getErrorString()

◆ getHost()

◆ getLoginManager()

◆ getMessageManager()

◆ getPeerName()

◆ getPort()

◆ getRxBytes()

◆ getTxBytes()

◆ getUrl()

◆ hostname()

◆ isConnected()

◆ list() [1/2]

◆ list() [2/2]

◆ listReply()

◆ ping()

◆ pingQt()

◆ pingReply()

◆ processConnected

◆ Q_ENUM()

◆ read()

◆ reset()

◆ sendBroadcast()

◆ setApplicationName()

◆ setCaMode()

◆ setClientCertificate()

◆ setCustomCAs()

◆ setDefaultProcess()

◆ setLoginManager()

◆ socketConnected

◆ socketDisconnected

◆ socketError

◆ socketRead

◆ sslCaModeChanged

◆ write()

Member Data Documentation

◆ Impl

◆ impl

Property Documentation

◆ applicationName

◆ connected

◆ connectionState

◆ host