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

Class SessionOutputBufferImpl

java.lang.Object

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

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

All Implemented Interfaces:

SessionOutputBuffer

class SessionOutputBufferImpl
extends ExpandableBuffer
implements SessionOutputBuffer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hc.core5.http.impl.nio.ExpandableBuffer

ExpandableBuffer.Mode

Field Summary

Fields

Modifier and Type	Field	Description
private CharBuffer	charbuffer
private final CharsetEncoder	charEncoder
private static final byte[]	CRLF
private final int	lineBufferSize

Constructor Summary

Constructors

Constructor	Description
SessionOutputBufferImpl(int bufferSize)
SessionOutputBufferImpl(int bufferSize, int lineBufferSize)
SessionOutputBufferImpl(int bufferSize, int lineBufferSize, Charset charset)
SessionOutputBufferImpl(int bufferSize, int lineBufferSize, CharsetEncoder charEncoder)	Creates SessionOutputBufferImpl instance.

Method Summary

Modifier and Type	Method	Description
int	capacity()	Returns available capacity of this buffer.
int	flush(WritableByteChannel channel)	Makes an attempt to flush the content of this buffer to the given destination WritableByteChannel.
boolean	hasData()	Determines if the buffer contains data.
int	length()	Returns the length of this buffer.
private void	write(byte[] b)
void	write(ByteBuffer src)	Copies content of the source buffer into this buffer.
void	write(ReadableByteChannel src)	Reads a sequence of bytes from the source channel into this buffer.
private void	writeCRLF()
void	writeLine(CharArrayBuffer lineBuffer)	Copies content of the source buffer into this buffer as one line of text including a line delimiter.

Methods inherited from class org.apache.hc.core5.http.impl.nio.ExpandableBuffer

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

Methods inherited from class java.lang.Object

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

Field Details

CRLF

private static final byte[] CRLF

charEncoder

private final CharsetEncoder charEncoder

lineBufferSize

private final int lineBufferSize

charbuffer

private CharBuffer charbuffer

Constructor Details

SessionOutputBufferImpl

public SessionOutputBufferImpl(int bufferSize,
 int lineBufferSize,
 CharsetEncoder charEncoder)

Creates SessionOutputBufferImpl instance.

Parameters:

bufferSize - input buffer size

lineBufferSize - buffer size for line operations. Has effect only if charEncoder is not null.

charEncoder - charEncoder to be used for encoding HTTP protocol elements. If null simple type cast will be used for char to byte conversion.

Since:

4.3

SessionOutputBufferImpl

public SessionOutputBufferImpl(int bufferSize,
 int lineBufferSize,
 Charset charset)

Since:

4.3

SessionOutputBufferImpl

public SessionOutputBufferImpl(int bufferSize,
 int lineBufferSize)

Since:

4.3

SessionOutputBufferImpl

public SessionOutputBufferImpl(int bufferSize)

Since:

4.3

Method Details

length

public int length()

Description copied from class: ExpandableBuffer

Returns the length of this buffer.

Sets the mode to output.

Specified by:

length in interface SessionOutputBuffer

Overrides:

length in class ExpandableBuffer

Returns:

buffer length.

hasData

public boolean hasData()

Description copied from class: ExpandableBuffer

Determines if the buffer contains data.

Sets the mode to output.

Specified by:

hasData in interface SessionOutputBuffer

Overrides:

hasData in class ExpandableBuffer

Returns:

true if there is data in the buffer, false otherwise.

capacity

public int capacity()

Description copied from class: ExpandableBuffer

Returns available capacity of this buffer.

Specified by:

capacity in interface SessionOutputBuffer

Overrides:

capacity in class ExpandableBuffer

Returns:

buffer length.

flush

public int flush(WritableByteChannel channel)
          throws IOException

Description copied from interface: SessionOutputBuffer

Makes an attempt to flush the content of this buffer to the given destination WritableByteChannel.

Specified by:

flush in interface SessionOutputBuffer

Parameters:

channel - the destination channel.

Returns:

The number of bytes written, possibly zero.

Throws:

IOException - in case of an I/O error.

write

public void write(ByteBuffer src)

Description copied from interface: SessionOutputBuffer

Copies content of the source buffer into this buffer. The capacity of the destination will be expanded in order to accommodate the entire content of the source buffer.

Specified by:

write in interface SessionOutputBuffer

Parameters:

src - the source buffer.

write

public void write(ReadableByteChannel src)
           throws IOException

Description copied from interface: SessionOutputBuffer

Reads a sequence of bytes from the source channel into this buffer.

Specified by:

write in interface SessionOutputBuffer

Parameters:

src - the source channel.

Throws:

IOException

write

private void write(byte[] b)

writeCRLF

private void writeCRLF()

writeLine

public void writeLine(CharArrayBuffer lineBuffer)
               throws CharacterCodingException

Description copied from interface: SessionOutputBuffer

Copies content of the source buffer into this buffer as one line of text including a line delimiter. The capacity of the destination will be expanded in order to accommodate the entire content of the source buffer.

The choice of a char encoding and line delimiter sequence is up to the specific implementations of this interface.

Specified by:

writeLine in interface SessionOutputBuffer

Parameters:

lineBuffer - the source buffer.

Throws:

CharacterCodingException