View Javadoc

    1   /*
    2    *  Licensed to the Apache Software Foundation (ASF) under one
    3    *  or more contributor license agreements.  See the NOTICE file
    4    *  distributed with this work for additional information
    5    *  regarding copyright ownership.  The ASF licenses this file
    6    *  to you under the Apache License, Version 2.0 (the
    7    *  "License"); you may not use this file except in compliance
    8    *  with the License.  You may obtain a copy of the License at
    9    *
    10   *    http://www.apache.org/licenses/LICENSE-2.0
    11   *
    12   *  Unless required by applicable law or agreed to in writing,
    13   *  software distributed under the License is distributed on an
    14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    15   *  KIND, either express or implied.  See the License for the
    16   *  specific language governing permissions and limitations
    17   *  under the License.
    18   *
    19   */
    20  package org.apache.mina.filter.codec;
    21
    22  import org.apache.mina.core.filterchain.IoFilter.NextFilter;
    23  import org.apache.mina.core.session.IoSession;
    24
    25  /**
    26   * Callback for {@link ProtocolDecoder} to generate decoded messages.
    27   * {@link ProtocolDecoder} must call {@link #write(Object)} for each decoded
    28   * messages.
    29   *
    30   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
    31   */
    32  public interface ProtocolDecoderOutput {
    33      /**
    34       * Callback for {@link ProtocolDecoder} to generate decoded messages.
    35       * {@link ProtocolDecoder} must call {@link #write(Object)} for each
    36       * decoded messages.
    37       *
    38       * @param message the decoded message
    39       */
    40      void write(Object message);
    41
    42      /**
    43       * Flushes all messages you wrote via {@link #write(Object)} to
    44       * the next filter.
    45       */
    46      void flush(NextFilter nextFilter, IoSession session);
    47  }