Java PipedOutputStream

In this tutorial we will discuss about the PipedOutputStream.

Java PipedOutputStream

In this tutorial we will discuss about the PipedOutputStream.

java.io package contains a class PipedOutputStream which can be connected to the PipedInputStream, used for creating communication pipe. In the PipedOutputStream data is written by a thread which is send to the connected PipedInputStream to read the data bytes, these data bytes of PipedInputStream is read by the other thread. Objects of both PipedInputStream and PipedOutputStream should not be used by a single thread this may cause a deadlocking of thread. If the pipe (which provides the data bytes to the connected piped input stream) is not longer alive then the pipe is called broken.

There are two constructors of PipedOutputStream to create its object :

Methods of PipedOutputStream

Commonly used methods of PipedOutputStream are as follows :

• write(int b) : This method is used to write the specified byte into the piped output stream.
  
  Syntax : public void write(int b) throws IOException
  
  
• write(byte[] b, int off, int len) : This method is used to write the specified length (len) of byte from the specified byte array (b), started from the specified offset 'off' into the piped output stream.
  
  Syntax : public void write(byte[] b,int off, int len) throws IOException
  
• connect(PipedInputStream snk) : This method is used to connect the piped output stream with piped input stream.
  
  Syntax : public void connect(PipedInputStream snk) throws IOException
  
• close() : This method is used to close the piped output stream and after that releases the resources associated with the piped output stream.
  
  Syntax : public void close() throws IOException
  
• flush() : This method is used to flush the piped output stream and then allow the buffered output bytes to write out.
  
  Syntax : public void flush() throws IOException

Example :

Here I am giving a simple example which demonstrates that how to write bytes to the piped output stream. In this example you will see that the piped output stream is connected to the piped input stream by using the method connect(). Then write the bytes to the piped output stream using write(int b) method and read these written bytes i.e. read the piped input stream bytes using the read(int b) method of PipedInputStream. As result I have format the output i.e. converted the written bytes into the corresponding characters by wrapping the integer value with 'char'.

Source Code :

import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.IOException;

public class PipedOutputStreamExample 
{

   public static void main(String[] args)
    {

      PipedOutputStream pos = new PipedOutputStream();
      PipedInputStream pis = new PipedInputStream();

      try {
	//connect the piped output stream with piped input stream

	pos.connect(pis);
        // Write to the PipedOutputStream
        pos.write(82);
        pos.write(79);
	pos.write(83);
	pos.write(69);
	pos.write(73);
	pos.write(78);
	pos.write(68);
	pos.write(73);
	pos.write(65);	
	
        // read the PipedInputStream
              
	int c;
	System.out.println();
	System.out.println("Written bytes are converted to the corresponding character : ");
	System.out.println();
        while((c = pis.read() ) != -1)
	{
	   System.out.print((char) c);
	}              
       }
       catch (IOException ioe) 
          {
             System.out.println(ioe);
          }
      }// main closed
}// class closed

Output :

When you will execute the above example you will get the output as follows :

Download Source Code