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
|
<?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" />
<!-- qnetworkcookiejar.cpp -->
<title>Qt 4.8: QNetworkCookieJar 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="qtnetwork.html">QtNetwork</a></li>
<li>QNetworkCookieJar</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="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QNetworkCookieJar Class Reference</h1>
<!-- $$$QNetworkCookieJar-brief -->
<p>The QNetworkCookieJar class implements a simple jar of <a href="qnetworkcookie.html">QNetworkCookie</a> objects <a href="#details">More...</a></p>
<!-- @@@QNetworkCookieJar -->
<pre class="cpp"> <span class="preprocessor">#include <QNetworkCookieJar></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p>
<p>This class was introduced in Qt 4.4.</p>
<ul>
<li><a href="qnetworkcookiejar-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="qnetworkcookiejar.html#QNetworkCookieJar">QNetworkCookieJar</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qnetworkcookiejar.html#dtor.QNetworkCookieJar">~QNetworkCookieJar</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList<QNetworkCookie> </td><td class="memItemRight bottomAlign"><b><a href="qnetworkcookiejar.html#cookiesForUrl">cookiesForUrl</a></b> ( const QUrl & <i>url</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qnetworkcookiejar.html#setCookiesFromUrl">setCookiesFromUrl</a></b> ( const QList<QNetworkCookie> & <i>cookieList</i>, const QUrl & <i>url</i> )</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QList<QNetworkCookie> </td><td class="memItemRight bottomAlign"><b><a href="qnetworkcookiejar.html#allCookies">allCookies</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qnetworkcookiejar.html#setAllCookies">setAllCookies</a></b> ( const QList<QNetworkCookie> & <i>cookieList</i> )</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 public slot inherited from <a href="qobject.html#public-slots">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>
<!-- $$$QNetworkCookieJar-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QNetworkCookieJar class implements a simple jar of <a href="qnetworkcookie.html">QNetworkCookie</a> objects</p>
<p>Cookies are small bits of information that stateless protocols like HTTP use to maintain some persistent information across requests.</p>
<p>A cookie is set by a remote server when it replies to a request and it expects the same cookie to be sent back when further requests are sent.</p>
<p>The cookie jar is the object that holds all cookies set in previous requests. Web browsers save their cookie jars to disk in order to conserve permanent cookies across invocations of the application.</p>
<p>QNetworkCookieJar does not implement permanent storage: it only keeps the cookies in memory. Once the QNetworkCookieJar object is deleted, all cookies it held will be discarded as well. If you want to save the cookies, you should derive from this class and implement the saving to disk to your own storage format.</p>
<p>This class implements only the basic security recommended by the cookie specifications and does not implement any cookie acceptance policy (it accepts all cookies set by any requests). In order to override those rules, you should reimplement the <a href="qnetworkcookiejar.html#cookiesForUrl">cookiesForUrl</a>() and <a href="qnetworkcookiejar.html#setCookiesFromUrl">setCookiesFromUrl</a>() virtual functions. They are called by <a href="qnetworkreply.html">QNetworkReply</a> and <a href="qnetworkaccessmanager.html">QNetworkAccessManager</a> when they detect new cookies and when they require cookies.</p>
</div>
<p><b>See also </b><a href="qnetworkcookie.html">QNetworkCookie</a>, <a href="qnetworkaccessmanager.html">QNetworkAccessManager</a>, <a href="qnetworkreply.html">QNetworkReply</a>, <a href="qnetworkrequest.html">QNetworkRequest</a>, and <a href="qnetworkaccessmanager.html#setCookieJar">QNetworkAccessManager::setCookieJar</a>().</p>
<!-- @@@QNetworkCookieJar -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QNetworkCookieJar[overload1]$$$QNetworkCookieJarQObject* -->
<h3 class="fn"><a name="QNetworkCookieJar"></a>QNetworkCookieJar::<span class="name">QNetworkCookieJar</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Creates a <a href="qnetworkcookiejar.html">QNetworkCookieJar</a> object and sets the parent object to be <i>parent</i>.</p>
<p>The cookie jar is initialized to empty.</p>
<!-- @@@QNetworkCookieJar -->
<!-- $$$~QNetworkCookieJar[overload1]$$$~QNetworkCookieJar -->
<h3 class="fn"><a name="dtor.QNetworkCookieJar"></a>QNetworkCookieJar::<span class="name">~QNetworkCookieJar</span> ()<tt> [virtual]</tt></h3>
<p>Destroys this cookie jar object and discards all cookies stored in it. Cookies are not saved to disk in the <a href="qnetworkcookiejar.html">QNetworkCookieJar</a> default implementation.</p>
<p>If you need to save the cookies to disk, you have to derive from <a href="qnetworkcookiejar.html">QNetworkCookieJar</a> and save the cookies to disk yourself.</p>
<!-- @@@~QNetworkCookieJar -->
<!-- $$$allCookies[overload1]$$$allCookies -->
<h3 class="fn"><a name="allCookies"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qnetworkcookie.html">QNetworkCookie</a></span>> QNetworkCookieJar::<span class="name">allCookies</span> () const<tt> [protected]</tt></h3>
<p>Returns all cookies stored in this cookie jar. This function is suitable for derived classes to save cookies to disk, as well as to implement cookie expiration and other policies.</p>
<p><b>See also </b><a href="qnetworkcookiejar.html#setAllCookies">setAllCookies</a>() and <a href="qnetworkcookiejar.html#cookiesForUrl">cookiesForUrl</a>().</p>
<!-- @@@allCookies -->
<!-- $$$cookiesForUrl[overload1]$$$cookiesForUrlconstQUrl& -->
<h3 class="fn"><a name="cookiesForUrl"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qnetworkcookie.html">QNetworkCookie</a></span>> QNetworkCookieJar::<span class="name">cookiesForUrl</span> ( const <span class="type"><a href="qurl.html">QUrl</a></span> & <i>url</i> ) const<tt> [virtual]</tt></h3>
<p>Returns the cookies to be added to when a request is sent to <i>url</i>. This function is called by the default <a href="qnetworkaccessmanager.html#createRequest">QNetworkAccessManager::createRequest</a>(), which adds the cookies returned by this function to the request being sent.</p>
<p>If more than one cookie with the same name is found, but with differing paths, the one with longer path is returned before the one with shorter path. In other words, this function returns cookies sorted decreasingly by path length.</p>
<p>The default <a href="qnetworkcookiejar.html">QNetworkCookieJar</a> class implements only a very basic security policy (it makes sure that the cookies' domain and path match the reply's). To enhance the security policy with your own algorithms, override cookiesForUrl().</p>
<p><b>See also </b><a href="qnetworkcookiejar.html#setCookiesFromUrl">setCookiesFromUrl</a>() and <a href="qnetworkaccessmanager.html#setCookieJar">QNetworkAccessManager::setCookieJar</a>().</p>
<!-- @@@cookiesForUrl -->
<!-- $$$setAllCookies[overload1]$$$setAllCookiesconstQList<QNetworkCookie>& -->
<h3 class="fn"><a name="setAllCookies"></a><span class="type">void</span> QNetworkCookieJar::<span class="name">setAllCookies</span> ( const <span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qnetworkcookie.html">QNetworkCookie</a></span>> & <i>cookieList</i> )<tt> [protected]</tt></h3>
<p>Sets the internal list of cookies held by this cookie jar to be <i>cookieList</i>. This function is suitable for derived classes to implement loading cookies from permanent storage, or their own cookie acceptance policies by reimplementing <a href="qnetworkcookiejar.html#setCookiesFromUrl">setCookiesFromUrl</a>().</p>
<p><b>See also </b><a href="qnetworkcookiejar.html#allCookies">allCookies</a>() and <a href="qnetworkcookiejar.html#setCookiesFromUrl">setCookiesFromUrl</a>().</p>
<!-- @@@setAllCookies -->
<!-- $$$setCookiesFromUrl[overload1]$$$setCookiesFromUrlconstQList<QNetworkCookie>&constQUrl& -->
<h3 class="fn"><a name="setCookiesFromUrl"></a><span class="type">bool</span> QNetworkCookieJar::<span class="name">setCookiesFromUrl</span> ( const <span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qnetworkcookie.html">QNetworkCookie</a></span>> & <i>cookieList</i>, const <span class="type"><a href="qurl.html">QUrl</a></span> & <i>url</i> )<tt> [virtual]</tt></h3>
<p>Adds the cookies in the list <i>cookieList</i> to this cookie jar. Default values for path and domain are taken from the <i>url</i> object.</p>
<p>Returns true if one or more cookies are set for <i>url</i>, otherwise false.</p>
<p>If a cookie already exists in the cookie jar, it will be overridden by those in <i>cookieList</i>.</p>
<p>The default <a href="qnetworkcookiejar.html">QNetworkCookieJar</a> class implements only a very basic security policy (it makes sure that the cookies' domain and path match the reply's). To enhance the security policy with your own algorithms, override setCookiesFromUrl().</p>
<p>Also, <a href="qnetworkcookiejar.html">QNetworkCookieJar</a> does not have a maximum cookie jar size. Reimplement this function to discard older cookies to create room for new ones.</p>
<p><b>See also </b><a href="qnetworkcookiejar.html#cookiesForUrl">cookiesForUrl</a>() and <a href="qnetworkaccessmanager.html#setCookieJar">QNetworkAccessManager::setCookieJar</a>().</p>
<!-- @@@setCookiesFromUrl -->
</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>
|
