Package net.targetr.wtm3.io

Class ChunkedOutputStream

java.lang.Object

java.io.OutputStream

net.targetr.wtm3.io.ChunkedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ChunkedOutputStream
extends OutputStream

Writes a chunked output stream.

Used by HTTP/1.1 to transfer content of unknown length.

Author:

Dr Michael Gardiner

Field Summary

Fields

Modifier and Type	Field	Description
static int	CHUNKING_BUFFER_SIZE	The size recommended when writing chunked data.
static int	CHUNKING_WRITE_DELAY	The time in milliseconds to delay writing data to ensure chunks are a sensible size.

Constructor Summary

Constructors

Constructor	Description
ChunkedOutputStream(OutputStream out)	Decorates an output stream to enable writing in chunks to a HTTP/1.1 client.

Method Summary

Modifier and Type	Method	Description
void	close()
void	finish()	Sends the last chunk but does not close the stream.
void	flush()
String	toString()
void	write(byte[] data, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Field Details

CHUNKING_BUFFER_SIZE

public static int CHUNKING_BUFFER_SIZE

The size recommended when writing chunked data.

CHUNKING_WRITE_DELAY

public static int CHUNKING_WRITE_DELAY

The time in milliseconds to delay writing data to ensure chunks are a sensible size.

Constructor Details

ChunkedOutputStream

public ChunkedOutputStream(OutputStream out)

Decorates an output stream to enable writing in chunks to a HTTP/1.1 client.

Parameters:

out - The chunked output stream.

Method Details

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

finish

public void finish()
            throws IOException

Sends the last chunk but does not close the stream. This is important when keep-alive is enabled.

Throws:

IOException - If there is an error writing the last chunk.

toString

public String toString()

Overrides:

toString in class Object