Class SharedOutputBuffer

java.lang.Object

org.apache.hc.core5.http.impl.nio.ExpandableBuffer

org.apache.hc.core5.http.nio.support.classic.AbstractSharedBuffer

org.apache.hc.core5.http.nio.support.classic.SharedOutputBuffer

All Implemented Interfaces:

ContentOutputBuffer

@Contract(threading=SAFE)
public final class SharedOutputBuffer
extends AbstractSharedBuffer
implements ContentOutputBuffer

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from class ExpandableBuffer

ExpandableBuffer.Mode

Field Summary

Fields

Modifier and Type	Field	Description
private DataStreamChannel	dataStreamChannel
private final AtomicBoolean	endStreamPropagated
private boolean	hasCapacity

Fields inherited from class AbstractSharedBuffer

aborted, condition, endStream, lock

Constructor Summary

Constructors

Constructor	Description
SharedOutputBuffer(int bufferSize)
SharedOutputBuffer(ReentrantLock lock, int initialBufferSize)

Method Summary

Modifier and Type	Method	Description
private void	ensureNotAborted()
void	flush(DataStreamChannel channel)
private void	propagateEndStream()
private void	waitEndStream(Timeout timeout)
private void	waitFlush(Timeout timeout)
private void	waitForSignal(Timeout timeout)
void	write(byte[] b, int off, int len)	Writes len bytes from the specified byte array starting at offset off to this buffer.
void	write(byte[] b, int off, int len, Timeout timeout)
void	write(int b)	Writes the specified byte to this buffer.
void	write(int b, Timeout timeout)
void	writeCompleted()	Indicates the content has been fully written.
void	writeCompleted(Timeout timeout)

Methods inherited from class AbstractSharedBuffer

abort, capacity, hasData, isEndStream, length, reset

Methods inherited from class ExpandableBuffer

buffer, clear, ensureAdjustedCapacity, ensureCapacity, expand, mode, setInputMode, setOutputMode, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ContentOutputBuffer

length, reset

Field Details

endStreamPropagated

private final AtomicBoolean endStreamPropagated

dataStreamChannel

private volatile DataStreamChannel dataStreamChannel

hasCapacity

private volatile boolean hasCapacity

Constructor Details

SharedOutputBuffer

public SharedOutputBuffer(ReentrantLock lock,
 int initialBufferSize)

SharedOutputBuffer

public SharedOutputBuffer(int bufferSize)

Method Details

flush

public void flush(DataStreamChannel channel)
           throws IOException

Throws:

IOException

ensureNotAborted

private void ensureNotAborted()
                       throws InterruptedIOException

Throws:

InterruptedIOException

write

public void write(byte[] b,
 int off,
 int len,
 Timeout timeout)
           throws IOException

Throws:

IOException

Since:

5.4

write

public void write(byte[] b,
 int off,
 int len)
           throws IOException

Description copied from interface: ContentOutputBuffer

Writes len bytes from the specified byte array starting at offset off to this buffer.

If off is negative, or len is negative, or off+len is greater than the length of the array b, this method can throw a runtime exception. The exact type of runtime exception thrown by this method depends on implementation.

Specified by:

write in interface ContentOutputBuffer

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

IOException - if an I/O error occurs.

write

public void write(int b,
 Timeout timeout)
           throws IOException

Throws:

IOException

Since:

5.4

write

public void write(int b)
           throws IOException

Description copied from interface: ContentOutputBuffer

Writes the specified byte to this buffer.

Specified by:

write in interface ContentOutputBuffer

Parameters:

b - the byte.

Throws:

IOException - if an I/O error occurs.

writeCompleted

public void writeCompleted(Timeout timeout)
                    throws IOException

Throws:

IOException

Since:

5.4

writeCompleted

public void writeCompleted()
                    throws IOException

Description copied from interface: ContentOutputBuffer

Indicates the content has been fully written.

Specified by:

writeCompleted in interface ContentOutputBuffer

Throws:

IOException - if an I/O error occurs.

waitFlush

private void waitFlush(Timeout timeout)
                throws InterruptedIOException

Throws:

InterruptedIOException

waitEndStream

private void waitEndStream(Timeout timeout)
                    throws InterruptedIOException

Throws:

InterruptedIOException

waitForSignal

private void waitForSignal(Timeout timeout)
                    throws InterruptedIOException

Throws:

InterruptedIOException

propagateEndStream

private void propagateEndStream()
                         throws IOException

Throws:

IOException