<?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" /> <!-- qfuturesynchronizer.cpp --> <title>Qt 4.8: QFutureSynchronizer Class Reference</title> <link rel="stylesheet" type="text/css" href="style/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <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="qtcore.html">QtCore</a></li> <li>QFutureSynchronizer</li> </ul> </div> <div class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></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="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">QFutureSynchronizer Class Reference</h1> <!-- $$$QFutureSynchronizer-brief --> <p>The QFutureSynchronizer class is a convenience class that simplifies <a href="qfuture.html">QFuture</a> synchronization. <a href="#details">More...</a></p> <!-- @@@QFutureSynchronizer --> <pre class="cpp"> <span class="preprocessor">#include <QFutureSynchronizer></span></pre><p>This class was introduced in Qt 4.4.</p> <ul> <li><a href="qfuturesynchronizer-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="qfuturesynchronizer.html#QFutureSynchronizer">QFutureSynchronizer</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#QFutureSynchronizer-2">QFutureSynchronizer</a></b> ( const QFuture<T> & <i>future</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#dtor.QFutureSynchronizer">~QFutureSynchronizer</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#addFuture">addFuture</a></b> ( const QFuture<T> & <i>future</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#cancelOnWait">cancelOnWait</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#clearFutures">clearFutures</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QList<QFuture<T> > </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#futures">futures</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#setCancelOnWait">setCancelOnWait</a></b> ( bool <i>enabled</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#setFuture">setFuture</a></b> ( const QFuture<T> & <i>future</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a></b> ()</td></tr> </table> <a name="details"></a> <!-- $$$QFutureSynchronizer-description --> <div class="descr"> <h2>Detailed Description</h2> <p>The QFutureSynchronizer class is a convenience class that simplifies <a href="qfuture.html">QFuture</a> synchronization.</p> <p>QFutureSynchronizer is a template class that simplifies synchronization of one or more <a href="qfuture.html">QFuture</a> objects. Futures are added using the <a href="qfuturesynchronizer.html#addFuture">addFuture</a>() or <a href="qfuturesynchronizer.html#setFuture">setFuture</a>() functions. The <a href="qfuturesynchronizer.html#futures">futures</a>() function returns a list of futures. Use <a href="qfuturesynchronizer.html#clearFutures">clearFutures</a>() to remove all futures from the QFutureSynchronizer.</p> <p>The <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>() function waits for all futures to finish. The destructor of QFutureSynchronizer calls <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>(), providing an easy way to ensure that all futures have finished before returning from a function:</p> <pre class="cpp"> <span class="type">void</span> someFunction() { <span class="type">QFutureSynchronizer</span><span class="operator"><</span><span class="type">void</span><span class="operator">></span> synchronizer; <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span> synchronizer<span class="operator">.</span>addFuture(<span class="type"><a href="qtconcurrent.html">QtConcurrent</a></span><span class="operator">::</span>run(anotherFunction)); synchronizer<span class="operator">.</span>addFuture(<span class="type"><a href="qtconcurrent.html">QtConcurrent</a></span><span class="operator">::</span>map(list<span class="operator">,</span> mapFunction)); <span class="keyword">return</span>; <span class="comment">// QFutureSynchronizer waits for all futures to finish</span> }</pre> <p>The behavior of <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>() can be changed using the <a href="qfuturesynchronizer.html#setCancelOnWait">setCancelOnWait</a>() function. Calling setCancelOnWait(true) will cause <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>() to cancel all futures before waiting for them to finish. You can query the status of the cancel-on-wait feature using the <a href="qfuturesynchronizer.html#cancelOnWait">cancelOnWait</a>() function.</p> </div> <p><b>See also </b><a href="qfuture.html">QFuture</a>, <a href="qfuturewatcher.html">QFutureWatcher</a>, and <a href="threads-qtconcurrent.html">Qt Concurrent</a>.</p> <!-- @@@QFutureSynchronizer --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QFutureSynchronizer[overload1]$$$QFutureSynchronizer --> <h3 class="fn"><a name="QFutureSynchronizer"></a>QFutureSynchronizer::<span class="name">QFutureSynchronizer</span> ()</h3> <p>Constructs a <a href="qfuturesynchronizer.html">QFutureSynchronizer</a>.</p> <!-- @@@QFutureSynchronizer --> <!-- $$$QFutureSynchronizer$$$QFutureSynchronizerconstQFuture<T>& --> <h3 class="fn"><a name="QFutureSynchronizer-2"></a>QFutureSynchronizer::<span class="name">QFutureSynchronizer</span> ( const <span class="type"><a href="qfuture.html">QFuture</a></span><<span class="type">T</span>> & <i>future</i> )</h3> <p>Constructs a <a href="qfuturesynchronizer.html">QFutureSynchronizer</a> and begins watching <i>future</i> by calling <a href="qfuturesynchronizer.html#addFuture">addFuture</a>().</p> <p><b>See also </b><a href="qfuturesynchronizer.html#addFuture">addFuture</a>().</p> <!-- @@@QFutureSynchronizer --> <!-- $$$~QFutureSynchronizer[overload1]$$$~QFutureSynchronizer --> <h3 class="fn"><a name="dtor.QFutureSynchronizer"></a>QFutureSynchronizer::<span class="name">~QFutureSynchronizer</span> ()</h3> <p>Calls <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>() function to ensure that all futures have finished before destroying this <a href="qfuturesynchronizer.html">QFutureSynchronizer</a>.</p> <p><b>See also </b><a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>().</p> <!-- @@@~QFutureSynchronizer --> <!-- $$$addFuture[overload1]$$$addFutureconstQFuture<T>& --> <h3 class="fn"><a name="addFuture"></a><span class="type">void</span> QFutureSynchronizer::<span class="name">addFuture</span> ( const <span class="type"><a href="qfuture.html">QFuture</a></span><<span class="type">T</span>> & <i>future</i> )</h3> <p>Adds <i>future</i> to the list of managed futures.</p> <p><b>See also </b><a href="qfuturesynchronizer.html#futures">futures</a>().</p> <!-- @@@addFuture --> <!-- $$$cancelOnWait[overload1]$$$cancelOnWait --> <h3 class="fn"><a name="cancelOnWait"></a><span class="type">bool</span> QFutureSynchronizer::<span class="name">cancelOnWait</span> () const</h3> <p>Returns true if the cancel-on-wait feature is enabled; otherwise returns false. If cancel-on-wait is enabled, the <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>() function will cancel all futures before waiting for them to finish.</p> <p><b>See also </b><a href="qfuturesynchronizer.html#setCancelOnWait">setCancelOnWait</a>() and <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>().</p> <!-- @@@cancelOnWait --> <!-- $$$clearFutures[overload1]$$$clearFutures --> <h3 class="fn"><a name="clearFutures"></a><span class="type">void</span> QFutureSynchronizer::<span class="name">clearFutures</span> ()</h3> <p>Removes all managed futures from this <a href="qfuturesynchronizer.html">QFutureSynchronizer</a>.</p> <p><b>See also </b><a href="qfuturesynchronizer.html#addFuture">addFuture</a>() and <a href="qfuturesynchronizer.html#setFuture">setFuture</a>().</p> <!-- @@@clearFutures --> <!-- $$$futures[overload1]$$$futures --> <h3 class="fn"><a name="futures"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qfuture.html">QFuture</a></span><<span class="type">T</span>> > QFutureSynchronizer::<span class="name">futures</span> () const</h3> <p>Returns a list of all managed futures.</p> <p><b>See also </b><a href="qfuturesynchronizer.html#addFuture">addFuture</a>() and <a href="qfuturesynchronizer.html#setFuture">setFuture</a>().</p> <!-- @@@futures --> <!-- $$$setCancelOnWait[overload1]$$$setCancelOnWaitbool --> <h3 class="fn"><a name="setCancelOnWait"></a><span class="type">void</span> QFutureSynchronizer::<span class="name">setCancelOnWait</span> ( <span class="type">bool</span> <i>enabled</i> )</h3> <p>Enables or disables the cancel-on-wait feature based on the <i>enabled</i> argument. If <i>enabled</i> is true, the <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>() function will cancel all futures before waiting for them to finish.</p> <p><b>See also </b><a href="qfuturesynchronizer.html#cancelOnWait">cancelOnWait</a>() and <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>().</p> <!-- @@@setCancelOnWait --> <!-- $$$setFuture[overload1]$$$setFutureconstQFuture<T>& --> <h3 class="fn"><a name="setFuture"></a><span class="type">void</span> QFutureSynchronizer::<span class="name">setFuture</span> ( const <span class="type"><a href="qfuture.html">QFuture</a></span><<span class="type">T</span>> & <i>future</i> )</h3> <p>Sets <i>future</i> to be the only future managed by this <a href="qfuturesynchronizer.html">QFutureSynchronizer</a>. This is a convenience function that calls <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>(), then <a href="qfuturesynchronizer.html#clearFutures">clearFutures</a>(), and finally passes <i>future</i> to <a href="qfuturesynchronizer.html#addFuture">addFuture</a>().</p> <p><b>See also </b><a href="qfuturesynchronizer.html#addFuture">addFuture</a>(), <a href="qfuturesynchronizer.html#waitForFinished">waitForFinished</a>(), and <a href="qfuturesynchronizer.html#clearFutures">clearFutures</a>().</p> <!-- @@@setFuture --> <!-- $$$waitForFinished[overload1]$$$waitForFinished --> <h3 class="fn"><a name="waitForFinished"></a><span class="type">void</span> QFutureSynchronizer::<span class="name">waitForFinished</span> ()</h3> <p>Waits for all futures to finish. If <a href="qfuturesynchronizer.html#cancelOnWait">cancelOnWait</a>() returns true, each future is canceled before waiting for them to finish.</p> <p><b>See also </b><a href="qfuturesynchronizer.html#cancelOnWait">cancelOnWait</a>() and <a href="qfuturesynchronizer.html#setCancelOnWait">setCancelOnWait</a>().</p> <!-- @@@waitForFinished --> </div> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2013 Digia Plc 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> Digia, Qt and their respective logos are trademarks of Digia Plc 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> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>