Network protocol endpoint. More...

#include <endpoint.h>

Inheritance diagram for GammaRay::Endpoint:

[legend]

Public Slots
void	sendMessage (const GammaRay::Message &msg)
	Convenience overload of send(), to directly send message delivered via signals.

Signals
void	connectionEstablished ()
	Emitted when a connection to another endpoint was successfully established and passed the protocol version handshake step.

void	disconnected ()
	Emitted when we lost the connection to the other endpoint.

void	logTransmissionRate (quint64 bytesRead, quint64 bytesWritten)

void	objectRegistered (const QString &objectName, Protocol::ObjectAddress objectAddress)
	Emitted when a new object with name `objectName` has been registered at address `objectAddress`.

void	objectUnregistered (const QString &objectName, Protocol::ObjectAddress objectAddress)

Public Member Functions
virtual void	invokeObject (const QString &objectName, const char *method, const QVariantList &args=QVariantList()) const
	Invoke `method` on the object called `objectName` with the given `args`.

virtual bool	isRemoteClient () const =0
	Returns true for remote clients and false for the in-probe server endpoint.

QString	key () const
	Returns a fixed string uniquely describing the host program.

QString	label () const
	Returns a human-readable string describing the host program.

Protocol::ObjectAddress	objectAddress (const QString &objectName) const
	Returns the object address for `objectName`, or `Protocol::InvalidObjectAddress` if not known.

qint64	pid () const
	Returns the process identifier (pid) of the host program.

virtual void	registerMessageHandler (Protocol::ObjectAddress objectAddress, QObject receiver, const char messageHandlerName)
	Register the slot `messageHandlerName` on `receiver` as the handler for messages to/from `objectAddress`.

virtual Protocol::ObjectAddress	registerObject (const QString &name, QObject *object)
	Register an object of the given name for transparent server/client communication.

virtual QUrl	serverAddress () const =0
	Returns the listening address of the server, in case you need to connect to a different service there (such as the web inspector server).

void	setKey (const QString &key)
	Sets the fixed key of this instance used e.g.

void	setLabel (const QString &label)
	Sets the human-readable label of this instance used e.g.

void	setPid (qint64 pid)
	Sets the process identifier of the host program of this instance used e.g.

virtual void	unregisterMessageHandler (Protocol::ObjectAddress objectAddress)
	Unregister the message handler for `objectAddress`.

void	waitForMessagesWritten ()
	Write all pending data and block until this is done.

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static quint16	broadcastPort ()

static quint16	defaultPort ()

static Endpoint *	instance ()
	Singleton accessor.

static bool	isConnected ()
	Returns `true` if we are currently connected to another endpoint.

static void	send (const Message &msg)
	Send `msg` to the connected endpoint.

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

Detailed Description

Network protocol endpoint.

Contains:

object address <-> object name mapping
message handler registration and message dispatching

Member Function Documentation

◆ invokeObject()

virtual void GammaRay::Endpoint::invokeObject	(	const QString &	objectName,
		const char *	method,
		const QVariantList &	args = `QVariantList()`
	)		const

virtual

Invoke method on the object called objectName with the given args.

This also works with signals.

The default implementation forwards the object calls to remote side when the endpoint is connected. The Server implementation is furthermore expected to call the method directly on the local object to support the in-process mode.

Reimplemented in GammaRay::Server.

◆ isRemoteClient()

virtual bool GammaRay::Endpoint::isRemoteClient ( ) const

pure virtual

Returns true for remote clients and false for the in-probe server endpoint.

Implemented in GammaRay::Server.

◆ registerMessageHandler()

virtual void GammaRay::Endpoint::registerMessageHandler	(	Protocol::ObjectAddress	objectAddress,
		QObject *	receiver,
		const char *	messageHandlerName
	)

virtual

Register the slot messageHandlerName on receiver as the handler for messages to/from objectAddress.

See also: dispatchMessage()

◆ registerObject()

virtual Protocol::ObjectAddress GammaRay::Endpoint::registerObject	(	const QString &	name,
		QObject *	object
	)

virtual

Register an object of the given name for transparent server/client communication.

Reimplemented in GammaRay::Server.

◆ serverAddress()

virtual QUrl GammaRay::Endpoint::serverAddress ( ) const

pure virtual

Returns the listening address of the server, in case you need to connect to a different service there (such as the web inspector server).

Implemented in GammaRay::Server.

◆ setKey()

void GammaRay::Endpoint::setKey ( const QString & key )

Sets the fixed key of this instance used e.g.

when saving settings.

◆ setLabel()

void GammaRay::Endpoint::setLabel ( const QString & label )

Sets the human-readable label of this instance used e.g.

when advertising on the network.

◆ setPid()

void GammaRay::Endpoint::setPid ( qint64 pid )

Sets the process identifier of the host program of this instance used e.g.

when querying system pid.

◆ waitForMessagesWritten()

void GammaRay::Endpoint::waitForMessagesWritten ( )

Write all pending data and block until this is done.

This should only be used in very rare situations.

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ invokeObject()

◆ isRemoteClient()

◆ registerMessageHandler()

◆ registerObject()

◆ serverAddress()

◆ setKey()

◆ setLabel()

◆ setPid()

◆ waitForMessagesWritten()