GammaRay API Documentation  2.11.0
Classes | Public Slots | Signals | Public Member Functions | Static Public Member Functions | List of all members
GammaRay::Endpoint Class Referenceabstract

Network protocol endpoint. More...

#include <endpoint.h>

Inheritance diagram for GammaRay::Endpoint:
Inheritance graph
[legend]

Public Slots

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

Signals

void connectionEstablished ()
 Emitted when a connection to another endpoint was successfully established and passed the protocol version handshake step. More...
 
void disconnected ()
 Emitted when we lost the connection to the other endpoint. More...
 
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. More...
 
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. More...
 
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. More...
 
void waitForMessagesWritten ()
 Write all pending data and block until this is done. More...
 
- 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 () const const
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, 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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
virtual int qt_metacall (QMetaObject::Call, int, void **)
 
virtual void * qt_metacast (const char *)
 
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)
 
QThreadthread () const const
 

Static Public Member Functions

static quint16 broadcastPort ()
 
static quint16 defaultPort ()
 
static Endpointinstance ()
 Singleton accessor. More...
 
static bool isConnected ()
 Returns true if we are currently connected to another endpoint. More...
 
static void send (const Message &msg)
 Send msg to the connected endpoint. More...
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Network protocol endpoint.

Contains:

Member Function Documentation

void GammaRay::Endpoint::connectionEstablished ( )
signal

Emitted when a connection to another endpoint was successfully established and passed the protocol version handshake step.

void GammaRay::Endpoint::disconnected ( )
signal

Emitted when we lost the connection to the other endpoint.

static Endpoint* GammaRay::Endpoint::instance ( )
static

Singleton accessor.

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.

static bool GammaRay::Endpoint::isConnected ( )
static

Returns true if we are currently connected to another endpoint.

Protocol::ObjectAddress GammaRay::Endpoint::objectAddress ( const QString objectName) const

Returns the object address for objectName, or Protocol::InvalidObjectAddress if not known.

void GammaRay::Endpoint::objectRegistered ( const QString objectName,
Protocol::ObjectAddress  objectAddress 
)
signal

Emitted when a new object with name objectName has been registered at address objectAddress.

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()
static void GammaRay::Endpoint::send ( const Message &  msg)
static

Send msg to the connected endpoint.

void GammaRay::Endpoint::sendMessage ( const GammaRay::Message &  msg)
slot

Convenience overload of send(), to directly send message delivered via signals.

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

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

when saving settings.

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

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

when advertising on the network.

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

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

when querying system pid.

virtual void GammaRay::Endpoint::unregisterMessageHandler ( Protocol::ObjectAddress  objectAddress)
virtual

Unregister the message handler for objectAddress.

void GammaRay::Endpoint::waitForMessagesWritten ( )

Write all pending data and block until this is done.

This should only be used in very rare situations.


Klarälvdalens Datakonsult AB (KDAB)
"The Qt Experts"
https://www.kdab.com/
GammaRay
Qt-application inspection and manipulation tool
https://www.kdab.com/gammaray/