Class Pipe

java.lang.Object
java.nio.channels.Pipe
public abstract class Pipe extends Object
A pair of channels that implements a unidirectional pipe.

A pipe consists of a pair of channels: A writable sink channel and a readable source channel. Once some bytes are written to the sink channel they can be read from the source channel in exactly the order in which they were written.

Whether or not a thread writing bytes to a pipe will block until another thread reads those bytes, or some previously-written bytes, from the pipe is system-dependent and therefore unspecified. Many pipe implementations will buffer up to a certain number of bytes between the sink and source channels, but such buffering should not be assumed.

Since:
1.4

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Pipe.SinkChannel
    A channel representing the writable end of a Pipe.
    static class 
    Pipe.SourceChannel
    A channel representing the readable end of a Pipe.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Pipe()
    Initializes a new instance of this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Pipe
    open()
    Opens a pipe.
    abstract Pipe.SinkChannel
    sink()
    Returns this pipe's sink channel.
    abstract Pipe.SourceChannel
    source()
    Returns this pipe's source channel.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • Pipe

      protected Pipe()
      Initializes a new instance of this class.

  • Method Details

    • source

      public abstract Pipe.SourceChannel source()
      Returns this pipe's source channel.
      Returns:
      This pipe's source channel

    • sink

      public abstract Pipe.SinkChannel sink()
      Returns this pipe's sink channel.
      Returns:
      This pipe's sink channel

    • open

      public static Pipe open() throws IOException
      Opens a pipe.

      The new pipe is created by invoking the openPipe method of the system-wide default SelectorProvider object.

      Returns:
      A new pipe
      Throws:
      IOException - If an I/O error occurs