StreamAlgorithmBase (grizzly-http 1.9.8 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.grizzly.http.algorithms
Class StreamAlgorithmBase

java.lang.Object
  com.sun.grizzly.http.algorithms.StreamAlgorithmBase

All Implemented Interfaces:: StreamAlgorithm<SocketChannel>

Direct Known Subclasses:: ContentLengthAlgorithm, NoParsingAlgorithm, StateMachineAlgorithm, StaticStreamAlgorithm

public abstract class StreamAlgorithmBase
extends Object
implements StreamAlgorithm<SocketChannel>
extends Object
implements StreamAlgorithm<SocketChannel>

Base class for StreamAlgorithm implementation.

Author:: Jeanfrancois Arcand

Nested Class Summary
`static class`	`StreamAlgorithmBase.DummyHandler` Empty handler used when Grizzly is bundled outside of GlassFish.

Field Summary
`protected int`	`contentLength` The actual length of the stream we are able to read.
`protected int`	`curLimit` The `ByteBuffer` current limit value
`protected int`	`curPosition` The `ByteBuffer` current position value
`protected Interceptor`	`handler` An `Interceptor` implementation used to implement a static resources cache.
`protected int`	`headerLength` The position, within the `ByteBuffer`, when the HTTP headers are completely reads.
`protected int`	`lastStatePosition` In case we were'nt able to parse the request line, we will continue parsing from that position.
`protected ByteBuffer`	`primaryByteBuffer` If a new `ByteBuffer` is created because the stream is too small, cache the original byteBuffer and reuse it once the transaction has completed.
`protected SocketChannel`	`socketChannel` The `SocketChannel` associated with this algorithm.
`protected int`	`state` If the stream wasn't read fully, keep the state of the http parsing.
`protected boolean`	`useByteBufferView` If `true`, use a `ByteBuffer` view instead of `ByteBuffer`
`protected boolean`	`useDirectByteBuffer` Are we using direct `ByteBuffer`

Constructor Summary
`StreamAlgorithmBase()`

Method Summary
`ByteBuffer`	`allocate(boolean useDirectByteBuffer, boolean useByteBufferView, int size)` Allocate a `ByteBuffer`
`int`	`contentLength()` Return the stream content-length.
`protected String`	`dump(ByteBuffer byteBuffer)` Dump the ByteBuffer content.
`int`	`getPort()` Return the port
`int`	`headerLength()` Return the stream header length.
`abstract boolean`	`parse(ByteBuffer byteBuffer)` Manipulate the bytes stream and determine if the process can continue.
`ByteBuffer`	`postParse(ByteBuffer byteBuffer)` After parsing the bytes, post process the `ByteBuffer`
`ByteBuffer`	`preParse(ByteBuffer byteBuffer)` Before parsing the bytes, initialize and prepare the algorithm.
`void`	`recycle()` Reset this object to its default state.
`ByteBuffer`	`rollbackParseState(ByteBuffer byteBuffer)` Rollback the `ByteBuffer` to its previous state in case an error as occured.
`void`	`setChannel(SocketChannel socketChannel)` The `SocketChannel` used by this class.
`void`	`setPort(int port)` Set the port

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.sun.grizzly.util.StreamAlgorithm
`getHandler`

Field Detail

contentLength

protected int contentLength

The actual length of the stream we are able to read.

curLimit

protected int curLimit

The ByteBuffer current limit value

curPosition

protected int curPosition

The ByteBuffer current position value

headerLength

protected int headerLength

The position, within the ByteBuffer, when the HTTP headers are completely reads.

lastStatePosition

protected int lastStatePosition

In case we were'nt able to parse the request line, we will continue parsing from that position.

state

protected int state

If the stream wasn't read fully, keep the state of the http parsing.

primaryByteBuffer

protected ByteBuffer primaryByteBuffer

If a new ByteBuffer is created because the stream is too small, cache the original byteBuffer and reuse it once the transaction has completed.

useByteBufferView

protected boolean useByteBufferView

If true, use a ByteBuffer view instead of ByteBuffer

useDirectByteBuffer

protected boolean useDirectByteBuffer

Are we using direct ByteBuffer

socketChannel

protected SocketChannel socketChannel

The SocketChannel associated with this algorithm.

handler

protected Interceptor handler

An Interceptor implementation used to implement a static resources cache.

Constructor Detail