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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdbuspendingcall.cpp -->
<title>Qt 4.8: QDBusPendingCallWatcher Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtdbus.html">QtDBus</a></li>
<li>QDBusPendingCallWatcher</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QDBusPendingCallWatcher Class Reference</h1>
<!-- $$$QDBusPendingCallWatcher-brief -->
<p>The QDBusPendingCallWatcher class provides a convenient way for waiting for asynchronous replies <a href="#details">More...</a></p>
<!-- @@@QDBusPendingCallWatcher -->
<pre class="cpp"> <span class="preprocessor">#include <QDBusPendingCallWatcher></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a> and <a href="qdbuspendingcall.html">QDBusPendingCall</a>.</p>
<p>This class was introduced in Qt 4.5.</p>
<ul>
<li><a href="qdbuspendingcallwatcher-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdbuspendingcallwatcher.html#QDBusPendingCallWatcher">QDBusPendingCallWatcher</a></b> ( const QDBusPendingCall & <i>call</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdbuspendingcallwatcher.html#dtor.QDBusPendingCallWatcher">~QDBusPendingCallWatcher</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdbuspendingcallwatcher.html#isFinished">isFinished</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdbuspendingcallwatcher.html#waitForFinished">waitForFinished</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li class="fn">1 public function inherited from <a href="qdbuspendingcall.html#public-functions">QDBusPendingCall</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdbuspendingcallwatcher.html#finished">finished</a></b> ( QDBusPendingCallWatcher * <i>self</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 static public members inherited from <a href="qdbuspendingcall.html#static-public-members">QDBusPendingCall</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QDBusPendingCallWatcher-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QDBusPendingCallWatcher class provides a convenient way for waiting for asynchronous replies</p>
<p>The QDBusPendingCallWatcher provides the <a href="qdbuspendingcallwatcher.html#finished">finished</a>() signal that will be emitted when a reply arrives.</p>
<p>It is usually used like the following example:</p>
<pre class="cpp"> <span class="type"><a href="qdbuspendingcall.html">QDBusPendingCall</a></span> async <span class="operator">=</span> iface<span class="operator">-</span><span class="operator">></span>asyncCall(<span class="string">"RemoteMethod"</span><span class="operator">,</span> value1<span class="operator">,</span> value2);
<span class="type">QDBusPendingCallWatcher</span> <span class="operator">*</span>watcher <span class="operator">=</span> <span class="keyword">new</span> <span class="type">QDBusPendingCallWatcher</span>(async<span class="operator">,</span> <span class="keyword">this</span>);
<span class="type"><a href="qobject.html">QObject</a></span><span class="operator">::</span>connect(watcher<span class="operator">,</span> SIGNAL(finished(<span class="type">QDBusPendingCallWatcher</span><span class="operator">*</span>))<span class="operator">,</span>
<span class="keyword">this</span><span class="operator">,</span> SLOT(callFinishedSlot(<span class="type">QDBusPendingCallWatcher</span><span class="operator">*</span>)));</pre>
<p>Note that it is not necessary to keep the original <a href="qdbuspendingcall.html">QDBusPendingCall</a> object around since QDBusPendingCallWatcher inherits from that class too.</p>
<p>The slot connected to by the above code could be something similar to the following:</p>
<pre class="cpp"> <span class="type">void</span> MyClass<span class="operator">::</span>callFinishedSlot(<span class="type">QDBusPendingCallWatcher</span> <span class="operator">*</span>call)
{
<span class="type"><a href="qdbuspendingreply.html">QDBusPendingReply</a></span><span class="operator"><</span><span class="type"><a href="qstring.html">QString</a></span><span class="operator">,</span> <span class="type"><a href="qbytearray.html">QByteArray</a></span><span class="operator">></span> reply <span class="operator">=</span> <span class="operator">*</span>call;
<span class="keyword">if</span> (reply<span class="operator">.</span>isError()) {
showError();
} <span class="keyword">else</span> {
<span class="type"><a href="qstring.html">QString</a></span> text <span class="operator">=</span> reply<span class="operator">.</span>argumentAt<span class="operator"><</span><span class="number">0</span><span class="operator">></span>();
<span class="type"><a href="qbytearray.html">QByteArray</a></span> data <span class="operator">=</span> reply<span class="operator">.</span>argumentAt<span class="operator"><</span><span class="number">1</span><span class="operator">></span>();
showReply(text<span class="operator">,</span> data);
}
call<span class="operator">-</span><span class="operator">></span>deleteLater();
}</pre>
<p>Note the use of <a href="qdbuspendingreply.html">QDBusPendingReply</a> to validate the argument types in the reply. If the reply did not contain exactly two arguments (one string and one <a href="qbytearray.html">QByteArray</a>), <a href="qdbuspendingreply.html#isError">QDBusPendingReply::isError</a>() will return true.</p>
</div>
<p><b>See also </b><a href="qdbuspendingreply.html">QDBusPendingReply</a> and <a href="qdbusabstractinterface.html#asyncCall">QDBusAbstractInterface::asyncCall</a>().</p>
<!-- @@@QDBusPendingCallWatcher -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDBusPendingCallWatcher[overload1]$$$QDBusPendingCallWatcherconstQDBusPendingCall&QObject* -->
<h3 class="fn"><a name="QDBusPendingCallWatcher"></a>QDBusPendingCallWatcher::<span class="name">QDBusPendingCallWatcher</span> ( const <span class="type"><a href="qdbuspendingcall.html">QDBusPendingCall</a></span> & <i>call</i>, <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Creates a <a href="qdbuspendingcallwatcher.html">QDBusPendingCallWatcher</a> object to watch for replies on the asynchronous pending call <i>call</i> and sets this object's parent to <i>parent</i>.</p>
<!-- @@@QDBusPendingCallWatcher -->
<!-- $$$~QDBusPendingCallWatcher[overload1]$$$~QDBusPendingCallWatcher -->
<h3 class="fn"><a name="dtor.QDBusPendingCallWatcher"></a>QDBusPendingCallWatcher::<span class="name">~QDBusPendingCallWatcher</span> ()</h3>
<p>Destroys this object. If this <a href="qdbuspendingcallwatcher.html">QDBusPendingCallWatcher</a> object was the last reference to the unfinished pending call, the call will be canceled.</p>
<!-- @@@~QDBusPendingCallWatcher -->
<!-- $$$finished[overload1]$$$finishedQDBusPendingCallWatcher* -->
<h3 class="fn"><a name="finished"></a><span class="type">void</span> QDBusPendingCallWatcher::<span class="name">finished</span> ( <span class="type">QDBusPendingCallWatcher</span> * <i>self</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the pending call has finished and its reply is available. The <i>self</i> parameter is a pointer to the object itself, passed for convenience so that the slot can access the properties and determine the contents of the reply.</p>
<!-- @@@finished -->
<!-- $$$isFinished[overload1]$$$isFinished -->
<h3 class="fn"><a name="isFinished"></a><span class="type">bool</span> QDBusPendingCallWatcher::<span class="name">isFinished</span> () const</h3>
<p>Returns true if the pending call has finished processing and the reply has been received.</p>
<p>Note that this function only changes state if you call <a href="qdbuspendingcallwatcher.html#waitForFinished">waitForFinished</a>() or if an external D-Bus event happens, which in general only happens if you return to the event loop execution.</p>
<p><b>See also </b><a href="qdbuspendingreply.html#isFinished">QDBusPendingReply::isFinished</a>().</p>
<!-- @@@isFinished -->
<!-- $$$waitForFinished[overload1]$$$waitForFinished -->
<h3 class="fn"><a name="waitForFinished"></a><span class="type">void</span> QDBusPendingCallWatcher::<span class="name">waitForFinished</span> ()</h3>
<p>Suspends the execution of the calling thread until the reply is received and processed. After this function returns, <a href="qdbuspendingcallwatcher.html#isFinished">isFinished</a>() should return true, indicating the reply's contents are ready to be processed.</p>
<p><b>See also </b><a href="qdbuspendingreply.html#waitForFinished">QDBusPendingReply::waitForFinished</a>().</p>
<!-- @@@waitForFinished -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
