sirius.web.http

Class InputStreamHandler

java.lang.Object

java.io.InputStream

sirius.web.http.InputStreamHandler

All Implemented Interfaces:

Closeable, AutoCloseable, ContentHandler

public class InputStreamHandler
extends InputStream
implements ContentHandler

Default implementation of ContentHandler used by ControllerDispatcher.

This handler receives chunks of data which are stored in an internal buffer. This buffer can be accessed via the familiar InputStream interface. Note that the methods of this implementation might block if either the internal buffer is full, or if no content is currently readable.

For stability reasons all blocking methods timeout after a given interval of time leading the handle to be in an error state. Therefore all incoming data will be discarded and all read requests will fail as some data might have already been lost anyway.

Constructor Summary

Constructors

Constructor and Description
InputStreamHandler() Creates a new handler with default settings for buffer size and timeouts.
InputStreamHandler(int bufferDepth, int readTimeout, int writeTimeout, TimeUnit unit) Creates a new handler with the given buffer size and timeouts.

Method Summary

Modifier and Type	Method and Description
int	available()
void	cleanup() Invoked once the request is completely handled or the underlying channel was closed.
void	close()
void	handle(ByteBuf content, boolean last) Handles the given chunk of data.
boolean	isFailed() Determines if this stream is in an ERROR state or not.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.InputStream

read

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStreamHandler

public InputStreamHandler()

Creates a new handler with default settings for buffer size and timeouts.

InputStreamHandler

public InputStreamHandler(int bufferDepth,
                          int readTimeout,
                          int writeTimeout,
                          TimeUnit unit)

Creates a new handler with the given buffer size and timeouts.

Parameters:

bufferDepth - controls how many chunks are kept in memory before the next call to handle(io.netty.buffer.ByteBuf, boolean) blocks until some data is read from the buffer. Although the number of chunks does not provide an exact measure of the buffer size, it should provide a raw estimate as incoming chunks will be between 1024 and 8192 bytes in size.

readTimeout - contains maximal amount of time a reading thread is blocked, waiting for new data, before the operation is cancelled by a timeout

writeTimeout - contains maximal amount of time a writing thread is blocked, waiting for buffer space, before the operation is cancelled by a timeout

unit - specifies the time unit used by readTimeout and writeTimeout

Method Detail

handle

public void handle(ByteBuf content,
                   boolean last)
            throws IOException

Description copied from interface: ContentHandler

Handles the given chunk of data.

Specified by:

handle in interface ContentHandler

Parameters:

content - the data sent by the client. The buffer might be of size 0 but not null.

last - a flag signalling if this will be the last chunk of data

Throws:

IOException - if case of an error (e.g. response already sent...)

cleanup

public void cleanup()
             throws IOException

Description copied from interface: ContentHandler

Invoked once the request is completely handled or the underlying channel was closed.

Can be used to release all internal buffers.

Specified by:

cleanup in interface ContentHandler

Throws:

IOException - in case of an internal error

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

isFailed

public boolean isFailed()

Determines if this stream is in an ERROR state or not.

Returns:

true if a failure occurred, false otherwise