QRemoteObjectReplica#

A class interacting with (but not implementing) a Qt API on the Remote Object network. More…

Inherited by: QRemoteObjectRegistry, QRemoteObjectDynamicReplica

Synopsis#

Properties#

node - A pointer to the node this object was acquired from
state - Returns the replica state

Functions#

def initializeNode (node[, name=””])
def isInitialized ()
def isReplicaValid ()
def node ()
def persistProperties (repName, repSig, props)
def propAsVariant (i)
def retrieveProperties (repName, repSig)
def send (call, index, args)
def sendWithReply (call, index, args)
def setChild (i, arg__2)
def state ()
def waitForSource ([timeout=30000])

Virtual functions#

def initialize ()
def setNode (node)

Signals#

def initialized ()
def notified ()
def stateChanged (state, oldState)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

A Remote Object Replica is a QObject proxy for another QObject (called the Source object). Once initialized, a replica can be considered a “latent copy” of the Source object. That is, every change to a Q_PROPERTY on the Source , or signal emitted by the Source will be updated/emitted by all Replica objects. Latency is introduced by process scheduling by any OSes involved and network communication latency. As long as the replica has been initialized and the communication is not disrupted, receipt and order of changes is guaranteed.

The isInitialized and state properties (and corresponding initialized() / stateChanged() signals) allow the state of a Replica to be determined.

While Qt Remote Objects (QtRO) handles the initialization and synchronization of Replica objects, there are numerous steps happening behind the scenes which can fail and that aren’t encountered in single process Qt applications. See Troubleshooting for advice on how to handle such issues when using a remote objects network.

class PySide6.QtRemoteObjects.QRemoteObjectReplica#

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.QtRemoteObjects.QRemoteObjectReplica.node: PySide6.QtRemoteObjects.QRemoteObjectNode#

This property holds A pointer to the node this object was acquired from..

Access functions:

node ()
setNode (node)

property PᅟySide6.QtRemoteObjects.QRemoteObjectReplica.state: State#

This property holds Returns the replica state..

This property holds the replica State .

Access functions:

state ()
Signal stateChanged (state, oldState)

PySide6.QtRemoteObjects.QRemoteObjectReplica.State#

This enum type specifies the various state codes associated with QRemoteObjectReplica states:

Constant

Description

QRemoteObjectReplica.Uninitialized

Initial value of DynamicReplica, where nothing is known about the replica before connection to source.

QRemoteObjectReplica.Default

Initial value of static replica, where any defaults set in the .rep file are available so it can be used if necessary.

QRemoteObjectReplica.Valid

Indicates the replica is connected, has good property values and can be interacted with.

QRemoteObjectReplica.Suspect

Error state that occurs if the connection to the source is lost after it is initialized.

QRemoteObjectReplica.SignatureMismatch

Error state that occurs if a connection to the source is made, but the source and replica are not derived from the same .rep (only possible for static Replicas).

Constant	Description
QRemoteObjectReplica.Uninitialized	Initial value of DynamicReplica, where nothing is known about the replica before connection to source.
QRemoteObjectReplica.Default	Initial value of static replica, where any defaults set in the .rep file are available so it can be used if necessary.
QRemoteObjectReplica.Valid	Indicates the replica is connected, has good property values and can be interacted with.
QRemoteObjectReplica.Suspect	Error state that occurs if the connection to the source is lost after it is initialized.
QRemoteObjectReplica.SignatureMismatch	Error state that occurs if a connection to the source is made, but the source and replica are not derived from the same .rep (only possible for static Replicas).

PySide6.QtRemoteObjects.QRemoteObjectReplica.initialize()#

PySide6.QtRemoteObjects.QRemoteObjectReplica.initializeNode(node[, name=""])#

Parameters:

node – PySide6.QtRemoteObjects.QRemoteObjectNode
name – str

PySide6.QtRemoteObjects.QRemoteObjectReplica.initialized()#

This signal is emitted once the replica is initialized. An intialized replica has all property values set, but has not yet emitted any property change notifications.

See also

isInitialized() stateChanged()

PySide6.QtRemoteObjects.QRemoteObjectReplica.isInitialized()#

Return type:: bool

Returns true if this replica has been initialized with data from the Source object. Returns false otherwise.

See also

state()

PySide6.QtRemoteObjects.QRemoteObjectReplica.isReplicaValid()#

Return type:: bool

Returns true if this replica has been initialized and has a valid connection with the node hosting the Source . Returns false otherwise.

See also

isInitialized()

PySide6.QtRemoteObjects.QRemoteObjectReplica.node()#

Return type:: PySide6.QtRemoteObjects.QRemoteObjectNode