001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.mina.filter.codec;
021
022import org.apache.mina.core.filterchain.IoFilter.NextFilter;
023import org.apache.mina.core.session.IoSession;
024
025/**
026 * Callback for {@link ProtocolDecoder} to generate decoded messages.
027 * {@link ProtocolDecoder} must call {@link #write(Object)} for each decoded
028 * messages.
029 *
030 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
031 */
032public interface ProtocolDecoderOutput {
033    /**
034     * Callback for {@link ProtocolDecoder} to generate decoded messages.
035     * {@link ProtocolDecoder} must call {@link #write(Object)} for each
036     * decoded messages.
037     *
038     * @param message the decoded message
039     */
040    void write(Object message);
041
042    /**
043     * Flushes all messages you wrote via {@link #write(Object)} to
044     * the next filter.
045     * 
046     * @param nextFilter the next Filter
047     * @param session The current Session
048     */
049    void flush(NextFilter nextFilter, IoSession session);
050}