source: trunk/src/dbus/qdbuspendingreply.cpp@ 168

Last change on this file since 168 was 2, checked in by Dmitry A. Kuminov, 16 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.
File size: 9.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtDBus module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include "qdbuspendingreply.h"
43#include "qdbuspendingcall_p.h"
44#include "qdbusmetatype.h"
45
46/*!
47 \class QDBusPendingReply
48 \inmodule QtDBus
49 \since 4.5
50
51 \brief The QDBusPendingReply class contains the reply to an asynchronous method call
52
53 The QDBusPendingReply is a template class with up to 8 template
54 parameters. Those parameters are the types that will be used to
55 extract the contents of the reply's data.
56
57 This class is similar in functionality to QDBusReply, but with two
58 important differences:
59
60 \list
61 \o QDBusReply accepts exactly one return type, whereas
62 QDBusPendingReply can have from 1 to 8 types
63 \o QDBusReply only works on already completed replies, whereas
64 QDBusPendingReply allows one to wait for replies from pending
65 calls
66 \endlist
67
68 Where with QDBusReply you would write:
69
70 \snippet doc/src/snippets/code/src_qdbus_qdbusreply.cpp 0
71
72 with QDBusPendingReply, the equivalent code (including the blocking
73 wait for the reply) would be:
74
75 \snippet doc/src/snippets/code/src.qdbus.qdbuspendingreply.cpp 0
76
77 For method calls that have more than one output argument, with
78 QDBusReply, you would write:
79
80 \snippet doc/src/snippets/code/src_qdbus_qdbusreply.cpp 1
81
82 whereas with QDBusPendingReply, all of the output arguments should
83 be template parameters:
84
85 \snippet doc/src/snippets/code/src.qdbus.qdbuspendingreply.cpp 2
86
87 QDBusPendingReply objects can be associated with
88 QDBusPendingCallWatcher objects, which emit signals when the reply
89 arrives.
90
91 \sa QDBusPendingCallWatcher, QDBusReply,
92 QDBusAbstractInterface::asyncCall()
93*/
94
95/*!
96 \fn QDBusPendingReply::QDBusPendingReply()
97
98 Creates an empty QDBusPendingReply object. Without assigning a
99 QDBusPendingCall object to this reply, QDBusPendingReply cannot do
100 anything. All functions return their failure values.
101*/
102
103/*!
104 \fn QDBusPendingReply::QDBusPendingReply(const QDBusPendingReply &other)
105
106 Creates a copy of the \a other QDBusPendingReply object. Just like
107 QDBusPendingCall and QDBusPendingCallWatcher, this QDBusPendingReply
108 object will share the same pending call reference. All copies
109 share the same return values.
110*/
111
112/*!
113 \fn QDBusPendingReply::QDBusPendingReply(const QDBusPendingCall &call)
114
115 Creates a QDBusPendingReply object that will take its contents from
116 the \a call pending asynchronous call. This QDBusPendingReply object
117 will share the same pending call reference as \a call.
118*/
119
120/*!
121 \fn QDBusPendingReply::QDBusPendingReply(const QDBusMessage &message)
122
123 Creates a QDBusPendingReply object that will take its contents from
124 the message \a message. In this case, this object will be already
125 in its finished state and the reply's contents will be accessible.
126
127 \sa isFinished()
128*/
129
130/*!
131 \fn QDBusPendingReply &QDBusPendingReply::operator=(const QDBusPendingReply &other)
132
133 Makes a copy of \a other and drops the reference to the current
134 pending call. If the current reference is to an unfinished pending