/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSURLConnection.gsdoc is in gnustep-base-doc 1.25.1-2ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | <?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="NSURLConnection" up="Base">
<head>
<title>NSURLConnection class documentation</title>
<author name="Generated by Debian"></author>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the NSURLConnection class
</heading>
<class name="NSURLConnection" super="NSObject" ovadd="10.2.0" gvadd="1.13.0">
<declared>Foundation/NSURLConnection.h</declared>
<desc>
<em>Description forthcoming.</em>
</desc>
<ivariable type="void*" name="_NSURLConnectionInternal" validity="protected" ovadd="10.2.0" gvadd="1.13.0">
<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.
</desc>
</ivariable>
<method type="BOOL" factory="yes" ovadd="10.2.0" gvadd="1.13.0">
<sel>canHandleRequest:</sel>
<arg type="NSURLRequest*">request</arg>
<desc>
Performs a preliminary check to see if a load of
the specified <var>request</var> can be handled by an
instance of this class. <br /> The results of this
method may be invalidated by subsequent changes to
the <var>request</var> or changes to the registered
protocols etc.
</desc>
</method>
<method type="NSURLConnection*" factory="yes" ovadd="10.2.0" gvadd="1.13.0">
<sel>connectionWithRequest:</sel>
<arg type="NSURLRequest*">request</arg>
<sel>delegate:</sel>
<arg type="id">delegate</arg>
<desc>
Allocates and returns the autoreleased instance
which it initialises using the
<ref type="method" id="-initWithRequest:delegate:">
-initWithRequest:delegate:
</ref>
method.
</desc>
</method>
<method type="void" ovadd="10.2.0" gvadd="1.13.0">
<sel>cancel</sel>
<desc>
Cancel the asynchronous load in progress (if any)
for this connection.
</desc>
</method>
<method type="id" init="yes" ovadd="10.2.0" gvadd="1.13.0">
<sel>initWithRequest:</sel>
<arg type="NSURLRequest*">request</arg>
<sel>delegate:</sel>
<arg type="id">delegate</arg>
<desc>
Initialises the receiver with the specified
<var>request</var> (performing a deep copy so that
the <var>request</var> does not change during loading)
and <var>delegate</var>. <br /> This automatically
initiates an asynchronous load for the
<var>request</var>. <br /> Processing of the
<var>request</var> is done in the thread which calls
this method, so the thread must run its current run
loop (in NSDefaultRunLoopMode) for processing to
continue/complete. <br /> The
<var>delegate</var> will receive callbacks informing
it of the progress of the load. <br /> This method
breaks with convention and retains the
<var>delegate</var> object, releasing it when the
connection finished loading, fails, or is
cancelled.
</desc>
</method>
</class>
</chapter>
<chapter>
<heading>
Software documentation for the
NSObject(NSURLConnectionDelegate)
category
</heading>
<category name="NSURLConnectionDelegate" class="NSObject" ovadd="10.7.0" gvadd="1.13.0">
<declared>Foundation/NSURLConnection.h</declared>
<desc>
<em>Description forthcoming.</em>
</desc>
<method type="void" ovadd="10.2.0" gvadd="1.13.0">
<sel>connection:</sel>
<arg type="NSURLConnection*">connection</arg>
<sel>didFailWithError:</sel>
<arg type="NSError*">error</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="void" ovadd="10.2.0" gvadd="1.13.0">
<sel>connection:</sel>
<arg type="NSURLConnection*">connection</arg>
<sel>didReceiveAuthenticationChallenge:</sel>
<arg type="NSURLAuthenticationChallenge*">challenge</arg>
<desc>
Called when an authentication <var>challenge</var>
is received... the delegate should send
<ref type="method" id="-useCredential:forAuthenticationChallenge:">-useCredential:forAuthenticationChallenge:</ref> or <ref type="method" id="-continueWithoutCredentialForAuthenticationChallenge:">-continueWithoutCredentialForAuthenticationChallenge:</ref> or <ref type="method" id="-cancelAuthenticationChallenge:">-cancelAuthenticationChallenge:</ref> to the <var>challenge</var> sender when done.
</desc>
</method>
<method type="void" ovadd="10.2.0" gvadd="1.13.0">
<sel>connection:</sel>
<arg type="NSURLConnection*">connection</arg>
<sel>didReceiveData:</sel>
<arg type="NSData*">data</arg>
<desc>
Called when content <var>data</var> arrives during a
load operations... this may be incremental or may be
the compolete <var>data</var> for the load.
</desc>
</method>
<method type="void" ovadd="10.2.0" gvadd="1.13.0">
<sel>connection:</sel>
<arg type="NSURLConnection*">connection</arg>
<sel>didReceiveResponse:</sel>
<arg type="NSURLResponse*">response</arg>
<desc>
Called when enough information to build a
NSURLResponse object has been received.
</desc>
</method>
<method type="NSCachedURLResponse*" ovadd="10.2.0" gvadd="1.13.0">
<sel>connection:</sel>
<arg type="NSURLConnection*">connection</arg>
<sel>willCacheResponse:</sel>
<arg type="NSCachedURLResponse*">cachedResponse</arg>
<desc>
Called with the <var>cachedResponse</var> to be
stored in the cache. The delegate can inspect the
<var>cachedResponse</var> and return a modified copy
if if wants changed to what whill be stored. <br /> If
it returns <code>nil</code>, nothing will be stored in
the cache.
</desc>
</method>
<method type="NSURLRequest*" ovadd="10.2.0" gvadd="1.13.0">
<sel>connection:</sel>
<arg type="NSURLConnection*">connection</arg>
<sel>willSendRequest:</sel>
<arg type="NSURLRequest*">request</arg>
<sel>redirectResponse:</sel>
<arg type="NSURLResponse*">response</arg>
<desc>
Informs the delegate that the <var>connection</var>
must change the URL of the <var>request</var> in order
to continue with the load operation. <br /> This allows
the delegate to ionspect and/or modify a copy of the
<var>request</var> before the <var>connection</var>
continues loading it. Normally the delegate can
return the <var>request</var> unmodifield. <br />
The redirection can be rejectected by the delegate
calling
<ref type="method" id="-cancel">
-cancel
</ref>
or returning <code>nil</code>. <br /> Cancelling the
load will simply stop it, but returning
<code>nil</code> will cause it to complete with a
redirection failure. <br /> As a special case,
this method may be called with a <code>nil</code>
<var>response</var>, indicating a change of URL made
internally by the system rather than due to a
<var>response</var> from the server.
</desc>
</method>
<method type="void" ovadd="10.2.0" gvadd="1.13.0">
<sel>connectionDidFinishLoading:</sel>
<arg type="NSURLConnection*">connection</arg>
<desc>
Called when an NSURLConnection has finished loading
successfully.
</desc>
</method>
</category>
</chapter>
<chapter>
<heading>
Software documentation for the
NSURLConnection(NSURLConnectionSynchronousLoading)
category
</heading>
<category name="NSURLConnectionSynchronousLoading" class="NSURLConnection" ovadd="10.2.0" gvadd="1.13.0">
<declared>Foundation/NSURLConnection.h</declared>
<desc>
An interface to perform synchronous loading of URL
requests.
</desc>
<method type="NSData*" factory="yes" ovadd="10.2.0" gvadd="1.13.0">
<sel>sendSynchronousRequest:</sel>
<arg type="NSURLRequest*">request</arg>
<sel>returningResponse:</sel>
<arg type="NSURLResponse**">response</arg>
<sel>error:</sel>
<arg type="NSError**">error</arg>
<desc>
Performs a synchronous load of <var>request</var>
and returns the
<ref type="class" id="NSURLResponse">NSURLResponse</ref>
in <var>response</var>. <br /> Returns the result of
the load or <code>nil</code> if the load failed.
</desc>
</method>
</category>
</chapter>
<chapter>
<heading>
Software documentation for the NSURLConnectionDelegate
protocol
</heading>
<protocol name="NSURLConnectionDelegate" ovadd="10.7.0" gvadd="1.13.0">
<declared>Foundation/NSURLConnection.h</declared>
<conform>NSObject</conform>
<desc>
<em>Description forthcoming.</em>
</desc>
</protocol>
</chapter>
</body>
</gsdoc>
|