## Uses of Interface
org.apache.mina.filter.codec.ProtocolDecoderOutput

- Packages that use ProtocolDecoderOutput
  Package | Description
  --- | ---
  org.apache.mina.example.imagine.step1.codec |
  org.apache.mina.example.sumup.codec | Protocol codec implementation for SumUp protocol.
  org.apache.mina.example.tapedeck |
  org.apache.mina.filter.codec | Filter implementations that helps you to implement complex protocols via 'codec' concept.
  org.apache.mina.filter.codec.demux | Protocol codecs that helps you to implement even more complex protocols by splitting a codec into multiple sub-codecs.
  org.apache.mina.filter.codec.prefixedstring |
  org.apache.mina.filter.codec.serialization | Protocol codecs which uses Java object serilization and leads to rapid protocol implementation.
  org.apache.mina.filter.codec.statemachine |
  org.apache.mina.filter.codec.textline | A protocol codec for text-based protocols.
  org.apache.mina.http |

- - ### Uses of ProtocolDecoderOutput in org.apache.mina.example.imagine.step1.codec

    Methods in org.apache.mina.example.imagine.step1.codec with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | ImageResponseDecoder.`doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)`
    `protected boolean` | ImageRequestDecoder.`doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)`

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.example.sumup.codec

    Methods in org.apache.mina.example.sumup.codec with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `MessageDecoderResult` | AbstractMessageDecoder.`decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)`
    `void` | ResultMessageDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)`
    `void` | AddMessageDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)`

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.example.tapedeck

    Methods in org.apache.mina.example.tapedeck with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `void` | CommandDecoder.`decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)`

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.filter.codec

    Classes in org.apache.mina.filter.codec that implement ProtocolDecoderOutput
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractProtocolDecoderOutput` A `ProtocolDecoderOutput` based on queue.

    Methods in org.apache.mina.filter.codec that return ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `ProtocolDecoderOutput` | ProtocolCodecSession.`getDecoderOutput()` Returns the `ProtocolEncoderOutput` that buffers messages generated by `ProtocolDecoder`.

    Methods in org.apache.mina.filter.codec with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `void` | SynchronizedProtocolDecoder.`decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)`
    `void` | ProtocolDecoder.`decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)` Decodes binary or protocol-specific content into higher-level message objects.
    `void` | CumulativeProtocolDecoder.`decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)` Cumulates content of `in` into internal buffer and forwards decoding request to `CumulativeProtocolDecoder.doDecode(IoSession, IoBuffer, ProtocolDecoderOutput)`.
    `protected abstract boolean` | CumulativeProtocolDecoder.`doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)` Implement this method to consume the specified cumulative buffer and decode its content into message(s).
    `void` | SynchronizedProtocolDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)`
    `void` | ProtocolDecoderAdapter.`finishDecode(IoSession session, ProtocolDecoderOutput out)` Override this method to deal with the closed connection.
    `void` | ProtocolDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)` Invoked when the specified `session` is closed.

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.filter.codec.demux

    Methods in org.apache.mina.filter.codec.demux with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `MessageDecoderResult` | MessageDecoder.`decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)` Decodes binary or protocol-specific content into higher-level message objects.
    `protected boolean` | DemuxingProtocolDecoder.`doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)` Implement this method to consume the specified cumulative buffer and decode its content into message(s).
    `void` | MessageDecoderAdapter.`finishDecode(IoSession session, ProtocolDecoderOutput out)` Override this method to deal with the closed connection.
    `void` | MessageDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)` Invoked when the specified `session` is closed while this decoder was parsing the data.
    `void` | DemuxingProtocolDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)` Override this method to deal with the closed connection.

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.filter.codec.prefixedstring

    Methods in org.apache.mina.filter.codec.prefixedstring with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | PrefixedStringDecoder.`doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)`

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.filter.codec.serialization

    Methods in org.apache.mina.filter.codec.serialization with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | ObjectSerializationDecoder.`doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)`

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.filter.codec.statemachine

    Methods in org.apache.mina.filter.codec.statemachine with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `DecodingState` | SkippingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | SingleByteDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)`
    `DecodingState` | ShortIntegerDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | IntegerDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | FixedLengthDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | DecodingStateMachine.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | DecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | CrLfDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | ConsumeToTerminatorDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | ConsumeToEndOfSessionDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | ConsumeToDynamicTerminatorDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)` Invoked when data is available for this state.
    `DecodingState` | ConsumeToCrLfDecodingState.`decode(IoBuffer in, ProtocolDecoderOutput out)`
    `void` | DecodingStateProtocolDecoder.`decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)` Decodes binary or protocol-specific content into higher-level message objects.
    `protected abstract DecodingState` | CrLfDecodingState.`finishDecode(boolean foundCRLF, ProtocolDecoderOutput out)` Invoked when this state has found a `CRLF`.
    `protected abstract DecodingState` | SingleByteDecodingState.`finishDecode(byte b, ProtocolDecoderOutput out)` Invoked when this state has consumed a complete `byte`.
    `protected abstract DecodingState` | IntegerDecodingState.`finishDecode(int value, ProtocolDecoderOutput out)` Invoked when this state has consumed a complete `int`.
    `protected abstract DecodingState` | FixedLengthDecodingState.`finishDecode(IoBuffer product, ProtocolDecoderOutput out)` Invoked when this state has consumed the configured number of bytes.
    `protected abstract DecodingState` | ConsumeToTerminatorDecodingState.`finishDecode(IoBuffer product, ProtocolDecoderOutput out)` Invoked when this state has reached the terminator byte.
    `protected abstract DecodingState` | ConsumeToEndOfSessionDecodingState.`finishDecode(IoBuffer product, ProtocolDecoderOutput out)` Invoked when this state has consumed all bytes until the session is closed.
    `protected abstract DecodingState` | ConsumeToDynamicTerminatorDecodingState.`finishDecode(IoBuffer product, ProtocolDecoderOutput out)` Invoked when this state has reached the terminator byte.
    `protected abstract DecodingState` | ConsumeToCrLfDecodingState.`finishDecode(IoBuffer product, ProtocolDecoderOutput out)` Invoked when this state has reached a `CRLF`.
    `void` | DecodingStateProtocolDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)` Invoked when the specified `session` is closed.
    `protected abstract DecodingState` | DecodingStateMachine.`finishDecode(List<Object> childProducts, ProtocolDecoderOutput out)` Called once the state machine has reached its end.
    `DecodingState` | SkippingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | SingleByteDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | ShortIntegerDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | IntegerDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | FixedLengthDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | DecodingStateMachine.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | DecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | CrLfDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | ConsumeToTerminatorDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | ConsumeToEndOfSessionDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | ConsumeToDynamicTerminatorDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `DecodingState` | ConsumeToCrLfDecodingState.`finishDecode(ProtocolDecoderOutput out)` Invoked when the associated `IoSession` is closed.
    `protected abstract DecodingState` | ShortIntegerDecodingState.`finishDecode(short value, ProtocolDecoderOutput out)` Invoked when this state has consumed a complete `short`.

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.filter.codec.textline

    Methods in org.apache.mina.filter.codec.textline with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `void` | TextLineDecoder.`decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)` Decodes binary or protocol-specific content into higher-level message objects.
    `void` | TextLineDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)` Invoked when the specified `session` is closed.
    `protected void` | TextLineDecoder.`writeText(IoSession session, String text, ProtocolDecoderOutput out)` By default, this method propagates the decoded line of text to `ProtocolDecoderOutput#write(Object)`.

  - ### Uses of ProtocolDecoderOutput in org.apache.mina.http

    Methods in org.apache.mina.http with parameters of type ProtocolDecoderOutput
    Modifier and Type | Method and Description
    --- | ---
    `void` | HttpServerDecoder.`decode(IoSession session, IoBuffer msg, ProtocolDecoderOutput out)`
    `void` | HttpClientDecoder.`decode(IoSession session, IoBuffer msg, ProtocolDecoderOutput out)`
    `void` | HttpServerDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)`
    `void` | HttpClientDecoder.`finishDecode(IoSession session, ProtocolDecoderOutput out)`

Copyright © 2004-2012 Apache MINA Project. All Rights Reserved.