Home · Modules · All Classes · All Namespaces
Public Member Functions | Protected Member Functions | List of all members
Tp::ReadyObject Class Reference

#include <>>

Inherited by Tp::DBusProxy, Tp::ProfileManager, and Tp::StreamedMediaStream [private].

Public Member Functions

 ReadyObject (RefCounted *object, const Feature &featureCore)
 
 ReadyObject (DBusProxy *proxy, const Feature &featureCore)
 
virtual ~ReadyObject ()
 
virtual bool isReady (const Features &features=Features()) const
 
virtual PendingReadybecomeReady (const Features &requestedFeatures=Features())
 
virtual Features requestedFeatures () const
 
virtual Features actualFeatures () const
 
virtual Features missingFeatures () const
 

Protected Member Functions

ReadinessHelperreadinessHelper () const
 

Detailed Description

<TelepathyQt/ReadyObject>

Constructor & Destructor Documentation

◆ ReadyObject() [1/2]

Tp::ReadyObject::ReadyObject ( RefCounted object,
const Feature featureCore 
)

Construct a new ReadyObject object.

Parameters
objectThe RefCounted the object refers to.
featureCoreThe core feature of the object.

◆ ReadyObject() [2/2]

Tp::ReadyObject::ReadyObject ( DBusProxy proxy,
const Feature featureCore 
)

Construct a new ReadyObject object.

Parameters
proxyThe DBusProxy the object refers to.
featureCoreThe core feature of the object.

◆ ~ReadyObject()

Tp::ReadyObject::~ReadyObject ( )
virtual

Class destructor.

Member Function Documentation

◆ isReady()

bool Tp::ReadyObject::isReady ( const Features features = Features()) const
virtual

Return whether this object has finished its initial setup.

This is mostly useful as a sanity check, in code that shouldn't be run until the object is ready. To wait for the object to be ready, call becomeReady() and connect to the finished signal on the result.

Parameters
featuresThe features which should be tested
Returns
true if the object has finished its initial setup for basic functionality plus the given features

◆ becomeReady()

PendingReady * Tp::ReadyObject::becomeReady ( const Features requestedFeatures = Features())
virtual

Return a pending operation which will succeed when this object finishes its initial setup, or will fail if a fatal error occurs during this initial setup.

If an empty set is used FeatureCore will be considered as the requested feature.

Parameters
requestedFeaturesThe features which should be enabled
Returns
A PendingReady object which will emit finished when this object has finished or failed initial setup for basic functionality plus the given features

◆ requestedFeatures()

Features Tp::ReadyObject::requestedFeatures ( ) const
virtual

◆ actualFeatures()

Features Tp::ReadyObject::actualFeatures ( ) const
virtual

◆ missingFeatures()

Features Tp::ReadyObject::missingFeatures ( ) const
virtual

◆ readinessHelper()

ReadinessHelper * Tp::ReadyObject::readinessHelper ( ) const
protected