<?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" /> <!-- qabstractnetworkcache.cpp --> <title>Qt 4.8: QAbstractNetworkCache 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="qtnetwork.html">QtNetwork</a></li> <li>QAbstractNetworkCache</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="#public-slots">Public Slots</a></li> <li class="level1"><a href="#protected-functions">Protected Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">QAbstractNetworkCache Class Reference</h1> <!-- $$$QAbstractNetworkCache-brief --> <p>The QAbstractNetworkCache class provides the interface for cache implementations. <a href="#details">More...</a></p> <!-- @@@QAbstractNetworkCache --> <pre class="cpp"> <span class="preprocessor">#include <QAbstractNetworkCache></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p> <p><b>Inherited by: </b><a href="qnetworkdiskcache.html">QNetworkDiskCache</a>.</p> <p>This class was introduced in Qt 4.5.</p> <ul> <li><a href="qabstractnetworkcache-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"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#dtor.QAbstractNetworkCache">~QAbstractNetworkCache</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual qint64 </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#cacheSize">cacheSize</a></b> () const = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QIODevice * </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#data">data</a></b> ( const QUrl & <i>url</i> ) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#insert">insert</a></b> ( QIODevice * <i>device</i> ) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QNetworkCacheMetaData </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#metaData">metaData</a></b> ( const QUrl & <i>url</i> ) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QIODevice * </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#prepare">prepare</a></b> ( const QNetworkCacheMetaData & <i>metaData</i> ) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#remove">remove</a></b> ( const QUrl & <i>url</i> ) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#updateMetaData">updateMetaData</a></b> ( const QNetworkCacheMetaData & <i>metaData</i> ) = 0</td></tr> </table> <ul> <li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li> </ul> <a name="public-slots"></a> <h2>Public Slots</h2> <table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#clear">clear</a></b> () = 0</td></tr> </table> <ul> <li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li> </ul> <a name="protected-functions"></a> <h2>Protected Functions</h2> <table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractnetworkcache.html#QAbstractNetworkCache">QAbstractNetworkCache</a></b> ( QObject * <i>parent</i> = 0 )</td></tr> </table> <ul> <li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">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 signal inherited from <a href="qobject.html#signals">QObject</a></li> <li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QAbstractNetworkCache-description --> <div class="descr"> <h2>Detailed Description</h2> <p>The QAbstractNetworkCache class provides the interface for cache implementations.</p> <p>QAbstractNetworkCache is the base class for every standard cache that is used be <a href="qnetworkaccessmanager.html">QNetworkAccessManager</a>. QAbstractNetworkCache is an abstract class and cannot be instantiated.</p> </div> <p><b>See also </b><a href="qnetworkdiskcache.html">QNetworkDiskCache</a>.</p> <!-- @@@QAbstractNetworkCache --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QAbstractNetworkCache[overload1]$$$QAbstractNetworkCacheQObject* --> <h3 class="fn"><a name="QAbstractNetworkCache"></a>QAbstractNetworkCache::<span class="name">QAbstractNetworkCache</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )<tt> [protected]</tt></h3> <p>Constructs an abstract network cache with the given <i>parent</i>.</p> <!-- @@@QAbstractNetworkCache --> <!-- $$$~QAbstractNetworkCache[overload1]$$$~QAbstractNetworkCache --> <h3 class="fn"><a name="dtor.QAbstractNetworkCache"></a>QAbstractNetworkCache::<span class="name">~QAbstractNetworkCache</span> ()<tt> [virtual]</tt></h3> <p>Destroys the cache.</p> <p>Any operations that have not been inserted are discarded.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#insert">insert</a>().</p> <!-- @@@~QAbstractNetworkCache --> <!-- $$$cacheSize[overload1]$$$cacheSize --> <h3 class="fn"><a name="cacheSize"></a><span class="type"><a href="qtglobal.html#qint64-typedef">qint64</a></span> QAbstractNetworkCache::<span class="name">cacheSize</span> () const<tt> [pure virtual]</tt></h3> <p>Returns the current size taken up by the cache. Depending upon the cache implementation this might be disk or memory size.</p> <p>In the base class this is a pure virtual function.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#clear">clear</a>().</p> <!-- @@@cacheSize --> <!-- $$$clear[overload1]$$$clear --> <h3 class="fn"><a name="clear"></a><span class="type">void</span> QAbstractNetworkCache::<span class="name">clear</span> ()<tt> [pure virtual slot]</tt></h3> <p>Removes all items from the cache. Unless there was failures clearing the cache <a href="qabstractnetworkcache.html#cacheSize">cacheSize</a>() should return 0 after a call to clear.</p> <p>In the base class this is a pure virtual function.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#cacheSize">cacheSize</a>() and <a href="qabstractnetworkcache.html#remove">remove</a>().</p> <!-- @@@clear --> <!-- $$$data[overload1]$$$dataconstQUrl& --> <h3 class="fn"><a name="data"></a><span class="type"><a href="qiodevice.html">QIODevice</a></span> * QAbstractNetworkCache::<span class="name">data</span> ( const <span class="type"><a href="qurl.html">QUrl</a></span> & <i>url</i> )<tt> [pure virtual]</tt></h3> <p>Returns the data associated with <i>url</i>.</p> <p>It is up to the application that requests the data to delete the <a href="qiodevice.html">QIODevice</a> when done with it.</p> <p>If there is no cache for <i>url</i>, the url is invalid, or if there is an internal cache error 0 is returned.</p> <p>In the base class this is a pure virtual function.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#metaData">metaData</a>() and <a href="qabstractnetworkcache.html#prepare">prepare</a>().</p> <!-- @@@data --> <!-- $$$insert[overload1]$$$insertQIODevice* --> <h3 class="fn"><a name="insert"></a><span class="type">void</span> QAbstractNetworkCache::<span class="name">insert</span> ( <span class="type"><a href="qiodevice.html">QIODevice</a></span> * <i>device</i> )<tt> [pure virtual]</tt></h3> <p>Inserts the data in <i>device</i> and the prepared meta data into the cache. After this function is called the data and meta data should be retrievable using <a href="qabstractnetworkcache.html#data">data</a>() and <a href="qabstractnetworkcache.html#metaData">metaData</a>().</p> <p>To cancel a prepared inserted call <a href="qabstractnetworkcache.html#remove">remove</a>() on the metadata's url.</p> <p>In the base class this is a pure virtual function.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#prepare">prepare</a>() and <a href="qabstractnetworkcache.html#remove">remove</a>().</p> <!-- @@@insert --> <!-- $$$metaData[overload1]$$$metaDataconstQUrl& --> <h3 class="fn"><a name="metaData"></a><span class="type"><a href="qnetworkcachemetadata.html">QNetworkCacheMetaData</a></span> QAbstractNetworkCache::<span class="name">metaData</span> ( const <span class="type"><a href="qurl.html">QUrl</a></span> & <i>url</i> )<tt> [pure virtual]</tt></h3> <p>Returns the meta data for the url <i>url</i>.</p> <p>If the url is valid and the cache contains the data for url, a valid <a href="qnetworkcachemetadata.html">QNetworkCacheMetaData</a> is returned.</p> <p>In the base class this is a pure virtual function.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#updateMetaData">updateMetaData</a>() and <a href="qabstractnetworkcache.html#data">data</a>().</p> <!-- @@@metaData --> <!-- $$$prepare[overload1]$$$prepareconstQNetworkCacheMetaData& --> <h3 class="fn"><a name="prepare"></a><span class="type"><a href="qiodevice.html">QIODevice</a></span> * QAbstractNetworkCache::<span class="name">prepare</span> ( const <span class="type"><a href="qnetworkcachemetadata.html">QNetworkCacheMetaData</a></span> & <i>metaData</i> )<tt> [pure virtual]</tt></h3> <p>Returns the device that should be populated with the data for the cache item <i>metaData</i>. When all of the data has been written <a href="qabstractnetworkcache.html#insert">insert</a>() should be called. If metaData is invalid or the url in the metadata is invalid 0 is returned.</p> <p>The cache owns the device and will take care of deleting it when it is inserted or removed.</p> <p>To cancel a prepared inserted call <a href="qabstractnetworkcache.html#remove">remove</a>() on the metadata's url.</p> <p>In the base class this is a pure virtual function.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#remove">remove</a>(), <a href="qabstractnetworkcache.html#updateMetaData">updateMetaData</a>(), and <a href="qabstractnetworkcache.html#insert">insert</a>().</p> <!-- @@@prepare --> <!-- $$$remove[overload1]$$$removeconstQUrl& --> <h3 class="fn"><a name="remove"></a><span class="type">bool</span> QAbstractNetworkCache::<span class="name">remove</span> ( const <span class="type"><a href="qurl.html">QUrl</a></span> & <i>url</i> )<tt> [pure virtual]</tt></h3> <p>Removes the cache entry for <i>url</i>, returning true if success otherwise false.</p> <p>In the base class this is a pure virtual function.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#clear">clear</a>() and <a href="qabstractnetworkcache.html#prepare">prepare</a>().</p> <!-- @@@remove --> <!-- $$$updateMetaData[overload1]$$$updateMetaDataconstQNetworkCacheMetaData& --> <h3 class="fn"><a name="updateMetaData"></a><span class="type">void</span> QAbstractNetworkCache::<span class="name">updateMetaData</span> ( const <span class="type"><a href="qnetworkcachemetadata.html">QNetworkCacheMetaData</a></span> & <i>metaData</i> )<tt> [pure virtual]</tt></h3> <p>Updates the cache meta date for the metaData's url to <i>metaData</i></p> <p>If the cache does not contains a cache item for the url then no action is taken.</p> <p>In the base class this is a pure virtual function.</p> <p><b>See also </b><a href="qabstractnetworkcache.html#metaData">metaData</a>() and <a href="qabstractnetworkcache.html#prepare">prepare</a>().</p> <!-- @@@updateMetaData --> </div> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd. 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> Qt and respective logos are trademarks of The Qt Company Ltd 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>