Top Description Methods
org.apache.http.io

public Interface SessionOutputBuffer

Known Direct Implementers
org.apache.http.impl.io.AbstractSessionOutputBuffer, org.apache.http.impl.io.SessionOutputBufferImpl
Imports
java.io.IOException, org.apache.http.util.CharArrayBuffer
Session output buffer for blocking connections. This interface is similar to OutputStream class, but it also provides methods for writing lines of text.

Implementing classes are also expected to manage intermediate data buffering for optimal output performance.

Since
4.0

Method Summary

Modifier and TypeMethod and Description
public void
flush()

Flushes this session buffer and forces any buffered output bytes to be written out.

public HttpTransportMetrics

Returns:

transport metrics.
getMetrics()

Returns HttpTransportMetrics for this session buffer.

public void
write(byte[]
the data.
b, int
the start offset in the data.
off, int
the number of bytes to write.
len)

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

public void
write(byte[]
the data.
b)

Writes b.length bytes from the specified byte array to this session buffer.

public void
write(int
the byte.
b)

Writes the specified byte to this session buffer.

public void
writeLine(String
the line.
s)

Writes characters from the specified string followed by a line delimiter to this session buffer.

public void
writeLine(CharArrayBuffer
the buffer containing chars of the line.
buffer)

Writes characters from the specified char array followed by a line delimiter to this session buffer.

Method Detail

flushback to summary
public void flush() throws IOException

Flushes this session buffer and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

Exceptions
IOException:
if an I/O error occurs.
getMetricsback to summary
public HttpTransportMetrics getMetrics()

Returns HttpTransportMetrics for this session buffer.

Returns:HttpTransportMetrics

transport metrics.

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

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

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(byte[] b) throws IOException

Writes b.length bytes from the specified byte array to this session buffer.

Parameters
b:byte[]

the data.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(int b) throws IOException

Writes the specified byte to this session buffer.

Parameters
b:int

the byte.

Exceptions
IOException:
if an I/O error occurs.
writeLineback to summary
public void writeLine(String s) throws IOException

Writes characters from the specified string followed by a line delimiter to this session buffer.

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

Parameters
s:String

the line.

Exceptions
IOException:
if an I/O error occurs.
writeLineback to summary
public void writeLine(CharArrayBuffer buffer) throws IOException

Writes characters from the specified char array followed by a line delimiter to this session buffer.

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

Parameters
buffer:CharArrayBuffer

the buffer containing chars of the line.

Exceptions
IOException:
if an I/O error occurs.