Package org.glassfish.grizzly.http.io

Interface BinaryNIOInputSource

All Superinterfaces:

InputSource

All Known Implementing Classes:

NIOInputStream

public interface BinaryNIOInputSource
extends InputSource

Adds the ability for binary based InputSources to obtain the incoming Buffer directly without having to use intermediate objects to copy the data to.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
Buffer	getBuffer()	Returns the the duplicate of the underlying Buffer that backs this InputSource.
Buffer	readBuffer()	Returns the underlying Buffer that backs this InputSource.
Buffer	readBuffer(int size)	Returns the Buffer of a given size, which represents a chunk of the underlying Buffer that backs this InputSource.

Methods inherited from interface org.glassfish.grizzly.InputSource

isFinished, isReady, notifyAvailable, notifyAvailable, readyData

Method Details

getBuffer

Buffer getBuffer()

Returns the the duplicate of the underlying Buffer that backs this InputSource. The content of the returned buffer will be that of the underlying buffer. Changes to returned buffer's content will be visible in the underlying buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

Returns:

the duplicate of the underlying Buffer that backs this InputSource.

readBuffer

Buffer readBuffer()

Returns the underlying Buffer that backs this InputSource. Unlike getBuffer(), this method detaches the returned Buffer, so user becomes responsible for handling the Buffer's life-cycle.

Returns:

the underlying Buffer that backs this InputSource.

readBuffer

Buffer readBuffer(int size)

Returns the Buffer of a given size, which represents a chunk of the underlying Buffer that backs this InputSource. Unlike getBuffer(), this method detaches the returned Buffer, so user becomes responsible for handling the Buffer's life-cycle.

Parameters:

size - the requested size of the Buffer to be returned.

Returns:

the Buffer of a given size, which represents a chunk of the underlying Buffer which contains incoming request data. This method detaches the returned Buffer, so user code becomes responsible for handling its life-cycle.