org.apache.mina.filter.codec.statemachine.DecodingStateMachine Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.mina.filter.codec.statemachine;
import java.util.ArrayList;
import java.util.List;
import org.apache.mina.core.buffer.IoBuffer;
import org.apache.mina.core.filterchain.IoFilter.NextFilter;
import org.apache.mina.core.session.IoSession;
import org.apache.mina.filter.codec.ProtocolCodecFilter;
import org.apache.mina.filter.codec.ProtocolDecoderOutput;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Abstract base class for decoder state machines. Calls init() to
* get the start {@link DecodingState} of the state machine. Calls
* destroy() when the state machine has reached its end state or when
* the session is closed.
*
* NOTE: The {@link ProtocolDecoderOutput} used by this class when calling
* {@link DecodingState#decode(IoBuffer, ProtocolDecoderOutput)} buffers decoded
* messages in a {@link List}. Once the state machine has reached its end state
* this class will call finishDecode(List, ProtocolDecoderOutput). The
* implementation will have to take care of writing the decoded messages to the
* real {@link ProtocolDecoderOutput} used by the configured
* {@link ProtocolCodecFilter}.
*
*
* @author Apache MINA Project
*/
public abstract class DecodingStateMachine implements DecodingState {
private static final Logger LOGGER = LoggerFactory.getLogger(DecodingStateMachine.class);
private final List