Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/share/doc/gnustep-base-doc/Base/Reference/
Upload File :
Current File : //usr/share/doc/gnustep-base-doc/Base/Reference/NSURLCache.html
<!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" lang="en">
<head>
<title>NSURLCache documentation</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSURLCache">NSURLCache documentation</a></h1>
<h3>Authors</h3>
<dl>
<dt>Generated by Debian</dt>
<dd>
</dd>
</dl>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the NSCachedURLResponse
class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the NSURLCache class</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the NSCachedURLResponse
class
</a></h1>
<h2><a name="class$NSCachedURLResponse">NSCachedURLResponse</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSURLCache.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd><a rel="gsdoc" href="NSObject.html#protocol$(NSCoding)">NSCoding</a></dd>
<dd><a rel="gsdoc" href="NSObject.html#protocol$(NSCopying)">NSCopying</a></dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Encapsulates a cached response to a URL load
request.
</div>
<hr width="50%" align="left" />
<a href="#_NSCachedURLResponse_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSCachedURLResponse-data">-data</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSCachedURLResponse-initWithResponse$data$">-initWithResponse:data:</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSCachedURLResponse-initWithResponse$data$userInfo$storagePolicy$">-initWithResponse:data:userInfo:storagePolicy:</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSCachedURLResponse-response">-response</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSCachedURLResponse-storagePolicy">-storagePolicy</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSCachedURLResponse-userInfo">-userInfo</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSCachedURLResponse-data">data </a></h3>
- (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>data</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the data with which the receiver was
initialised.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCachedURLResponse-initWithResponse$data$">initWithResponse: data: </a></h3>
- (id) <b>initWithResponse:</b> (<a rel="gsdoc" href="NSURLResponse.html#class$NSURLResponse">NSURLResponse</a>*)response<b> data:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Uses the NSURLCacheStorageAllowed policy to cache the
specified <var>response</var> and <var>data</var>
. <br /> Returns the cached <var>response</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCachedURLResponse-initWithResponse$data$userInfo$storagePolicy$">initWithResponse: data: userInfo: storagePolicy: </a></h3>
- (id) <b>initWithResponse:</b> (<a rel="gsdoc" href="NSURLResponse.html#class$NSURLResponse">NSURLResponse</a>*)response<b> data:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data<b> userInfo:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)userInfo<b> storagePolicy:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSURLCacheStoragePolicy">NSURLCacheStoragePolicy</a>)storagePolicy;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the receiver initialized with the provided
parameters.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCachedURLResponse-response">response </a></h3>
- (<a rel="gsdoc" href="NSURLResponse.html#class$NSURLResponse">NSURLResponse</a>*) <b>response</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the response with which the receiver was
initialised.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCachedURLResponse-storagePolicy">storagePolicy </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSURLCacheStoragePolicy">NSURLCacheStoragePolicy</a>) <b>storagePolicy</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the storage policy with which the receiver
was initialised.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCachedURLResponse-userInfo">userInfo </a></h3>
- (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*) <b>userInfo</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the user info dictionary with which the
receiver was initialised (if any).
</div>
<hr width="25%" align="left" />
</div>
<a name="_NSCachedURLResponse_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for NSCachedURLResponse Class</h2>
<h3><a name="ivariable$NSCachedURLResponse*_NSCachedURLResponseInternal">_NSCachedURLResponseInternal</a></h3>
@protected void* <b>_NSCachedURLResponseInternal</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="002000000000">
Software documentation for the NSURLCache class
</a></h1>
<h2><a name="class$NSURLCache">NSURLCache</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSURLCache.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="50%" align="left" />
<a href="#_NSURLCache_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache+setSharedURLCache$">+setSharedURLCache:</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache+sharedURLCache">+sharedURLCache</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-cachedResponseForRequest$">-cachedResponseForRequest:</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-currentDiskUsage">-currentDiskUsage</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-currentMemoryUsage">-currentMemoryUsage</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-diskCapacity">-diskCapacity</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-initWithMemoryCapacity$diskCapacity$diskPath$">-initWithMemoryCapacity:diskCapacity:diskPath:</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-memoryCapacity">-memoryCapacity</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-removeAllCachedResponses">-removeAllCachedResponses</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-removeCachedResponseForRequest$">-removeCachedResponseForRequest:</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-setDiskCapacity$">-setDiskCapacity:</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-setMemoryCapacity$">-setMemoryCapacity:</a></li>
<li><a rel="gsdoc" href="NSURLCache.html#method$NSURLCache-storeCachedResponse$forRequest$">-storeCachedResponse:forRequest:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSURLCache+setSharedURLCache$">setSharedURLCache: </a></h3>
+ (void) <b>setSharedURLCache:</b> (<a rel="gsdoc" href="#class$NSURLCache">NSURLCache</a>*)cache;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Sets the shared
<a rel="gsdoc" href="#class$NSURLCache">NSURLCache</a>
used throughout the process. <br /> If you are going
to call this method to specify an alternative to the
default <var>cache</var>, you should do so before
the shared <var>cache</var> is used in order to avoid
loss of data that was in the old <var>cache</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache+sharedURLCache">sharedURLCache </a></h3>
+ (<a rel="gsdoc" href="#class$NSURLCache">NSURLCache</a>*) <b>sharedURLCache</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the shared cache instance set by
<a rel="gsdoc" href="#method$NSURLCache+setSharedURLCache$">
+setSharedURLCache:
</a>
or, if none has been set, returns an instance
initialised with <br />
<dl>
<dt>Memory capacity</dt>
<dd>
4 megabytes
</dd>
<dt>Disk capacity</dt>
<dd>
20 megabytes
</dd>
<dt>Disk path</dt>
<dd>
user-library-path/Caches/current-app-name
</dd>
</dl>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-cachedResponseForRequest$">cachedResponseForRequest: </a></h3>
- (<a rel="gsdoc" href="#class$NSCachedURLResponse">NSCachedURLResponse</a>*) <b>cachedResponseForRequest:</b> (<a rel="gsdoc" href="NSURLRequest.html#class$NSURLRequest">NSURLRequest</a>*)request;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the
<a rel="gsdoc" href="#class$NSCachedURLResponse">NSCachedURLResponse</a>
cached for the specified <var>request</var> or
<code>nil</code> if there is no matching response
in tthe cache.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-currentDiskUsage">currentDiskUsage </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>currentDiskUsage</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the current size (butes) of the data stored
in the on-disk cache.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-currentMemoryUsage">currentMemoryUsage </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>currentMemoryUsage</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the current size (butes) of the data stored
in the in-memory cache.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-diskCapacity">diskCapacity </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>diskCapacity</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the disk capacity (in bytes) of the cache.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-initWithMemoryCapacity$diskCapacity$diskPath$">initWithMemoryCapacity: diskCapacity: diskPath: </a></h3>
- (id) <b>initWithMemoryCapacity:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)memoryCapacity<b> diskCapacity:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)diskCapacity<b> diskPath:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)path;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the receiver initialised with the specified
capacities (in bytes) and using the specified
location on disk for persistent storage.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-memoryCapacity">memoryCapacity </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>memoryCapacity</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Returns the memory capacity (in bytes) of the
cache.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-removeAllCachedResponses">removeAllCachedResponses </a></h3>
- (void) <b>removeAllCachedResponses</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Empties the cache.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-removeCachedResponseForRequest$">removeCachedResponseForRequest: </a></h3>
- (void) <b>removeCachedResponseForRequest:</b> (<a rel="gsdoc" href="NSURLRequest.html#class$NSURLRequest">NSURLRequest</a>*)request;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Removes from the cache (if present) the
<a rel="gsdoc" href="#class$NSCachedURLResponse">NSCachedURLResponse</a>
which was stored using the specified
<var>request</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-setDiskCapacity$">setDiskCapacity: </a></h3>
- (void) <b>setDiskCapacity:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)diskCapacity;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Sets the disk capacity (in bytes) truncating cache
contents if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-setMemoryCapacity$">setMemoryCapacity: </a></h3>
- (void) <b>setMemoryCapacity:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)memoryCapacity;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Sets the memory capacity (in bytes) truncating cache
contents if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLCache-storeCachedResponse$forRequest$">storeCachedResponse: forRequest: </a></h3>
- (void) <b>storeCachedResponse:</b> (<a rel="gsdoc" href="#class$NSCachedURLResponse">NSCachedURLResponse</a>*)cachedResponse<b> forRequest:</b> (<a rel="gsdoc" href="NSURLRequest.html#class$NSURLRequest">NSURLRequest</a>*)request;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
Stores <var>cachedResponse</var> in the cache, keyed
on <var>request</var>. <br /> Replaces any existing
response with the same key.
</div>
<hr width="25%" align="left" />
</div>
<a name="_NSURLCache_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for NSURLCache Class</h2>
<h3><a name="ivariable$NSURLCache*_NSURLCacheInternal">_NSURLCacheInternal</a></h3>
@protected void* <b>_NSURLCacheInternal</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
Server : Apache/2.4.41 (Ubuntu)