- 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 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 and Description static class
Pipe.SinkChannel
A channel representing the writable end of aPipe
.static class
Pipe.SourceChannel
A channel representing the readable end of aPipe
.
-
Constructor Summary
Constructors Modifier Constructor and Description protected
Pipe()
Initializes a new instance of this class.
-
Method Summary
Methods Modifier and Type Method and 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.
-
-
-
Method Detail
-
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 defaultSelectorProvider
object.- Returns:
- A new pipe
- Throws:
IOException
- If an I/O error occurs
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/nio/channels/pipe.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.