iOS Developer Library

Developer

Foundation Framework Reference NSPipe Class Reference

Options
Deployment Target:

On This Page
Language:

NSPipe

NSPipe objects provide an object-oriented interface for accessing pipes. An NSPipe object represents both ends of a pipe and enables communication through the pipe. A pipe is a one-way communications channel between related processes; one process writes data, while the other process reads that data. The data that passes through the pipe is buffered; the size of the buffer is determined by the underlying operating system. NSPipe is an abstract class, the public interface of a class cluster.

Inheritance


Conforms To


Import Statement


Swift

import Foundation

Objective-C

@import Foundation;

Availability


Available in iOS 2.0 and later.
  • init - init Available in iOS 2.0 through iOS 7.1

    Returns an initialized NSPipe object.

    Declaration

    Objective-C

    - (id)init

    Return Value

    An initialized NSPipe object. Returns nil if the method encounters errors while attempting to create the pipe or the NSFileHandle objects that serve as endpoints of the pipe.

    Import Statement

    Objective-C

    @import Foundation;

    Availability

    Available in iOS 2.0 through iOS 7.1.

    See Also

    + pipe

  • Returns an NSPipe object.

    Declaration

    Objective-C

    + (NSPipe *)pipe

    Return Value

    An initialized NSPipe object. Returns nil if the method encounters errors while attempting to create the pipe or the NSFileHandle objects that serve as endpoints of the pipe.

    Import Statement

    Objective-C

    @import Foundation;

    Availability

    Available in iOS 2.0 and later.

  • The receiver's read file handle. (read-only)

    Declaration

    Swift

    var fileHandleForReading: NSFileHandle { get }

    Objective-C

    @property(readonly, retain) NSFileHandle *fileHandleForReading

    Discussion

    The descriptor represented by this object is deleted, and the object itself is automatically deallocated when the receiver is deallocated.

    You use the returned file handle to read from the pipe using NSFileHandle's read methods—availableData, readDataToEndOfFile, and readDataOfLength:.

    You don’t need to send closeFile to this object or explicitly release the object after you have finished using it.

    Import Statement

    Objective-C

    @import Foundation;

    Swift

    import Foundation

    Availability

    Available in iOS 2.0 and later.

  • The receiver's write file handle. (read-only)

    Declaration

    Swift

    var fileHandleForWriting: NSFileHandle { get }

    Objective-C

    @property(readonly, retain) NSFileHandle *fileHandleForWriting

    Discussion

    This object is automatically deallocated when the receiver is deallocated.

    You use the returned file handle to write to the pipe using NSFileHandle's writeData: method. When you are finished writing data to this object, send it a closeFile message to delete the descriptor. Deleting the descriptor causes the reading process to receive an end-of-data signal (an empty NSData object).

    Import Statement

    Objective-C

    @import Foundation;

    Swift

    import Foundation

    Availability

    Available in iOS 2.0 and later.