summaryrefslogtreecommitdiff
path: root/qt4/TelepathyQt4/ready-object.cpp
blob: a4fa114ea7f0e64e7090d24511a3202fecb41258 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/**
 * This file is part of TelepathyQt4
 *
 * @copyright Copyright (C) 2009 Collabora Ltd. <http://www.collabora.co.uk/>
 * @copyright Copyright (C) 2009 Nokia Corporation
 * @license LGPL 2.1
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#include <TelepathyQt4/ReadyObject>

#include "TelepathyQt4/debug-internal.h"

#include <TelepathyQt4/PendingReady>
#include <TelepathyQt4/ReadinessHelper>

namespace Tp
{

struct TELEPATHY_QT4_NO_EXPORT ReadyObject::Private
{
    Private(ReadyObject *parent, RefCounted *object, Feature featureCore);
    Private(ReadyObject *parent, DBusProxy *proxy, Feature featureCore);
    ~Private();

    ReadyObject *parent;
    const Features coreFeatures;
    ReadinessHelper *readinessHelper;
};

ReadyObject::Private::Private(ReadyObject *parent, RefCounted *object,
        Feature featureCore)
    : parent(parent),
      coreFeatures(Features() << featureCore),
      readinessHelper(new ReadinessHelper(object))
{
}

ReadyObject::Private::Private(ReadyObject *parent, DBusProxy *proxy,
        Feature featureCore)
    : parent(parent),
      coreFeatures(Features() << featureCore),
      readinessHelper(new ReadinessHelper(proxy))
{
}

ReadyObject::Private::~Private()
{
    delete readinessHelper;
}

/**
 * \class ReadyObject
 * \ingroup clientreadiness
 * \headerfile TelepathyQt4/ready-object.h> <TelepathyQt4/ReadyObject>
 */

/**
 * Construct a new ReadyObject object.
 *
 * \param object The RefCounted the object refers to.
 * \param featureCore The core feature of the object.
 */
ReadyObject::ReadyObject(RefCounted *object, const Feature &featureCore)
    : mPriv(new Private(this, object, featureCore))
{
}

/**
 * Construct a new ReadyObject object.
 *
 * \param proxy The DBusProxy the object refers to.
 * \param featureCore The core feature of the object.
 */
ReadyObject::ReadyObject(DBusProxy *proxy, const Feature &featureCore)
    : mPriv(new Private(this, proxy, featureCore))
{
}

/**
 * Class destructor.
 */
ReadyObject::~ReadyObject()
{
    delete mPriv;
}

/**
 * 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.
 *
 * \param features The features which should be tested
 * \return \c true if the object has finished its initial setup for basic
 *         functionality plus the given features
 */
bool ReadyObject::isReady(const Features &features) const
{
    if (features.isEmpty()) {
        return mPriv->readinessHelper->isReady(mPriv->coreFeatures);
    }
    return mPriv->readinessHelper->isReady(features);
}

/**
 * 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.
 *
 * \param requestedFeatures The features which should be enabled
 * \return A PendingReady object which will emit finished
 *         when this object has finished or failed initial setup for basic
 *         functionality plus the given features
 */
PendingReady *ReadyObject::becomeReady(const Features &requestedFeatures)
{
    if (requestedFeatures.isEmpty()) {
        return mPriv->readinessHelper->becomeReady(mPriv->coreFeatures);
    }
    return mPriv->readinessHelper->becomeReady(requestedFeatures);
}

Features ReadyObject::requestedFeatures() const
{
    return mPriv->readinessHelper->requestedFeatures();
}

Features ReadyObject::actualFeatures() const
{
    return mPriv->readinessHelper->actualFeatures();
}

Features ReadyObject::missingFeatures() const
{
    return mPriv->readinessHelper->missingFeatures();
}

ReadinessHelper *ReadyObject::readinessHelper() const
{
    return mPriv->readinessHelper;
}

} // Tp