Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.io.SessionOutputBuffer

Method Summary

Modifier and Type	Method and Description
public int	Returns: available space. available() Returns available space in the buffer.
public int	Returns: total capacity capacity() Returns total capacity of the buffer
public void	flush(OutputStream outputStream) 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 int	Returns: data length length() Return length data stored in the buffer
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len, OutputStream outputStream) Writes `len` bytes from the specified byte array starting at offset `off` to this session buffer.
public void	write(byte[] the data. b, OutputStream outputStream) Writes `b.length` bytes from the specified byte array to this session buffer.
public void	write(int the `byte`. b, OutputStream outputStream) Writes the specified byte to this session buffer.
public void	writeLine(CharArrayBuffer the buffer containing chars of the line. buffer, OutputStream outputStream) Writes characters from the specified char array followed by a line delimiter to this session buffer.

Method Detail

available	back to summary
public int available() Returns available space in the buffer. Returns:int available space.

available

back to summary

public int available()

Returns available space in the buffer.

Returns:int: available space.

capacity	back to summary
public int capacity() Returns total capacity of the buffer Returns:int total capacity

capacity

back to summary

public int capacity()

Returns total capacity of the buffer

Returns:int: total capacity

flush back to summary

flush	back to summary
public void flush(OutputStream outputStream) 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.

public void flush(OutputStream outputStream) 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.

getMetrics back to summary

getMetrics	back to summary
public HttpTransportMetrics getMetrics() Returns `HttpTransportMetrics` for this session buffer. Returns:HttpTransportMetrics transport metrics.

public HttpTransportMetrics getMetrics()

Returns HttpTransportMetrics for this session buffer.

Returns:HttpTransportMetrics: transport metrics.

length	back to summary
public int length() Return length data stored in the buffer Returns:int data length

length

back to summary

public int length()

Return length data stored in the buffer

Returns:int: data length

write back to summary

write	back to summary
public void write(byte[] b, int off, int len, OutputStream outputStream) 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.

public void write(byte[] b, int off, int len, OutputStream outputStream) 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.

write back to summary

write	back to summary
public void write(byte[] b, OutputStream outputStream) 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.

public void write(byte[] b, OutputStream outputStream) 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.

write back to summary

write	back to summary
public void write(int b, OutputStream outputStream) throws IOException Writes the specified byte to this session buffer. Parameters b:int the `byte`. Exceptions IOException: if an I/O error occurs.

public void write(int b, OutputStream outputStream) throws IOException

Writes the specified byte to this session buffer.

Parameters

b:int: the byte.

Exceptions

IOException:: if an I/O error occurs.

writeLine	back to summary
public void writeLine(CharArrayBuffer buffer, OutputStream outputStream) 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.

writeLine

back to summary

public void writeLine(CharArrayBuffer buffer, OutputStream outputStream) 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.

public Interface SessionOutputBuffer

Method Summary

Method Detail