public class InputBuffer extends Object
Constructor and Description |
---|
InputBuffer() |
Modifier and Type | Method and Description |
---|---|
boolean |
append(HttpContent httpContent)
|
int |
available() |
int |
availableChar() |
protected HttpContent |
blockingRead()
Read next chunk of data in this thread, block if needed.
|
void |
close() |
void |
fillFully(int length)
/**
Fill the buffer (blocking) up to the requested length.
|
protected void |
finished()
When invoked, this method will call
ReadHandler.onAllDataRead()
on the current ReadHandler (if any). |
Buffer |
getBuffer()
Returns the duplicate of the underlying
Buffer used to buffer
incoming request data. |
ReadHandler |
getReadHandler() |
protected Executor |
getThreadPool() |
void |
initialize(HttpHeader httpHeader,
FilterChainContext ctx)
Per-request initialization required for the InputBuffer to function
properly.
|
void |
initiateAsyncronousDataReceiving()
Initiates asynchronous data receiving.
|
boolean |
isAsyncEnabled()
Deprecated.
will always return true
|
boolean |
isClosed() |
boolean |
isFinished() |
void |
mark(int readAheadLimit)
Supported with binary and character data.
|
boolean |
markSupported()
Only supported with binary data.
|
void |
notifyAvailable(ReadHandler handler)
Installs a
ReadHandler that will be notified when any data
becomes available to read without blocking. |
void |
notifyAvailable(ReadHandler handler,
int size)
Installs a
ReadHandler that will be notified when the specified
amount of data is available to be read without blocking. |
void |
processingChars()
This method should be called if the InputBuffer is being used in conjunction
with a
Reader implementation. |
int |
read(byte[] b,
int off,
int len) |
int |
read(char[] cbuf,
int off,
int len) |
int |
read(CharBuffer target) |
Buffer |
readBuffer() |
Buffer |
readBuffer(int size) |
int |
readByte()
This method always blocks.
|
int |
readChar() |
boolean |
ready() |
int |
readyData()
Depending on the InputBuffer mode, method will return either
number of available bytes or characters ready to be read without blocking.
|
void |
recycle()
Recycle this
InputBuffer for reuse. |
void |
replayPayload(Buffer buffer) |
void |
reset()
Only supported with binary data.
|
void |
setAsyncEnabled(boolean asyncEnabled)
Deprecated.
InputBuffer always supports async mode
|
void |
setDefaultEncoding(String encoding)
Set the default character encoding for this InputBuffer, which
would be applied if no encoding was explicitly set on HTTP
HttpRequestPacket and character decoding
wasn't started yet. |
long |
skip(long n)
Skips the specified number of bytes/characters.
|
long |
skip(long n,
boolean block)
Deprecated.
pls. use
skip(long) , the block parameter will be ignored |
void |
terminate()
Invoke
ReadHandler.onError(Throwable) (assuming a ReadHandler
is available) } passing a {#link CancellationException}
if the current Connection is open, or a {#link EOFException} if
the connection was unexpectedly closed. |
protected void |
updateInputContentBuffer(Buffer buffer) |
public void initialize(HttpHeader httpHeader, FilterChainContext ctx)
Per-request initialization required for the InputBuffer to function properly.
httpHeader
- the header from which input will be obtained.ctx
- the FilterChainContext for the chain processing this requestpublic void setDefaultEncoding(String encoding)
HttpRequestPacket
and character decoding
wasn't started yet.public void recycle()
Recycle this InputBuffer
for reuse.
public void processingChars()
This method should be called if the InputBuffer is being used in conjunction
with a Reader
implementation. If this method is not called,
any character-based methods called on this InputBuffer
will
throw a IllegalStateException
.
public int readByte() throws IOException
IOException
InputStream.read()
public int read(byte[] b, int off, int len) throws IOException
IOException
InputStream.read(byte[], int, int)
public int readyData()
public int available()
InputStream.available()
public Buffer getBuffer()
Buffer
used to buffer
incoming request data. 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.Buffer
used to buffer incoming request data.public Buffer readBuffer()
Buffer
used to buffer incoming request
data. Unlike getBuffer()
, this method detaches the returned
Buffer
, so user code becomes responsible for handling
the Buffer
.public Buffer readBuffer(int size)
public ReadHandler getReadHandler()
ReadHandler
current in use, if any.public int read(CharBuffer target) throws IOException
IOException
Reader.read(java.nio.CharBuffer)
public int readChar() throws IOException
IOException
Reader.read()
public int read(char[] cbuf, int off, int len) throws IOException
IOException
Reader.read(char[], int, int)
public boolean ready()
Reader.ready()
public void fillFully(int length) throws IOException
length
- how much content should attempt to buffer,
-1
means buffer entire request.IOException
public int availableChar()
public void mark(int readAheadLimit)
Supported with binary and character data.
InputStream.mark(int)
,
Reader.mark(int)
public boolean markSupported()
Only supported with binary data.
InputStream.markSupported()
public void reset() throws IOException
Only supported with binary data.
IOException
InputStream.reset()
public void close() throws IOException
IOException
Closeable.close()
public long skip(long n, boolean block) throws IOException
skip(long)
, the block parameter will be ignoredIOException
InputStream.skip(long)
,
Reader.skip(long)
public long skip(long n) throws IOException
IOException
InputStream.skip(long)
,
Reader.skip(long)
protected void finished()
ReadHandler.onAllDataRead()
on the current ReadHandler
(if any).
This method shouldn't be invoked by developers directly.public void replayPayload(Buffer buffer)
public boolean isFinished()
true
if all request data has been read, otherwise
returns false
.public boolean isClosed()
true
if this InputBuffer is closed, otherwise
returns false
.public void notifyAvailable(ReadHandler handler)
ReadHandler
that will be notified when any data
becomes available to read without blocking.handler
- the ReadHandler
to invoke.IllegalArgumentException
- if handler
is null
.IllegalStateException
- if an attempt is made to register a handler
before an existing registered handler has been invoked or if all request
data has already been read.public void notifyAvailable(ReadHandler handler, int size)
ReadHandler
that will be notified when the specified
amount of data is available to be read without blocking.handler
- the ReadHandler
to invoke.size
- the minimum number of bytes that must be available before
the ReadHandler
is notified.IllegalArgumentException
- if handler
is null
,
or if size
is less or equal to zero.IllegalStateException
- if an attempt is made to register a handler
before an existing registered handler has been invoked.public boolean append(HttpContent httpContent) throws IOException
httpContent
- the HttpContent
to appendtrue
if ReadHandler
callback was invoked, otherwise returns false
.IOException
- if an error occurs appending the Buffer
public boolean isAsyncEnabled()
public void setAsyncEnabled(boolean asyncEnabled)
InputBuffer
.asyncEnabled
- true
if this InputBuffer
is to be used to process asynchronous request data.
public void terminate()
Invoke ReadHandler.onError(Throwable)
(assuming a ReadHandler
is available) } passing a {#link CancellationException}
if the current Connection
is open, or a {#link EOFException} if
the connection was unexpectedly closed.
public void initiateAsyncronousDataReceiving()
protected Executor getThreadPool()
Executor
, which will be used for notifying user
registered ReadHandler
.protected HttpContent blockingRead() throws IOException
HttpContent
IOException
protected void updateInputContentBuffer(Buffer buffer)
Copyright © 2015 Oracle Corporation. All rights reserved.