- java.lang.Object
-
- java.io.InputStream
-
- java.io.PipedInputStream
-
- All Implemented Interfaces:
- Closeable, AutoCloseable
public class PipedInputStream extends InputStream
A piped input stream should be connected to a piped output stream; the piped input stream then provides whatever data bytes are written to the piped output stream. Typically, data is read from aPipedInputStream
object by one thread and data is written to the correspondingPipedOutputStream
by some other thread. Attempting to use both objects from a single thread is not recommended, as it may deadlock the thread. The piped input stream contains a buffer, decoupling read operations from write operations, within limits. A pipe is said to be broken if a thread that was providing data bytes to the connected piped output stream is no longer alive.- Since:
- JDK1.0
- See Also:
PipedOutputStream
-
-
Field Summary
Fields Modifier and Type Field and Description protected byte[]
buffer
The circular buffer into which incoming data is placed.protected int
in
The index of the position in the circular buffer at which the next byte of data will be stored when received from the connected piped output stream.protected int
out
The index of the position in the circular buffer at which the next byte of data will be read by this piped input stream.protected static int
PIPE_SIZE
The default size of the pipe's circular input buffer.
-
Constructor Summary
Constructors Constructor and Description PipedInputStream()
Creates aPipedInputStream
so that it is not yet connected.PipedInputStream(int pipeSize)
Creates aPipedInputStream
so that it is not yet connected and uses the specified pipe size for the pipe's buffer.PipedInputStream(PipedOutputStream src)
Creates aPipedInputStream
so that it is connected to the piped output streamsrc
.PipedInputStream(PipedOutputStream src, int pipeSize)
Creates aPipedInputStream
so that it is connected to the piped output streamsrc
and uses the specified pipe size for the pipe's buffer.
-
Method Summary
Methods Modifier and Type Method and Description int
available()
Returns the number of bytes that can be read from this input stream without blocking.void
close()
Closes this piped input stream and releases any system resources associated with the stream.void
connect(PipedOutputStream src)
Causes this piped input stream to be connected to the piped output streamsrc
.int
read()
Reads the next byte of data from this piped input stream.int
read(byte[] b, int off, int len)
Reads up tolen
bytes of data from this piped input stream into an array of bytes.protected void
receive(int b)
Receives a byte of data.-
Methods inherited from class java.io.InputStream
mark, markSupported, read, reset, skip
-
-
-
-
Field Detail
-
PIPE_SIZE
protected static final int PIPE_SIZE
The default size of the pipe's circular input buffer.- Since:
- JDK1.1
- See Also:
- Constant Field Values
-
buffer
protected byte[] buffer
The circular buffer into which incoming data is placed.- Since:
- JDK1.1
-
in
protected int in
The index of the position in the circular buffer at which the next byte of data will be stored when received from the connected piped output stream.in<0
implies the buffer is empty,in==out
implies the buffer is full- Since:
- JDK1.1
-
out
protected int out
The index of the position in the circular buffer at which the next byte of data will be read by this piped input stream.- Since:
- JDK1.1
-
-
Constructor Detail
-
PipedInputStream
public PipedInputStream(PipedOutputStream src) throws IOException
Creates aPipedInputStream
so that it is connected to the piped output streamsrc
. Data bytes written tosrc
will then be available as input from this stream.- Parameters:
src
- the stream to connect to.- Throws:
IOException
- if an I/O error occurs.
-
PipedInputStream
public PipedInputStream(PipedOutputStream src, int pipeSize) throws IOException
Creates aPipedInputStream
so that it is connected to the piped output streamsrc
and uses the specified pipe size for the pipe's buffer. Data bytes written tosrc
will then be available as input from this stream.- Parameters:
src
- the stream to connect to.pipeSize
- the size of the pipe's buffer.- Throws:
IOException
- if an I/O error occurs.IllegalArgumentException
- ifpipeSize <= 0
.- Since:
- 1.6
-
PipedInputStream
public PipedInputStream()
-
PipedInputStream
public PipedInputStream(int pipeSize)
Creates aPipedInputStream
so that it is not yet connected and uses the specified pipe size for the pipe's buffer. It must be connected to aPipedOutputStream
before being used.- Parameters:
pipeSize
- the size of the pipe's buffer.- Throws:
IllegalArgumentException
- ifpipeSize <= 0
.- Since:
- 1.6
-
-
Method Detail
-
connect
public void connect(PipedOutputStream src) throws IOException
Causes this piped input stream to be connected to the piped output streamsrc
. If this object is already connected to some other piped output stream, anIOException
is thrown.If
src
is an unconnected piped output stream andsnk
is an unconnected piped input stream, they may be connected by either the call:snk.connect(src)
or the call:
src.connect(snk)
The two calls have the same effect.
- Parameters:
src
- The piped output stream to connect to.- Throws:
IOException
- if an I/O error occurs.
-
receive
protected void receive(int b) throws IOException
Receives a byte of data. This method will block if no input is available.- Parameters:
b
- the byte being received- Throws:
IOException
- If the pipe isbroken
,unconnected
, closed, or if an I/O error occurs.- Since:
- JDK1.1
-
read
public int read() throws IOException
Reads the next byte of data from this piped input stream. The value byte is returned as anint
in the range0
to255
. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.- Specified by:
read
in classInputStream
- Returns:
- the next byte of data, or
-1
if the end of the stream is reached. - Throws:
IOException
- if the pipe isunconnected
,broken
, closed, or if an I/O error occurs.
-
read
public int read(byte[] b, int off, int len) throws IOException
Reads up tolen
bytes of data from this piped input stream into an array of bytes. Less thanlen
bytes will be read if the end of the data stream is reached or iflen
exceeds the pipe's buffer size. Iflen
is zero, then no bytes are read and 0 is returned; otherwise, the method blocks until at least 1 byte of input is available, end of the stream has been detected, or an exception is thrown.- Overrides:
read
in classInputStream
- Parameters:
b
- the buffer into which the data is read.off
- the start offset in the destination arrayb
len
- the maximum number of bytes read.- Returns:
- the total number of bytes read into the buffer, or
-1
if there is no more data because the end of the stream has been reached. - Throws:
NullPointerException
- Ifb
isnull
.IndexOutOfBoundsException
- Ifoff
is negative,len
is negative, orlen
is greater thanb.length - off
IOException
- if the pipe isbroken
,unconnected
, closed, or if an I/O error occurs.- See Also:
InputStream.read()
-
available
public int available() throws IOException
Returns the number of bytes that can be read from this input stream without blocking.- Overrides:
available
in classInputStream
- Returns:
- the number of bytes that can be read from this input stream
without blocking, or
0
if this input stream has been closed by invoking itsclose()
method, or if the pipe isunconnected
, orbroken
. - Throws:
IOException
- if an I/O error occurs.- Since:
- JDK1.0.2
-
close
public void close() throws IOException
Closes this piped input stream and releases any system resources associated with the stream.- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
- if an I/O error occurs.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/io/PipedInputStream.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.