Java Doc for PipedInputStream.java in  » 6.0-JDK-Modules » j2me » java » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.InputStream
      java.io.PipedInputStream

PipedInputStream
public class PipedInputStream extends InputStream (Code)
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 a PipedInputStream object by one thread and data is written to the corresponding PipedOutputStream 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.
author:
   James Gosling
version:
   1.30, 02/02/00
See Also:   java.io.PipedOutputStream
since:
   JDK1.0


Field Summary
final protected static  intPIPE_SIZE
     The size of the pipe's circular input buffer.
protected  bytebuffer
     The circular buffer into which incoming data is placed.
 booleanclosedByReader
    
 booleanclosedByWriter
    
 booleanconnected
    
protected  intin
     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  intout
     The index of the position in the circular buffer at which the next byte of data will be read by this piped input stream.
 ThreadreadSide
    
 ThreadwriteSide
    

Constructor Summary
public  PipedInputStream(PipedOutputStream src)
     Creates a PipedInputStream so that it is connected to the piped output stream src.
public  PipedInputStream()
     Creates a PipedInputStream so that it is not yet connected.

Method Summary
public synchronized  intavailable()
     Returns the number of bytes that can be read from this input stream without blocking.
public  voidclose()
     Closes this piped input stream and releases any system resources associated with the stream.
public  voidconnect(PipedOutputStream src)
     Causes this piped input stream to be connected to the piped output stream src.
public synchronized  intread()
     Reads the next byte of data from this piped input stream.
public synchronized  intread(byte b, int off, int len)
     Reads up to len bytes of data from this piped input stream into an array of bytes.
protected synchronized  voidreceive(int b)
     Receives a byte of data.
synchronized  voidreceive(byte b, int off, int len)
     Receives data into an array of bytes.
synchronized  voidreceivedLast()
     Notifies all waiting threads that the last byte of data has been received.

Field Detail
PIPE_SIZE
final protected static int PIPE_SIZE(Code)
The size of the pipe's circular input buffer.
since:
   JDK1.1



buffer
protected byte buffer(Code)
The circular buffer into which incoming data is placed.
since:
   JDK1.1



closedByReader
boolean closedByReader(Code)



closedByWriter
boolean closedByWriter(Code)



connected
boolean connected(Code)



in
protected int in(Code)
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(Code)
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



readSide
Thread readSide(Code)



writeSide
Thread writeSide(Code)




Constructor Detail
PipedInputStream
public PipedInputStream(PipedOutputStream src) throws IOException(Code)
Creates a PipedInputStream so that it is connected to the piped output stream src. Data bytes written to src will then be available as input from this stream.
Parameters:
  src - the stream to connect to.
exception:
  IOException - if an I/O error occurs.



PipedInputStream
public PipedInputStream()(Code)
Creates a PipedInputStream so that it is not yet connected. It must be connected to a PipedOutputStream before being used.
See Also:   java.io.PipedInputStream.connect(java.io.PipedOutputStream)
See Also:   java.io.PipedOutputStream.connect(java.io.PipedInputStream)




Method Detail
available
public synchronized int available() throws IOException(Code)
Returns the number of bytes that can be read from this input stream without blocking. This method overrides the available method of the parent class. the number of bytes that can be read from this input streamwithout blocking.
exception:
  IOException - if an I/O error occurs.
since:
   JDK1.0.2



close
public void close() throws IOException(Code)
Closes this piped input stream and releases any system resources associated with the stream.
exception:
  IOException - if an I/O error occurs.



connect
public void connect(PipedOutputStream src) throws IOException(Code)
Causes this piped input stream to be connected to the piped output stream src. If this object is already connected to some other piped output stream, an IOException is thrown.

If src is an unconnected piped output stream and snk 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.
exception:
  IOException - if an I/O error occurs.




read
public synchronized int read() throws IOException(Code)
Reads the next byte of data from this piped input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. If a thread was providing data bytes to the connected piped output stream, but the thread is no longer alive, then an IOException is thrown. the next byte of data, or -1 if the end of thestream is reached.
exception:
  IOException - if the pipe is broken.



read
public synchronized int read(byte b, int off, int len) throws IOException(Code)
Reads up to len bytes of data from this piped input stream into an array of bytes. Less than len bytes will be read if the end of the data stream is reached. This method blocks until at least one byte of input is available. If a thread was providing data bytes to the connected piped output stream, but the thread is no longer alive, then an IOException is thrown.
Parameters:
  b - the buffer into which the data is read.
Parameters:
  off - the start offset of the data.
Parameters:
  len - the maximum number of bytes read. the total number of bytes read into the buffer, or-1 if there is no more data because the end ofthe stream has been reached.
exception:
  IOException - if an I/O error occurs.



receive
protected synchronized void receive(int b) throws IOException(Code)
Receives a byte of data. This method will block if no input is available.
Parameters:
  b - the byte being received
exception:
  IOException - If the pipe is broken.
since:
   JDK1.1



receive
synchronized void receive(byte b, int off, int len) throws IOException(Code)
Receives data into an array of bytes. This method will block until some input is available.
Parameters:
  b - the buffer into which the data is received
Parameters:
  off - the start offset of the data
Parameters:
  len - the maximum number of bytes received the actual number of bytes received, -1 isreturned when the end of the stream is reached.
exception:
  IOException - If an I/O error has occurred.



receivedLast
synchronized void receivedLast()(Code)
Notifies all waiting threads that the last byte of data has been received.



Methods inherited from java.io.InputStream
public int available() throws IOException(Code)(Java Doc)
public void close() throws IOException(Code)(Java Doc)
public synchronized void mark(int readlimit)(Code)(Java Doc)
public boolean markSupported()(Code)(Java Doc)
abstract public int read() throws IOException(Code)(Java Doc)
public int read(byte b) throws IOException(Code)(Java Doc)
public int read(byte b, int off, int len) throws IOException(Code)(Java Doc)
public synchronized void reset() throws IOException(Code)(Java Doc)
public long skip(long n) throws IOException(Code)(Java Doc)

Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.