/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSURLHandle.html is in gnustep-base-doc 1.24.7-1build2.
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 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 | <!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>NSURLHandle class reference</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSURLHandle">NSURLHandle class reference</a></h1>
<h3>Authors</h3>
<dl>
<dt>Manuel Guesdon (<a href="mailto:mguesdon@sbuilders.com"><code>mguesdon@sbuilders.com</code></a>)</dt>
<dd>
</dd>
<dt>Richard Frith-Macdonald (<a href="mailto:rfm@gnu.org"><code>rfm@gnu.org</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Version:</b> 37003</p>
<p><b>Date:</b> 2013-08-22 16:44:54 +0100 (Thu, 22 Aug 2013)</p>
<p><b>Copyright:</b> (C) 1999 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the NSURLHandle class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the NSURLHandleClient
protocol</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the NSURLHandle class
</a></h1>
<h2><a name="class$NSURLHandle">NSURLHandle</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSURLHandle.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
</p>
<p>
An NSURLHandle instance is used to manage the resource
data corresponding to an NSURL object. A single
NSURLHandle can be used to manage multiple
NSURL objects as <strong>long</strong> as those
objects all refer to the same resource.
</p>
<p>
</p>
<p>
Different NSURLHandle subclasses are used to
manage different types of URL (usually based on the
scheme of the URL), and you can register new
subclasses to extend (or replace) the standard
ones.
</p>
<p>
</p>
<p>
GNUstep comes with private subclasses to handle the
common URL schemes -
</p>
<p>
<ul>
<li>
<code>file:</code> (local file I/O)
</li>
<li>
<code>http:</code> and <code>https:</code>
(webserver) access.
</li>
<li>
<code>ftp:</code> (FTP server) access.
</li>
</ul>
</div>
<hr width="50%" align="left" />
<a href="#_NSURLHandle_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle+URLHandleClassForURL$">+URLHandleClassForURL:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle+cachedHandleForURL$">+cachedHandleForURL:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle+canInitWithURL$">+canInitWithURL:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle+registerURLHandleClass$">+registerURLHandleClass:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-addClient$">-addClient:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-availableResourceData">-availableResourceData</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-backgroundLoadDidFailWithReason$">-backgroundLoadDidFailWithReason:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-beginLoadInBackground">-beginLoadInBackground</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-cancelLoadInBackground">-cancelLoadInBackground</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-didLoadBytes$loadComplete$">-didLoadBytes:loadComplete:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-endLoadInBackground">-endLoadInBackground</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-failureReason">-failureReason</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-flushCachedData">-flushCachedData</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-initWithURL$cached$">-initWithURL:cached:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-loadInBackground">-loadInBackground</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-loadInForeground">-loadInForeground</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-propertyForKey$">-propertyForKey:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-propertyForKeyIfAvailable$">-propertyForKeyIfAvailable:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-removeClient$">-removeClient:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-resourceData">-resourceData</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-status">-status</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-writeData$">-writeData:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$NSURLHandle-writeProperty$forKey$">-writeProperty:forKey:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSURLHandle+URLHandleClassForURL$">URLHandleClassForURL: </a></h3>
+ (Class) <b>URLHandleClassForURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)url;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Returns the most recently registered NSURLHandle
subclass that responds to
<a rel="gsdoc" href="#method$NSURLHandle+canInitWithURL$">
+canInitWithURL:
</a>
with <code>YES</code>. If there is no such subclass,
returns <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle+cachedHandleForURL$">cachedHandleForURL: </a></h3>
+ (<a rel="gsdoc" href="#class$NSURLHandle">NSURLHandle</a>*) <b>cachedHandleForURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)url;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Return a handle for the specified URL from the cache
if possible. If the cache does not contain a matching
handle, returns <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle+canInitWithURL$">canInitWithURL: </a></h3>
+ (BOOL) <b>canInitWithURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)url;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Implemented by subclasses to say which URLs
they can handle. This method is used to determine
which subclasses can be used to handle a particular
URL.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle+registerURLHandleClass$">registerURLHandleClass: </a></h3>
+ (void) <b>registerURLHandleClass:</b> (Class)urlHandleSubclass;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Used to register a subclass as being available to
handle URLs.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-addClient$">addClient: </a></h3>
- (void) <b>addClient:</b> (id<<a rel="gsdoc" href="#protocol$(NSURLHandleClient)">NSURLHandleClient</a>>)client;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Add a <var>client</var> object, making sure that it
doesn't occur more than once. <br /> The
<var>client</var> object will receive messages
notifying it of events on the handle.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-availableResourceData">availableResourceData </a></h3>
- (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>availableResourceData</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Returns the resource data that is currently
available for the handle. This may be a partially
loaded resource or may be empty if no data has been
loaded yet or the last load failed.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-backgroundLoadDidFailWithReason$">backgroundLoadDidFailWithReason: </a></h3>
- (void) <b>backgroundLoadDidFailWithReason:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)reason;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
This method should be called when a background load
fails. <br /> The method passes the failure
notification to the clients of the handle - so
subclasses should call super's implementation at
the end of their implementation of this method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-beginLoadInBackground">beginLoadInBackground </a></h3>
- (void) <b>beginLoadInBackground</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
This method is called by when a background load
begins. Subclasses should call super's
implementation at the end of their
implementation of this method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-cancelLoadInBackground">cancelLoadInBackground </a></h3>
- (void) <b>cancelLoadInBackground</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
This method should be called to cancel a load
currently in progress. The method calls
<a rel="gsdoc" href="#method$NSURLHandle-endLoadInBackground">
-endLoadInBackground
</a>
Subclasses should call super's implementation at
the end of their implementation of this method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-didLoadBytes$loadComplete$">didLoadBytes: loadComplete: </a></h3>
- (void) <b>didLoadBytes:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)newData<b> loadComplete:</b> (BOOL)loadComplete;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Method called by subclasses during process of
loading a resource. The base class maintains a copy
of the data being read in and accumulates separate parts
of the data.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-endLoadInBackground">endLoadInBackground </a></h3>
- (void) <b>endLoadInBackground</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
This method is called to stop any background loading
process.
<a rel="gsdoc" href="#method$NSURLHandle-cancelLoadInBackground">
-cancelLoadInBackground
</a>
uses this method to cancel loading. Subclasses should
call super's implementation at the end of their
implementation of this method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-failureReason">failureReason </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>failureReason</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Returns the failure reason for the last failure to
load the resource data.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-flushCachedData">flushCachedData </a></h3>
- (void) <b>flushCachedData</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Flushes any cached resource data.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-initWithURL$cached$">initWithURL: cached: </a></h3>
- (id) <b>initWithURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)url<b> cached:</b> (BOOL)cached;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
This is a designated initialiser for the class.<br />
<div class="desc">
Initialises a handle with the specified URL.
<br /> The flag determines whether the handle will
cache resource data and respond to requests from
equivalent URLs for the <var>cached</var> data.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-loadInBackground">loadInBackground </a></h3>
- (void) <b>loadInBackground</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Starts (or queues) loading of the handle's resource
data in the background (asynchronously). <br /> The
default implementation uses loadInForeground - if
this method is not overridden, loadInForeground MUST
be.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-loadInForeground">loadInForeground </a></h3>
- (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>loadInForeground</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Loads the handle's resource data in the foreground
(synchronously). <br /> The default
implementation starts a background load and
waits for it to complete - if this method is not
overridden, loadInBackground MUST be.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-propertyForKey$">propertyForKey: </a></h3>
- (id) <b>propertyForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)propertyKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns the property for the specified key, or
<code>nil</code> if the key does not exist.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-propertyForKeyIfAvailable$">propertyForKeyIfAvailable: </a></h3>
- (id) <b>propertyForKeyIfAvailable:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)propertyKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns the property for the specified key, but
only if the handle does not need to do any work to
retrieve it.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-removeClient$">removeClient: </a></h3>
- (void) <b>removeClient:</b> (id<<a rel="gsdoc" href="#protocol$(NSURLHandleClient)">NSURLHandleClient</a>>)client;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Removes an object from them list of clients
notified of resource loading events by the URL
handle.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-resourceData">resourceData </a></h3>
- (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>resourceData</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Returns the resource data belonging to the handle.
Calls
<a rel="gsdoc" href="#method$NSURLHandle-loadInForeground">
-loadInForeground
</a>
if necessary.
</p>
<p>
The GNUstep implementation treats an <em>ftp:</em>
request for a directory as a request to list the
names of the directory contents.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-status">status </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSURLHandleStatus">NSURLHandleStatus</a>) <b>status</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Returns the current status of the handle.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-writeData$">writeData: </a></h3>
- (BOOL) <b>writeData:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
</p>
<p>
Writes resource <var>data</var> to the handle.
Returns <code>YES</code> on success,
<code>NO</code> on failure.
</p>
<p>
</p>
<p>
The GNUstep implementation for <em>file:</em> writes
the <var>data</var> directly to the local filesystem,
and the return status reflects the result of that
write operation.
</p>
<p>
</p>
<p>
The GNUstep implementation for <em>http:</em> and
<em>https:</em> sets the specified <var>data</var>
as information to be POSTed to the URL next time it is
loaded - so the method always returns
<code>YES</code>.
</p>
<p>
</p>
<p>
The GNUstep implementation for <em>ftp:</em> sets the
specified <var>data</var> as information to be
written to the URL next time it is loaded - so
the method always returns <code>YES</code>.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSURLHandle-writeProperty$forKey$">writeProperty: forKey: </a></h3>
- (BOOL) <b>writeProperty:</b> (id)propertyValue<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)propertyKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
</p>
<p>
Sets a property for handle. Returns <code>YES</code>
on success, <code>NO</code> on failure.
</p>
<p>
</p>
<p>
The GNUstep implementation sets the property as a
header to be sent the next time the URL is loaded,
and recognizes some special property keys which
control the behavior of the next load.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<a name="_NSURLHandle_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for NSURLHandle Class</h2>
<h3><a name="ivariable$NSURLHandle*_clients">_clients</a></h3>
@protected NSMutableArray* <b>_clients</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.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" />
<h3><a name="ivariable$NSURLHandle*_data">_data</a></h3>
@protected id <b>_data</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.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" />
<h3><a name="ivariable$NSURLHandle*_failure">_failure</a></h3>
@protected NSString* <b>_failure</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.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" />
<h3><a name="ivariable$NSURLHandle*_status">_status</a></h3>
@protected NSURLHandleStatus <b>_status</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.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 NSURLHandleClient
protocol
</a></h1>
<h2><a name="protocol$(NSURLHandleClient)">NSURLHandleClient</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSURLHandle.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
A protocol to which clients of a handle must conform in
order to receive notification of events on the handle.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSURLHandle.html#method$(NSURLHandleClient)-URLHandle$resourceDataDidBecomeAvailable$">-URLHandle:resourceDataDidBecomeAvailable:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$(NSURLHandleClient)-URLHandle$resourceDidFailLoadingWithReason$">-URLHandle:resourceDidFailLoadingWithReason:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$(NSURLHandleClient)-URLHandleResourceDidBeginLoading$">-URLHandleResourceDidBeginLoading:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$(NSURLHandleClient)-URLHandleResourceDidCancelLoading$">-URLHandleResourceDidCancelLoading:</a></li>
<li><a rel="gsdoc" href="NSURLHandle.html#method$(NSURLHandleClient)-URLHandleResourceDidFinishLoading$">-URLHandleResourceDidFinishLoading:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$(NSURLHandleClient)-URLHandle$resourceDataDidBecomeAvailable$">URLHandle: resourceDataDidBecomeAvailable: </a></h3>
- (void) <b>URLHandle:</b> (<a rel="gsdoc" href="#class$NSURLHandle">NSURLHandle</a>*)sender<b> resourceDataDidBecomeAvailable:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)newData;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Sent by the NSURLHandle object when some data becomes
available from the handle. Note that this does
not mean that all data has become available, only that
a chunk of data has arrived.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$(NSURLHandleClient)-URLHandle$resourceDidFailLoadingWithReason$">URLHandle: resourceDidFailLoadingWithReason: </a></h3>
- (void) <b>URLHandle:</b> (<a rel="gsdoc" href="#class$NSURLHandle">NSURLHandle</a>*)sender<b> resourceDidFailLoadingWithReason:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)reason;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Sent by the NSURLHandle object on resource load
failure. Supplies a human readable failure
<var>reason</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$(NSURLHandleClient)-URLHandleResourceDidBeginLoading$">URLHandleResourceDidBeginLoading: </a></h3>
- (void) <b>URLHandleResourceDidBeginLoading:</b> (<a rel="gsdoc" href="#class$NSURLHandle">NSURLHandle</a>*)sender;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Sent by the NSURLHandle object when it begins loading
resource data.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$(NSURLHandleClient)-URLHandleResourceDidCancelLoading$">URLHandleResourceDidCancelLoading: </a></h3>
- (void) <b>URLHandleResourceDidCancelLoading:</b> (<a rel="gsdoc" href="#class$NSURLHandle">NSURLHandle</a>*)sender;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Sent by the NSURLHandle object when resource loading
is cancelled by programmatic request (rather than by
failure).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$(NSURLHandleClient)-URLHandleResourceDidFinishLoading$">URLHandleResourceDidFinishLoading: </a></h3>
- (void) <b>URLHandleResourceDidFinishLoading:</b> (<a rel="gsdoc" href="#class$NSURLHandle">NSURLHandle</a>*)sender;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Sent by the NSURLHandle object when it completes
loading resource data.
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
|