/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSThread.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 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 | <!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>NSThread class reference</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSThread">NSThread class reference</a></h1>
<h3>Authors</h3>
<dl>
<dt>Scott Christley (<a href="mailto:scottc@net-community.com"><code>scottc@net-community.com</code></a>)</dt>
<dd>
</dd>
<dt>Andrew Kachites McCallum (<a href="mailto:mccallum@gnu.ai.mit.edu"><code>mccallum@gnu.ai.mit.edu</code></a>)</dt>
<dd>
</dd>
<dt>Richard Frith-Macdonald (<a href="mailto:richard@brainstorm.co.uk"><code>richard@brainstorm.co.uk</code></a>)</dt>
<dd>
</dd>
<dt>Nicola Pero (<a href="mailto:n.pero@mi.flashnet.it"><code>n.pero@mi.flashnet.it</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Version:</b> 36966</p>
<p><b>Date:</b> 2013-08-12 09:56:18 +0100 (Mon, 12 Aug 2013)</p>
<p><b>Copyright:</b> (C) 1996-2000 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the NSThread class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the
NSObject(NSThreadPerformAdditions)
category</a>
</li>
<li>
<a href="#003000000000">Software documentation for the
NSThread(CallStackSymbols) category</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the NSThread class
</a></h1>
<h2><a name="class$NSThread">NSThread</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSThread.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
This class encapsulates OpenStep threading. See
<a rel="gsdoc" href="NSLock.html#class$NSLock">NSLock</a>
and its subclasses for handling synchronisation between
threads. <br /> Each process begins with a main
thread and additional threads can be created using
NSThread. The GNUstep implementation of OpenStep
has been carefully designed so that the internals of
the base library do not use threading (except for
methods which explicitly deal with threads of
course) so that you can write applications without
threading. Non-threaded applications are more
efficient (no locking is required) and are easier
to debug during development.
</div>
<hr width="50%" align="left" />
<a href="#_NSThread_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread(CallStackSymbols)+callStackSymbols">+callStackSymbols</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+callStackReturnAddresses">+callStackReturnAddresses</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+currentThread">+currentThread</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+detachNewThreadSelector$toTarget$withObject$">+detachNewThreadSelector:toTarget:withObject:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+exit">+exit</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+isMainThread">+isMainThread</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+isMultiThreaded">+isMultiThreaded</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+mainThread">+mainThread</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+setThreadPriority$">+setThreadPriority:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+sleepForTimeInterval$">+sleepForTimeInterval:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+sleepUntilDate$">+sleepUntilDate:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread+threadPriority">+threadPriority</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-cancel">-cancel</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-init">-init</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-initWithTarget$selector$object$">-initWithTarget:selector:object:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-isCancelled">-isCancelled</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-isExecuting">-isExecuting</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-isFinished">-isFinished</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-isMainThread">-isMainThread</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-main">-main</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-name">-name</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-setName$">-setName:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-setStackSize$">-setStackSize:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-stackSize">-stackSize</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-start">-start</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread-threadDictionary">-threadDictionary</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSThread+callStackReturnAddresses">callStackReturnAddresses </a></h3>
+ (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*) <b>callStackReturnAddresses</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns an array of the call stack return
addresses.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+currentThread">currentThread </a></h3>
+ (<a rel="gsdoc" href="#class$NSThread">NSThread</a>*) <b>currentThread</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Returns the NSThread object corresponding to the
current thread.
</p>
<p>
</p>
<p>
NB. In GNUstep the library internals use the
GSCurrentThread()
function as a more efficient mechanism for doing
this job - so you cannot use a category to override
this method and expect the library internals to use
your implementation.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+detachNewThreadSelector$toTarget$withObject$">detachNewThreadSelector: toTarget: withObject: </a></h3>
+ (void) <b>detachNewThreadSelector:</b> (SEL)aSelector<b> toTarget:</b> (id)aTarget<b> withObject:</b> (id)anArgument;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Create a new thread - use this method rather than
alloc-init. The new thread will begin
executing the message given by
<var>aSelector</var>, <var>aTarget</var>, and
<var>anArgument</var>. This should have no return
value, and must set up an autorelease pool if
retain/release memory management is used.
It should free this pool before it finishes execution.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+exit">exit </a></h3>
+ (void) <b>exit</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Terminates the current thread. <br /> Normally
you don't need to call this method explicitly, since
exiting the method with which the thread was
detached causes this method to be called
automatically.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+isMainThread">isMainThread </a></h3>
+ (BOOL) <b>isMainThread</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns a boolean indicating whether this thread is
the main thread of the process.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+isMultiThreaded">isMultiThreaded </a></h3>
+ (BOOL) <b>isMultiThreaded</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a flag to say whether the application is
multi-threaded or not. <br /> An application
is considered to be multi-threaded if any thread other
than the main thread has been started, irrespective of
whether that thread has since terminated. <br />
NB. This method returns <code>YES</code> if called
within a handler processing
<code>NSWillBecomeMultiThreadedNotification</code>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+mainThread">mainThread </a></h3>
+ (<a rel="gsdoc" href="#class$NSThread">NSThread</a>*) <b>mainThread</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns the main thread of the process.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+setThreadPriority$">setThreadPriority: </a></h3>
+ (void) <b>setThreadPriority:</b> (double)pri;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.2.0</div>
<br />
<div class="desc">
Set the priority of the current thread. This is a value
in the range 0.0 (lowest) to 1.0 (highest) which is
mapped to the underlying system priorities.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+sleepForTimeInterval$">sleepForTimeInterval: </a></h3>
+ (void) <b>sleepForTimeInterval:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSTimeInterval">NSTimeInterval</a>)ti;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Suspends execution of the process for the
specified period.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+sleepUntilDate$">sleepUntilDate: </a></h3>
+ (void) <b>sleepUntilDate:</b> (<a rel="gsdoc" href="NSDate.html#class$NSDate">NSDate</a>*)date;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Delaying a thread... pause until the specified
<var>date</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread+threadPriority">threadPriority </a></h3>
+ (double) <b>threadPriority</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.2.0</div>
<br />
<div class="desc">
Return the priority of the current thread.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-cancel">cancel </a></h3>
- (void) <b>cancel</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Cancels the receiving thread.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-init">init </a></h3>
- (id) <b>init</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
This is a designated initialiser for the class.<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-initWithTarget$selector$object$">initWithTarget: selector: object: </a></h3>
- (id) <b>initWithTarget:</b> (id)aTarget<b> selector:</b> (SEL)aSelector<b> object:</b> (id)anArgument;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Initialises the receiver to send the message
<var>aSelector</var> to the object <var>aTarget</var>
with the argument <var>anArgument</var> (which may be
<code>nil</code>). <br /> The arguments
<var>aTarget</var> and <var>aSelector</var> are
retained while the thread is running.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-isCancelled">isCancelled </a></h3>
- (BOOL) <b>isCancelled</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns a boolean indicating whether the receiving
thread has been cancelled.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-isExecuting">isExecuting </a></h3>
- (BOOL) <b>isExecuting</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns a boolean indicating whether the receiving
thread has been started (and has not yet finished or
been cancelled).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-isFinished">isFinished </a></h3>
- (BOOL) <b>isFinished</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns a boolean indicating whether the receiving
thread has completed executing.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-isMainThread">isMainThread </a></h3>
- (BOOL) <b>isMainThread</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns a boolean indicating whether this thread is
the main thread of the process.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-main">main </a></h3>
- (void) <b>main</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
FIXME... what does this do?
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-name">name </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>name</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns the name of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-setName$">setName: </a></h3>
- (void) <b>setName:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aName;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Sets the name of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-setStackSize$">setStackSize: </a></h3>
- (void) <b>setStackSize:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)stackSize;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Sets the size of the receiver's stack.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-stackSize">stackSize </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>stackSize</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Returns the size of the receiver's stack.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-start">start </a></h3>
- (void) <b>start</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0, Base 1.15.1</div>
<br />
<div class="desc">
Starts the receiver executing.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSThread-threadDictionary">threadDictionary </a></h3>
- (<a rel="gsdoc" href="NSDictionary.html#class$NSMutableDictionary">NSMutableDictionary</a>*) <b>threadDictionary</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return the thread dictionary. This dictionary can be
used to store arbitrary thread specific data. <br />
NB. This cannot be autoreleased, since we cannot be
sure that the autorelease pool for the thread will
continue to exist for the entire life of the
thread!
</div>
<hr width="25%" align="left" />
</div>
<a name="_NSThread_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for NSThread Class</h2>
<h3><a name="ivariable$NSThread*_active">_active</a></h3>
@public BOOL <b>_active</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_arg">_arg</a></h3>
@public id <b>_arg</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_autorelease_vars">_autorelease_vars</a></h3>
@public struct autorelease_thread_vars <b>_autorelease_vars</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_cancelled">_cancelled</a></h3>
@public BOOL <b>_cancelled</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_exception_handler">_exception_handler</a></h3>
@public NSHandler* <b>_exception_handler</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_finished">_finished</a></h3>
@public BOOL <b>_finished</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_gcontext">_gcontext</a></h3>
@public id <b>_gcontext</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_name">_name</a></h3>
@public NSString* <b>_name</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_runLoopInfo">_runLoopInfo</a></h3>
@public void* <b>_runLoopInfo</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_selector">_selector</a></h3>
@public SEL <b>_selector</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_stackSize">_stackSize</a></h3>
@public NSUInteger <b>_stackSize</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_target">_target</a></h3>
@public id <b>_target</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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$NSThread*_thread_dictionary">_thread_dictionary</a></h3>
@public NSMutableDictionary* <b>_thread_dictionary</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</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
NSObject(NSThreadPerformAdditions)
category
</a></h1>
<h2><a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a>(<a name="category$NSObject(NSThreadPerformAdditions)">NSThreadPerformAdditions</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSThread.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Extra methods to permit messages to be sent to an
object such that they are executed in <em>another</em>
thread. <br /> The main thread is the thread in which
the GNUstep system is started, and where the GNUstep gui
is used, it is the thread in which gui drawing operations
<strong>must</strong> be performed.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSThread.html#method$NSObject(NSThreadPerformAdditions)-performSelector$onThread$withObject$waitUntilDone$">-performSelector:onThread:withObject:waitUntilDone:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSObject(NSThreadPerformAdditions)-performSelector$onThread$withObject$waitUntilDone$modes$">-performSelector:onThread:withObject:waitUntilDone:modes:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSObject(NSThreadPerformAdditions)-performSelectorInBackground$withObject$">-performSelectorInBackground:withObject:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSObject(NSThreadPerformAdditions)-performSelectorOnMainThread$withObject$waitUntilDone$">-performSelectorOnMainThread:withObject:waitUntilDone:</a></li>
<li><a rel="gsdoc" href="NSThread.html#method$NSObject(NSThreadPerformAdditions)-performSelectorOnMainThread$withObject$waitUntilDone$modes$">-performSelectorOnMainThread:withObject:waitUntilDone:modes:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSObject(NSThreadPerformAdditions)-performSelector$onThread$withObject$waitUntilDone$">performSelector: onThread: withObject: waitUntilDone: </a></h3>
- (void) <b>performSelector:</b> (SEL)aSelector<b> onThread:</b> (<a rel="gsdoc" href="#class$NSThread">NSThread</a>*)aThread<b> withObject:</b> (id)anObject<b> waitUntilDone:</b> (BOOL)aFlag;<br />
<div class="availability">
<b>Availability:</b> Base 10.5.0<br />
</div>
<br />
<div class="desc">
Invokes
<a rel="gsdoc" href="#method$NSObject(NSThreadPerformAdditions)-performSelector$onThread$withObject$waitUntilDone$modes$">-performSelector:onThread:withObject:waitUntilDone:modes:</a>
using the supplied arguments and an array containing common modes. <br /> These modes consist of NSRunLoopMode, NSConnectionreplyMode, and if in an application, the NSApplication modes.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSObject(NSThreadPerformAdditions)-performSelector$onThread$withObject$waitUntilDone$modes$">performSelector: onThread: withObject: waitUntilDone: modes: </a></h3>
- (void) <b>performSelector:</b> (SEL)aSelector<b> onThread:</b> (<a rel="gsdoc" href="#class$NSThread">NSThread</a>*)aThread<b> withObject:</b> (id)anObject<b> waitUntilDone:</b> (BOOL)aFlag<b> modes:</b> (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*)anArray;<br />
<div class="availability">
<b>Availability:</b> Base 10.5.0<br />
</div>
<br />
<div class="desc">
</p>
<p>
This method performs <var>aSelector</var> on the
receiver, passing <var>anObject</var> as an
argument, but does so in the specified thread.
The receiver and <var>anObject</var> are both
retained until the method is performed.
</p>
<p>
</p>
<p>
The selector is performed when the runloop of
<var>aThread</var> next runs in one of the modes
specified in <var>anArray</var>. <br /> Where
this method has been called more than once before
the runloop of the thread runs in the required mode,
the order in which the operations in the thread is
done is the same as that in which they were added
using this method.
</p>
<p>
</p>
<p>
If there are no modes in <var>anArray</var>, the
method has no effect and simply returns
immediately.
</p>
<p>
</p>
<p>
The argument <var>aFlag</var> specifies whether the
method should wait until the selector has been
performed before returning. <br />
<strong>NB.</strong> This method does
<em>not</em> cause the runloop of <var>aThread</var>
to be run... so if the runloop is not executed by some
code in <var>aThread</var>, the thread waiting for
the perform to complete will block forever.
</p>
<p>
</p>
<p>
As a special case, if <var>aFlag</var> ==
<code>YES</code> and the current thread is
<var>aThread</var>, the modes array is ignored and
the selector is performed immediately. This behavior
is necessary to avoid the current thread being blocked
by waiting for a perform which will never happen
because the runloop is not executing.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSObject(NSThreadPerformAdditions)-performSelectorInBackground$withObject$">performSelectorInBackground: withObject: </a></h3>
- (void) <b>performSelectorInBackground:</b> (SEL)aSelector<b> withObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> Base 10.5.0<br />
</div>
<br />
<div class="desc">
Creates and runs a new background thread sending
<var>aSelector</var> to the receiver and passing
<var>anObject</var> (which may be <code>nil</code>)
as the argument.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSObject(NSThreadPerformAdditions)-performSelectorOnMainThread$withObject$waitUntilDone$">performSelectorOnMainThread: withObject: waitUntilDone: </a></h3>
- (void) <b>performSelectorOnMainThread:</b> (SEL)aSelector<b> withObject:</b> (id)anObject<b> waitUntilDone:</b> (BOOL)aFlag;<br />
<div class="availability">
<b>Availability:</b> Base 10.2.0<br />
</div>
<br />
<div class="desc">
Invokes
<a rel="gsdoc" href="#method$NSObject(NSThreadPerformAdditions)-performSelectorOnMainThread$withObject$waitUntilDone$modes$">-performSelectorOnMainThread:withObject:waitUntilDone:modes:</a>
using the supplied arguments and an array containing common modes. <br /> These modes consist of NSRunLoopMode, NSConnectionReplyMode, and if in an application, the NSApplication modes.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSObject(NSThreadPerformAdditions)-performSelectorOnMainThread$withObject$waitUntilDone$modes$">performSelectorOnMainThread: withObject: waitUntilDone: modes: </a></h3>
- (void) <b>performSelectorOnMainThread:</b> (SEL)aSelector<b> withObject:</b> (id)anObject<b> waitUntilDone:</b> (BOOL)aFlag<b> modes:</b> (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*)anArray;<br />
<div class="availability">
<b>Availability:</b> Base 10.2.0<br />
</div>
<br />
<div class="desc">
</p>
<p>
This method performs <var>aSelector</var> on the
receiver, passing <var>anObject</var> as an
argument, but does so in the main thread of the
program. The receiver and <var>anObject</var>
are both retained until the method is performed.
</p>
<p>
</p>
<p>
The selector is performed when the runloop of the
main thread next runs in one of the modes specified
in <var>anArray</var>. <br /> Where this method has
been called more than once before the runloop of the
main thread runs in the required mode, the order in
which the operations in the main thread is done is
the same as that in which they were added using this
method.
</p>
<p>
</p>
<p>
If there are no modes in <var>anArray</var>, the
method has no effect and simply returns
immediately.
</p>
<p>
</p>
<p>
The argument <var>aFlag</var> specifies whether the
method should wait until the selector has been
performed before returning. <br />
<strong>NB.</strong> This method does
<em>not</em> cause the runloop of the main thread to
be run... so if the runloop is not executed by some
code in the main thread, the thread waiting for the
perform to complete will block forever.
</p>
<p>
</p>
<p>
As a special case, if <var>aFlag</var> ==
<code>YES</code> and the current thread is the
main thread, the modes array is ignored and the
selector is performed immediately. This behavior
is necessary to avoid the main thread being blocked by
waiting for a perform which will never happen
because the runloop is not executing.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="003000000000">
Software documentation for the
NSThread(CallStackSymbols) category
</a></h1>
<h2><a rel="gsdoc" href="#class$NSThread">NSThread</a>(<a name="category$NSThread(CallStackSymbols)">CallStackSymbols</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSThread.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSThread.html#method$NSThread(CallStackSymbols)+callStackSymbols">+callStackSymbols</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSThread(CallStackSymbols)+callStackSymbols">callStackSymbols </a></h3>
+ (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*) <b>callStackSymbols</b>;<br />
<div class="availability">
<b>Availability:</b> Base 10.6.0<br />
</div>
<br />
<div class="desc">
Returns an array of NSString objects representing
the current stack in an implementation-defined format.
May return an empty array if this feature is not
available.
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
|