Network protocol endpoint. More...

#include <endpoint.h>

Inheritance diagram for GammaRay::Endpoint:

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`. More...

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`. More...

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

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

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

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

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

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.

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.

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

◆ 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