GammaRay API Documentation
2.7.0
|
Network protocol endpoint. More...
#include <endpoint.h>
Public Slots | |
void | sendMessage (const GammaRay::Message &msg) |
Signals | |
void | connectionEstablished () |
void | disconnected () |
void | objectRegistered (const QString &objectName, Protocol::ObjectAddress 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 |
virtual bool | isRemoteClient () const =0 |
QString | key () const |
QString | label () const |
Protocol::ObjectAddress | objectAddress (const QString &objectName) const |
virtual void | registerMessageHandler (Protocol::ObjectAddress objectAddress, QObject *receiver, const char *messageHandlerName) |
virtual Protocol::ObjectAddress | registerObject (const QString &name, QObject *object) |
virtual QUrl | serverAddress () const =0 |
void | setKey (const QString &key) |
void | setLabel (const QString &label) |
virtual void | unregisterMessageHandler (Protocol::ObjectAddress objectAddress) |
void | waitForMessagesWritten () |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const |
bool | disconnect (const QObject *receiver, const char *method) const |
void | dumpObjectInfo () |
void | dumpObjectTree () |
QList< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const |
bool | inherits (const char *className) const |
void | installEventFilter (QObject *filterObj) |
bool | isWidgetType () const |
bool | isWindowType () const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const |
QVariant | property (const char *name) const |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const |
int | startTimer (int interval, Qt::TimerType timerType) |
QThread * | thread () const |
Static Public Member Functions | |
static quint16 | broadcastPort () |
static quint16 | defaultPort () |
static Endpoint * | instance () |
static bool | isConnected () |
static void | send (const Message &msg) |
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) |
Protected Member Functions | |
Endpoint (QObject *parent=nullptr) | |
void | addObjectNameAddressMapping (const QString &objectName, Protocol::ObjectAddress objectAddress) |
void | dispatchMessage (const GammaRay::Message &msg) |
virtual void | doSendMessage (const Message &msg) |
Protocol::ObjectAddress | endpointAddress () const |
virtual void | handlerDestroyed (Protocol::ObjectAddress objectAddress, const QString &objectName)=0 |
void | invokeObjectLocal (QObject *object, const char *method, const QVariantList &args) const |
virtual void | messageReceived (const Message &msg)=0 |
QVector< QPair< Protocol::ObjectAddress, QString > > | objectAddresses () const |
virtual void | objectDestroyed (Protocol::ObjectAddress objectAddress, const QString &objectName, QObject *object)=0 |
void | removeObjectNameAddressMapping (const QString &objectName) |
void | setDevice (QIODevice *device) |
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 |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Protected Attributes | |
PropertySyncer * | m_propertySyncer |
Static Protected Attributes | |
static Endpoint * | s_instance |
Additional Inherited Members | |
Properties inherited from QObject | |
objectName | |
Network protocol endpoint.
Contains:
|
protected |
Call this when learning about a new object <-> address mapping.
|
signal |
Emitted when a connection to another endpoint was successfully established and passed the protocol version handshake step.
|
signal |
Emitted when we lost the connection to the other endpoint.
|
protected |
Calls the message handler registered for the receiver of msg
.
|
protectedvirtual |
Sends a given message.
|
protected |
The object address of the other endpoint.
|
protectedpure virtual |
Called when the current handler of the object identified by objectAddress
has been destroyed.
|
static |
Singleton accessor.
|
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.
|
protected |
Invoke method
on object
with the given args
.
This is invokes the method directly on the local object.
|
static |
Returns true
if we are currently connected to another endpoint.
|
pure virtual |
Returns true for remote clients and false for the in-probe server endpoint.
QString GammaRay::Endpoint::key | ( | ) | const |
Returns a fixed string uniquely describing the host program.
QString GammaRay::Endpoint::label | ( | ) | const |
Returns a human-readable string describing the host program.
|
protectedpure virtual |
Called for every incoming message.
Protocol::ObjectAddress GammaRay::Endpoint::objectAddress | ( | const QString & | objectName | ) | const |
Returns the object address for objectName
, or Protocol::InvalidObjectAddress
if not known.
|
protected |
All current object name/address pairs.
|
protectedpure virtual |
Called when a registered object identified by objectAddress
has been destroyed.
|
signal |
Emitted when a new object with name objectName
has been registered at address objectAddress
.
|
virtual |
Register the slot messageHandlerName
on receiver
as the handler for messages to/from objectAddress
.
|
virtual |
Register an object of the given name for transparent server/client communication.
|
protected |
Call this when learning about a dissolved object <-> address mapping.
|
static |
Send msg
to the connected endpoint.
|
slot |
Convenience overload of send(), to directly send message delivered via signals.
|
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).
|
protected |
Call with the socket once you have established a connection to another endpoint, takes ownership of device
.
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.
|
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.
|
staticprotected |
Singleton instance.