org.glassfish.grizzly.http.server.io
Class NIOReader

java.lang.Object
  java.io.Reader
      org.glassfish.grizzly.http.server.io.NIOReader

All Implemented Interfaces:

Closeable, Readable, NIOInputSource

public class NIOReader
extends Reader
implements NIOInputSource

Character stream implementation used to read character-based request content.

Since:

2.0

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

NIOReader(InputBuffer inputBuffer)
Constructs a new NIOReader using the specified inputBuffer

Method Summary

void	close()
Buffer	getBuffer() Returns the underlying Buffer that backs this NIOInputSource.
boolean	isFinished()
boolean	isReady()
void	mark(int readAheadLimit)
boolean	markSupported() This Reader implementation does not support marking.
boolean	notifyAvailable(ReadHandler handler) Notify the specified ReadHandler when any number of bytes can be read without blocking.
boolean	notifyAvailable(ReadHandler handler, int size) Notify the specified ReadHandler when the number of characters that can be read without blocking is greater or equal to the specified size.
int	read()
int	read(char[] cbuf)
int	read(char[] cbuf, int off, int len)
int	read(CharBuffer target)
boolean	ready()
int	readyData()
void	reset()
long	skip(long n)

Methods inherited from class java.lang.Object

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

Constructor Detail

NIOReader

public NIOReader(InputBuffer inputBuffer)

Constructs a new NIOReader using the specified inputBuffer

Parameters:

inputBuffer - the InputBuffer from which character content will be supplied

Method Detail

read

public int read(CharBuffer target)
         throws IOException

Specified by:

read in interface Readable

Overrides:

read in class Reader

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] cbuf)
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class Reader

Throws:

IOException

ready

public boolean ready()
              throws IOException

Overrides:

ready in class Reader

Throws:

IOException

markSupported

public boolean markSupported()

This Reader implementation does not support marking.

Overrides:

markSupported in class Reader

Returns:

false

mark

public void mark(int readAheadLimit)
          throws IOException

Overrides:

mark in class Reader

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class Reader

Throws:

IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in class Reader

Throws:

IOException

notifyAvailable

public boolean notifyAvailable(ReadHandler handler)

Notify the specified ReadHandler when any number of bytes can be read without blocking.

Invoking this method is equivalent to calling: notifyAvailable(handler, 0).

Specified by:

notifyAvailable in interface NIOInputSource

Parameters:

handler - the ReadHandler to notify.

Returns:

true if the specified handler has been accepted and will be notified as data becomes available to write, otherwise returns false which means data is available to be read without blocking.

See Also:

ReadHandler.onDataAvailable(), ReadHandler.onAllDataRead()

notifyAvailable

public boolean notifyAvailable(ReadHandler handler,
                               int size)

Notify the specified ReadHandler when the number of characters that can be read without blocking is greater or equal to the specified size.

Note that unless this method is called with a different ReadHandler implementation, the same ReadHandler will be invoked each time data becomes available to read.

Specified by:

notifyAvailable in interface NIOInputSource

Parameters:

handler - the ReadHandler to notify.

size - the least number of characters that must be available before the ReadHandler is invoked. If size is 0, the handler will be notified as soon as data is available no matter the size.

Returns:

true if the specified handler has been accepted and will be notified as data becomes available to write, otherwise returns false which means data is available to be read without blocking.

See Also:

ReadHandler.onDataAvailable(), ReadHandler.onAllDataRead()

isFinished

public boolean isFinished()

Specified by:

isFinished in interface NIOInputSource

Returns:

true when all data for this particular request has been read, otherwise returns false.

readyData

public int readyData()

Specified by:

readyData in interface NIOInputSource

Returns:

the number of bytes (or characters) that may be obtained without blocking. Note when dealing with characters, this method will return an estimate on the number of characters available.

isReady

public boolean isReady()

Specified by:

isReady in interface NIOInputSource

Returns:

true if data can be obtained without blocking, otherwise returns false.

getBuffer

public Buffer getBuffer()

Returns the underlying Buffer that backs this NIOInputSource.

It should be noted that for character-based NIOInputSources, the Buffer is the raw bytes. Any character conversion would have to be applied manually.

Specified by:

getBuffer in interface NIOInputSource

Returns:

the underlying Buffer that backs this NIOInputSource.