1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// BEGIN android-note
// We've made several changes including:
// - avoid shallow concurrency problems
// - improved consistency with PipedWriter
// END android-note
package java.io;
import org.apache.harmony.luni.util.Msg;
/**
* Places information on a communications pipe. When two threads want to pass
* data back and forth, one creates a piped output stream and the other one
* creates a piped input stream.
*
* @see PipedInputStream
*/
public class PipedOutputStream extends OutputStream {
/**
* The destination PipedInputStream
*/
private PipedInputStream dest;
/**
* Constructs a new unconnected {@code PipedOutputStream}. The resulting
* stream must be connected to a {@link PipedInputStream} before data can be
* written to it.
*/
public PipedOutputStream() {
super();
}
/**
* Constructs a new {@code PipedOutputStream} connected to the
* {@link PipedInputStream} {@code dest}. Any data written to this stream
* can be read from the target stream.
*
* @param dest
* the piped input stream to connect to.
* @throws IOException
* if this stream or {@code dest} are already connected.
*/
public PipedOutputStream(PipedInputStream dest) throws IOException {
super();
connect(dest);
}
/**
* Closes this stream. If this stream is connected to an input stream, the
* input stream is closed and the pipe is disconnected.
*
* @throws IOException
* if an error occurs while closing this stream.
*/
@Override
public void close() throws IOException {
// Is the pipe connected?
PipedInputStream stream = dest;
if (stream != null) {
stream.done();
dest = null;
}
}
/**
* Connects this stream to a {@link PipedInputStream}. Any data written to
* this output stream becomes readable in the input stream.
*
* @param stream
* the destination input stream.
* @throws IOException
* if either stream is already connected.
*/
public void connect(PipedInputStream stream) throws IOException {
if (stream == null) {
throw new NullPointerException();
}
synchronized (stream) {
if (this.dest != null) {
throw new IOException(Msg.getString("K0079"));
}
if (stream.isConnected) {
throw new IOException(Msg.getString("K007a"));
}
stream.establishConnection();
this.dest = stream;
}
}
/**
* Notifies the readers of this {@link PipedInputStream} that bytes can be
* read. This method does nothing if this stream is not connected.
*
* @throws IOException
* if an I/O error occurs while flushing this stream.
*/
@Override
public void flush() throws IOException {
PipedInputStream stream = dest;
if (stream == null) {
return;
}
synchronized (stream) {
stream.notifyAll();
}
}
/**
* Writes {@code count} bytes from the byte array {@code buffer} starting at
* {@code offset} to this stream. The written data can then be read from the
* connected input stream.
* <p>
* Separate threads should be used to write to a {@code PipedOutputStream}
* and to read from the connected {@link PipedInputStream}. If the same
* thread is used, a deadlock may occur.
*
* @param buffer
* the buffer to write.
* @param offset
* the index of the first byte in {@code buffer} to write.
* @param count
* the number of bytes from {@code buffer} to write to this
* stream.
* @throws IndexOutOfBoundsException
* if {@code offset < 0} or {@code count < 0}, or if {@code
* offset + count} is bigger than the length of {@code buffer}.
* @throws InterruptedIOException
* if the pipe is full and the current thread is interrupted
* waiting for space to write data. This case is not currently
* handled correctly.
* @throws IOException
* if this stream is not connected, if the target stream is
* closed or if the thread reading from the target stream is no
* longer alive. This case is currently not handled correctly.
*/
@Override
public void write(byte[] buffer, int offset, int count) throws IOException {
super.write(buffer, offset, count);
}
/**
* Writes a single byte to this stream. Only the least significant byte of
* the integer {@code oneByte} is written. The written byte can then be read
* from the connected input stream.
* <p>
* Separate threads should be used to write to a {@code PipedOutputStream}
* and to read from the connected {@link PipedInputStream}. If the same
* thread is used, a deadlock may occur.
*
* @param oneByte
* the byte to write.
* @throws InterruptedIOException
* if the pipe is full and the current thread is interrupted
* waiting for space to write data. This case is not currently
* handled correctly.
* @throws IOException
* if this stream is not connected, if the target stream is
* closed or if the thread reading from the target stream is no
* longer alive. This case is currently not handled correctly.
*/
@Override
public void write(int oneByte) throws IOException {
PipedInputStream stream = dest;
if (stream == null) {
// K007b=Pipe Not Connected
throw new IOException(Msg.getString("K007b"));
}
stream.receive(oneByte);
}
}
|
