This file is indexed.

/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSStream.html 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
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
<!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>NSStream documentation</title>
  </head>
  <body>
    <font face="serif">
    <a href="Base.html">Up</a>
    <br />
    <h1><a name="title$NSStream">NSStream documentation</a></h1>
    <h3>Authors</h3>
    <dl>
      <dt>Derek Zhou (<a href="mailto:derekzhou@gmail.com"><code>derekzhou@gmail.com</code></a>)</dt>
      <dd>
      </dd>
    </dl>
    <p><b>Copyright:</b> (C) 2006 Free Software Foundation, Inc.</p>

        <div>
      <hr width="50%" align="left" />
      <h3>Contents -</h3>
      <ol>
        <li>
          <a href="#001000000000">Software documentation for the NSInputStream class</a>
        </li>
        <li>
          <a href="#002000000000">Software documentation for the NSOutputStream class</a>
        </li>
        <li>
          <a href="#003000000000">Software documentation for the NSStream class</a>
        </li>
        <li>
          <a href="#004000000000">Software documentation for the
        NSObject(NSStreamDelegate) informal
        protocol</a>
        </li>
        <li>
          <a href="#005000000000">Software documentation for the NSStreamDelegate
        protocol</a>
        </li>
      </ol>
      <hr width="50%" align="left" />
    </div>

          <h1><a name="001000000000">
        Software documentation for the NSInputStream class
      </a></h1>
    <h2><a name="class$NSInputStream">NSInputStream</a> : <a rel="gsdoc" href="#class$NSStream">NSStream</a></h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>Foundation/NSStream.h</dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
          NSInputStream is a subclass of NSStream that
          provides read-only stream functionality.
        
    </div>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream+inputStreamWithData$">+inputStreamWithData:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream+inputStreamWithFileAtPath$">+inputStreamWithFileAtPath:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream+inputStreamWithURL$">+inputStreamWithURL:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream-getBuffer$length$">-getBuffer:length:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream-hasBytesAvailable">-hasBytesAvailable</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream-initWithData$">-initWithData:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream-initWithFileAtPath$">-initWithFileAtPath:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream-initWithURL$">-initWithURL:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSInputStream-read$maxLength$">-read:maxLength:</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$NSInputStream+inputStreamWithData$">inputStreamWithData:&nbsp;</a></h3>
    + (id) <b>inputStreamWithData:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Creates and returns an initialized NSInputStream
            object for reading from <var>data</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSInputStream+inputStreamWithFileAtPath$">inputStreamWithFileAtPath:&nbsp;</a></h3>
    + (id) <b>inputStreamWithFileAtPath:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)path;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Creates and returns an initialized NSInputStream
            object that reads data from the file at the
            specified <var>path</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSInputStream+inputStreamWithURL$">inputStreamWithURL:&nbsp;</a></h3>
    + (id) <b>inputStreamWithURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)url;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Creates and returns an initialized NSInputStream
            object that reads data from the specified URL.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSInputStream-getBuffer$length$">getBuffer:&nbsp;length:&nbsp;</a></h3>
    - (BOOL) <b>getBuffer:</b> (uint8_t**)buffer<b> length:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>*)len;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns a pointer to the read <var>buffer</var> in
            <var>buffer</var> and, by reference, the number of
            bytes available in <var>len</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSInputStream-hasBytesAvailable">hasBytesAvailable&nbsp;</a></h3>
    - (BOOL) <b>hasBytesAvailable</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns <code>YES</code> if the receiver has bytes
            available to read. The receiver may also return
            <code>YES</code> if a read must be attempted in
            order to determine the availability of bytes.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSInputStream-initWithData$">initWithData:&nbsp;</a></h3>
    - (id) <b>initWithData:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns an initialized NSInputStream object for
            reading from <var>data</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSInputStream-initWithFileAtPath$">initWithFileAtPath:&nbsp;</a></h3>
    - (id) <b>initWithFileAtPath:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)path;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns an initialized NSInputStream object for
            reading from the file at the specified
            <var>path</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSInputStream-initWithURL$">initWithURL:&nbsp;</a></h3>
    - (id) <b>initWithURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)url;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns an initialized NSInputStream object for
            reading from the specified URL.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSInputStream-read$maxLength$">read:&nbsp;maxLength:&nbsp;</a></h3>
    - (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>read:</b> (uint8_t*)buffer<b> maxLength:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)len;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Reads up to <var>len</var> bytes into
            <var>buffer</var>, returning the actual number of
            bytes read.
          
    </div>
    <hr width="25%" align="left" />
</div>

          <h1><a name="002000000000">
        Software documentation for the NSOutputStream class
      </a></h1>
    <h2><a name="class$NSOutputStream">NSOutputStream</a> : <a rel="gsdoc" href="#class$NSStream">NSStream</a></h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>Foundation/NSStream.h</dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
          NSOutputStream is a subclass of NSStream that
          provides write-only stream functionality.
        
    </div>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="NSStream.html#method$NSOutputStream+outputStreamToBuffer$capacity$">+outputStreamToBuffer:capacity:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSOutputStream+outputStreamToFileAtPath$append$">+outputStreamToFileAtPath:append:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSOutputStream+outputStreamToMemory">+outputStreamToMemory</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSOutputStream-hasSpaceAvailable">-hasSpaceAvailable</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSOutputStream-initToBuffer$capacity$">-initToBuffer:capacity:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSOutputStream-initToFileAtPath$append$">-initToFileAtPath:append:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSOutputStream-initToMemory">-initToMemory</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSOutputStream-write$maxLength$">-write:maxLength:</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$NSOutputStream+outputStreamToBuffer$capacity$">outputStreamToBuffer:&nbsp;capacity:&nbsp;</a></h3>
    + (id) <b>outputStreamToBuffer:</b> (uint8_t*)buffer<b> capacity:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)capacity;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Creates and returns an initialized NSOutputStream
            object that can write to <var>buffer</var>, up to a
            maximum of <var>capacity</var> bytes.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSOutputStream+outputStreamToFileAtPath$append$">outputStreamToFileAtPath:&nbsp;append:&nbsp;</a></h3>
    + (id) <b>outputStreamToFileAtPath:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)path<b> append:</b> (BOOL)shouldAppend;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Creates and returns an initialized NSOutputStream
            object for writing to the file specified by
            <var>path</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSOutputStream+outputStreamToMemory">outputStreamToMemory&nbsp;</a></h3>
    + (id) <b>outputStreamToMemory</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Creates and returns an initialized NSOutputStream
            object that will write stream data to memory.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSOutputStream-hasSpaceAvailable">hasSpaceAvailable&nbsp;</a></h3>
    - (BOOL) <b>hasSpaceAvailable</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns <code>YES</code> if the receiver can be
            written to, or if a write must be attempted in
            order to determine if space is available.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSOutputStream-initToBuffer$capacity$">initToBuffer:&nbsp;capacity:&nbsp;</a></h3>
    - (id) <b>initToBuffer:</b> (uint8_t*)buffer<b> capacity:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)capacity;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns an initialized NSOutputStream object that
            can write to <var>buffer</var>, up to a maximum of
            <var>capacity</var> bytes.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSOutputStream-initToFileAtPath$append$">initToFileAtPath:&nbsp;append:&nbsp;</a></h3>
    - (id) <b>initToFileAtPath:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)path<b> append:</b> (BOOL)shouldAppend;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns an initialized NSOutputStream object for
            writing to the file specified by <var>path</var>.
            <br /> If <var>shouldAppend</var> is
            <code>YES</code>, newly written data will be
            appended to any existing file contents.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSOutputStream-initToMemory">initToMemory&nbsp;</a></h3>
    - (id) <b>initToMemory</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns an initialized NSOutputStream object that
            will write to memory.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSOutputStream-write$maxLength$">write:&nbsp;maxLength:&nbsp;</a></h3>
    - (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>write:</b> (const uint8_t*)buffer<b> maxLength:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)len;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Writes the contents of <var>buffer</var>, up to a
            maximum of <var>len</var> bytes, to the receiver.
          
    </div>
    <hr width="25%" align="left" />
</div>

          <h1><a name="003000000000">
        Software documentation for the NSStream class
      </a></h1>
    <h2><a name="class$NSStream">NSStream</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>Foundation/NSStream.h</dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
          NSStream is an abstract class for objects
          representing streams.
        
    </div>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream+getStreamsToHost$port$inputStream$outputStream$">+getStreamsToHost:port:inputStream:outputStream:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-close">-close</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-delegate">-delegate</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-open">-open</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-propertyForKey$">-propertyForKey:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-removeFromRunLoop$forMode$">-removeFromRunLoop:forMode:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-scheduleInRunLoop$forMode$">-scheduleInRunLoop:forMode:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-setDelegate$">-setDelegate:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-setProperty$forKey$">-setProperty:forKey:</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-streamError">-streamError</a></li>
      <li><a rel="gsdoc" href="NSStream.html#method$NSStream-streamStatus">-streamStatus</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$NSStream+getStreamsToHost$port$inputStream$outputStream$">getStreamsToHost:&nbsp;port:&nbsp;inputStream:&nbsp;outputStream:&nbsp;</a></h3>
    + (void) <b>getStreamsToHost:</b> (<a rel="gsdoc" href="NSHost.html#class$NSHost">NSHost</a>*)host<b> port:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)port<b> inputStream:</b> (<a rel="gsdoc" href="#class$NSInputStream">NSInputStream</a>**)inputStream<b> outputStream:</b> (<a rel="gsdoc" href="#class$NSOutputStream">NSOutputStream</a>**)outputStream;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Creates and returns by reference an NSInputStream
            object and NSOutputStream object for a socket
            connection with the specified <var>port</var> on
            <var>host</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-close">close&nbsp;</a></h3>
    - (void) <b>close</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Closes the receiver. <br /> Repeated calls to this
            method on the same stream are quietly ignored.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-delegate">delegate&nbsp;</a></h3>
    - (id) <b>delegate</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns the receiver&apos;s delegate.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-open">open&nbsp;</a></h3>
    - (void) <b>open</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Opens the receiving stream. <br /> Upon completion of
            the open operation, an NSStreamEventOpenCompleted event
            is sent to the recevier&apos;s delegate. <br /> Repeated
            calls to this method on the same stream are quietly
            ignored.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-propertyForKey$">propertyForKey:&nbsp;</a></h3>
    - (id) <b>propertyForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)key;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns the receiver&apos;s property for the specified
            <var>key</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-removeFromRunLoop$forMode$">removeFromRunLoop:&nbsp;forMode:&nbsp;</a></h3>
    - (void) <b>removeFromRunLoop:</b> (<a rel="gsdoc" href="NSRunLoop.html#class$NSRunLoop">NSRunLoop</a>*)aRunLoop<b> forMode:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)mode;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Removes the receiver from the NSRunLoop specified
            by <var>aRunLoop</var> running in the <var>mode</var>.
            <br /> Attempts to remove the receiver from a run
            loop or a <var>mode</var> in which it has not been
            scheduled are quietly ignored.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-scheduleInRunLoop$forMode$">scheduleInRunLoop:&nbsp;forMode:&nbsp;</a></h3>
    - (void) <b>scheduleInRunLoop:</b> (<a rel="gsdoc" href="NSRunLoop.html#class$NSRunLoop">NSRunLoop</a>*)aRunLoop<b> forMode:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)mode;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Schedules the receiver on <var>aRunLoop</var>
            using the specified <var>mode</var>. <br /> You must
            not attempt to add a stream to more than one run loop,
            but you may call this method multiple times to add the
            receiver in different modes for the same run loop.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-setDelegate$">setDelegate:&nbsp;</a></h3>
    - (void) <b>setDelegate:</b> (id)delegate;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Sets the receiver&apos;s <var>delegate</var>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-setProperty$forKey$">setProperty:&nbsp;forKey:&nbsp;</a></h3>
    - (BOOL) <b>setProperty:</b> (id)property<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)key;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Sets the value of the <var>property</var> specified by
            <var>key</var> to <var>property</var>, returns
            <code>YES</code> if the key-value pair are accepted
            by the receiver.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-streamError">streamError&nbsp;</a></h3>
    - (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>*) <b>streamError</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns an NSError object representing the stream
            error, or <code>nil</code> if no error has been
            encountered.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSStream-streamStatus">streamStatus&nbsp;</a></h3>
    - (<a rel="gsdoc" href="TypesAndConstants.html#type$NSStreamStatus">NSStreamStatus</a>) <b>streamStatus</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            Returns the receiver&apos;s status.
          
    </div>
    <hr width="25%" align="left" />
</div>

          <h1><a name="004000000000">
        Software documentation for the
        NSObject(NSStreamDelegate) informal
        protocol
      </a></h1>
    <h2><a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a>(<a name="category$NSObject(NSStreamDelegate)">NSStreamDelegate</a>)</h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>Foundation/NSStream.h</dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
          Informal protocol for delegates of instance of the
          <a rel="gsdoc" href="#class$NSStream">NSStream</a>

            class.
        
    </div>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="NSStream.html#method$NSObject(NSStreamDelegate)-stream$handleEvent$">-stream:handleEvent:</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$NSObject(NSStreamDelegate)-stream$handleEvent$">stream:&nbsp;handleEvent:&nbsp;</a></h3>
    - (void) <b>stream:</b> (<a rel="gsdoc" href="#class$NSStream">NSStream</a>*)sStream<b> handleEvent:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSStreamEvent">NSStreamEvent</a>)anEvent;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.4.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
</div>

          <h1><a name="005000000000">
        Software documentation for the NSStreamDelegate
        protocol
      </a></h1>
    <h2><a name="protocol$(NSStreamDelegate)">NSStreamDelegate</a></h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>Foundation/NSStream.h</dd>
      </dl>
    </blockquote>
    <blockquote>
      <dl>
        <dt><b>Conforms to:</b></dt>
        <dd><a rel="gsdoc" href="NSObject.html#protocol$(NSObject)">NSObject</a></dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> MacOS-X 10.7.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
          <em>Description forthcoming.</em>
        
    </div>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="NSStream.html#method$(NSStreamDelegate)-stream$handleEvent$">-stream:handleEvent:</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$(NSStreamDelegate)-stream$handleEvent$">stream:&nbsp;handleEvent:&nbsp;</a></h3>
    - (void) <b>stream:</b> (<a rel="gsdoc" href="#class$NSStream">NSStream</a>*)sStream<b> handleEvent:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSStreamEvent">NSStreamEvent</a>)anEvent;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.7.0, Base 1.2.0</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
</div>
    <br />
    <a href="Base.html">Up</a>
    </font>
</body>
</html>