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 class	SslCaMode { NoTLS , DefaultCAs , CustomCAs , IgnoreCertificate }
enum	ConnectionState { Disconnected , Connecting , Connected , ConnectError , ConnectedError }
	State of the process connection. More...

Signals
void	processConnected ()
	Connection established.
void	disconnected ()
	Disconnected gracefully.
void	error ()
	Connection error.
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.
virtual	~Process ()
	Destructor.
void	setApplicationName (const QString &)
	Sets the application name.
QString	getApplicationName () const
Q_INVOKABLE void	connectToHost (const QString &, quint16=2345)
	Starts to connect to a process.
Q_INVOKABLE void	disconnectFromHost ()
	Disconnects from a process.
	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.
Q_INVOKABLE quint64	getRxBytes () const
Q_INVOKABLE quint64	getTxBytes () const
QVariant	nameQt () const
	Remote process name string.
QVariant	versionQt () const
	Remote process version string.
QFuture< PdCom::Variable >	find (const QString &)
	Find a Variable.
QFuture< VariableList >	list (const QString &="")
	Wrapper function for Process::list.
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.
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.
SslCaMode	getCaMode () const
	Get Traffic Encryption mode.
void	setClientCertificate (const QSslCertificate &cert, const QSslKey &key)
	Provide a client certificate.
void	setCustomCAs (QList< QSslCertificate > cas)
	Set list of trusted Certificate Authorities.
PdCom::MessageManagerBase *	getMessageManager () const
void	setLoginManager (LoginManager *lm)
	Set the Login Manager.
LoginManager *	getLoginManager () const

Static Public Member Functions
static QtPdCom::Process *	getDefaultProcess ()
static void	setDefaultProcess (QtPdCom::Process *)
	Set default process "manually".

Properties
bool	connected
	The process is connected and ready.
ConnectionState	connectionState
SslCaMode	sslCaMode
int	port
QString	host
QUrl	url
QString	applicationName
QtPdCom::LoginManager *	loginManager
QVariant	name
QVariant	version

Private Slots
void	socketConnected ()
	Socket connection established.
void	socketDisconnected ()
	Socket disconnected.
void	socketError ()
	There was a socket error.
void	socketRead ()
	The socket has new data to read.

Private Member Functions
std::string	applicationName () const override
	Virtual from PdCom::Process.
std::string	hostname () const override
int	read (char *, int) override
	Read data from the socket.
void	write (const char *, size_t) override
	Sends data via the socket.
void	flush () override
	Flushed the socket.
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.
void	pingReply () override
	Ping Reply.
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.
bool	disconnect (const char signal=0, const QObject receiver=0, const char *method=0)
	Disconnect method inherited from QObject.

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 class 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.

References impl, and Process().

Referenced by QtPdCom::Process::Impl::Impl(), and Process().

◆ ~Process()

Process::~Process ( )

virtual

Destructor.

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

Member Function Documentation

◆ applicationName()

std::string Process::applicationName ( ) const

overrideprivate

Virtual from PdCom::Process.

References impl.

◆ broadcastReceived

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

signal

Referenced by broadcastReply(), and 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.

References broadcastReceived().

Referenced by connected().

◆ clientStatisticsReply()

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

overrideprivate

References impl.

Referenced by connected().

◆ connected()

void QtPdCom::Process::connected ( )

overrideprivate

References broadcastReply(), clientStatisticsReply(), findReply(), listReply(), pingReply(), and reset().

◆ connectionStatusChanged

void QtPdCom::Process::connectionStatusChanged ( )

signal

◆ 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().

Referenced by disconnectFromHost(), socketDisconnected(), and QtPdCom::PdVariable::updateConnection().

◆ disconnectFromHost()

void Process::disconnectFromHost ( )

Disconnects from a process.

References Connected, Connecting, Disconnected, disconnected(), impl, and reset().

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.

Referenced by socketDisconnected(), socketError(), socketRead(), QtPdCom::PdVariable::updateConnection(), and write().

◆ 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.

References find(), and impl.

Referenced by find(), find(), and Q_ENUM().

◆ 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 QtPdCom::createWatcher(), and find().

◆ findReply()

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

overrideprivate

References impl.

Referenced by connected().

◆ 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.

References impl.

Referenced by Q_ENUM().

◆ getClientStatistics()

template<class Class, class Function>

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

inline

References QtPdCom::createWatcher(), and getClientStatisticsQt().

Referenced by getClientStatisticsQt(), and Q_ENUM().

◆ getClientStatisticsQt()

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

References getClientStatistics(), and impl.

Referenced by getClientStatistics(), and Q_ENUM().

◆ getConnectionState()

Process::ConnectionState Process::getConnectionState ( ) const

Returns: The connection state.

References impl.

Referenced by Q_ENUM().

◆ getDefaultProcess()

QtPdCom::Process * Process::getDefaultProcess ( )

static

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

Referenced by Q_ENUM().

◆ getErrorString()

const QString & Process::getErrorString ( ) const

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

References impl.

Referenced by Q_ENUM().

◆ getHost()

QString Process::getHost ( ) const

References impl.

Referenced by Q_ENUM().

◆ getLoginManager()

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

References QtPdCom::LoginManagerPrivate::q_ptr.

Referenced by Q_ENUM().

◆ getMessageManager()

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

References impl.

Referenced by Q_ENUM().

◆ getPeerName()

QString Process::getPeerName ( ) const

Returns: Host name of the process.

References impl.

Referenced by Q_ENUM().

◆ getPort()

int Process::getPort ( ) const

References impl.

Referenced by Q_ENUM().

◆ getRxBytes()

quint64 Process::getRxBytes ( ) const

References impl.

Referenced by Q_ENUM().

◆ getTxBytes()

quint64 Process::getTxBytes ( ) const

References impl.

Referenced by Q_ENUM().

◆ getUrl()

QUrl Process::getUrl ( ) const

References impl.

Referenced by Q_ENUM().

◆ hostname()

std::string Process::hostname ( ) const

overrideprivate

References hostname().

Referenced by hostname().

◆ isConnected()

bool Process::isConnected ( ) const

Returns: true, if the process is connected.

References Connected, and impl.

Referenced by Q_ENUM().

◆ list() [1/2]

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

Wrapper function for Process::list.

References impl, and list().

Referenced by list(), list(), and Q_ENUM().

◆ list() [2/2]

template<class Class, class Function>

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

inline

References QtPdCom::createWatcher(), and list().

◆ listReply()

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

overrideprivate

References impl.

Referenced by connected().

◆ nameQt()

QVariant Process::nameQt ( ) const

Remote process name string.

References name.

Referenced by Q_ENUM().

◆ ping()

template<class Class, class Function>

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

inline

References QtPdCom::createWatcher(), and pingQt().

Referenced by QtPdCom::QmlProcess::ping(), pingQt(), and Q_ENUM().

◆ pingQt()

QFuture< void > Process::pingQt ( )

References impl, and ping().

Referenced by ping(), and Q_ENUM().

◆ pingReply()

void Process::pingReply ( )

overrideprivate

Ping Reply.

References impl.

Referenced by connected().

◆ 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.

References ConnectedError, Disconnected, and impl.

◆ reset()

void Process::reset ( )

private

Resets the PdCom process.

References impl, and reset().

Referenced by connected(), disconnectFromHost(), reset(), socketDisconnected(), socketError(), socketRead(), write(), and ~Process().

◆ sendBroadcast()

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

Send a broadcast message.

Referenced by Q_ENUM().

◆ setApplicationName()

void Process::setApplicationName ( const QString & name )

Sets the application name.

References impl, and name.

◆ setCaMode()

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

Set Traffic Encryption mode.

See the SslCaMode enum for details.

Parameters

mode Mode.

References impl, NoTLS, and sslCaModeChanged().

Referenced by Q_ENUM().

◆ setClientCertificate()

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

Provide a client certificate.

Parameters

cert	Public certificate.
key	Private key.

References impl.

Referenced by Q_ENUM().

◆ setCustomCAs()

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

Set list of trusted Certificate Authorities.

For SslCaMode::CustomCAs mode.

Parameters

cas	List of trusted CAs.

References impl.

Referenced by Q_ENUM().

◆ setDefaultProcess()

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

static

Set default process "manually".

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

Referenced by QtPdCom::DefaultProcess::createDefaultInstance(), and Q_ENUM().

◆ setLoginManager()

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

Set the Login Manager.

Parameters

lm	The Login manager. May be `NULL`.

References QtPdCom::LoginManager::d_ptr.

Referenced by Q_ENUM().

◆ 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.

References impl.

Referenced by sslCaModeChanged().

◆ socketDisconnected

void Process::socketDisconnected ( )

privateslot

Socket disconnected.

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

References Connected, ConnectError, Connecting, Disconnected, disconnected(), error(), impl, and reset().

Referenced by sslCaModeChanged().

◆ 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.

References Connected, ConnectedError, ConnectError, Connecting, error(), impl, and reset().

Referenced by sslCaModeChanged().

◆ socketRead

void Process::socketRead ( )

privateslot

The socket has new data to read.

References Connected, ConnectedError, ConnectError, error(), impl, and reset().

Referenced by sslCaModeChanged().

◆ sslCaModeChanged

void QtPdCom::Process::sslCaModeChanged ( )

signal

References socketConnected(), socketDisconnected(), socketError(), and socketRead().

Referenced by setCaMode().

◆ versionQt()

QVariant Process::versionQt ( ) const

Remote process version string.

References version.

Referenced by Q_ENUM().

◆ 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.

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

Member Data Documentation

◆ Impl

struct Q_DECL_HIDDEN QtPdCom::Process::Impl

private

◆ impl

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

private

Property Documentation

◆ applicationName

QString QtPdCom::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

◆ name

QVariant QtPdCom::Process::name

read

Referenced by nameQt(), and setApplicationName().

◆ port

int QtPdCom::Process::port

read

Referenced by connectToHost(), and QtPdCom::Process::Impl::connectToHost().

◆ sslCaMode

SslCaMode QtPdCom::Process::sslCaMode

readwrite

◆ url

QUrl QtPdCom::Process::url

read

◆ version

QVariant QtPdCom::Process::version

read

Referenced by versionQt().

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()

◆ nameQt()

◆ ping()

◆ pingQt()

◆ pingReply()

◆ processConnected

◆ Q_ENUM()

◆ read()

◆ reset()

◆ sendBroadcast()

◆ setApplicationName()

◆ setCaMode()

◆ setClientCertificate()

◆ setCustomCAs()

◆ setDefaultProcess()

◆ setLoginManager()

◆ socketConnected

◆ socketDisconnected

◆ socketError

◆ socketRead

◆ sslCaModeChanged

◆ versionQt()

◆ write()

Member Data Documentation

◆ Impl

◆ impl

Property Documentation

◆ applicationName

◆ connected