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  /**
23   * Callback for {@link ProtocolDecoder} to generate decoded messages.
24   * {@link ProtocolDecoder} must call {@link #write(Object)} for each decoded
25   * messages.
26   *
27   * @author The Apache MINA Project (dev@mina.apache.org)
28   * @version $Rev: 576217 $, $Date: 2007-09-17 01:55:27 +0200 (lun, 17 sep 2007) $
29   */
30  public interface ProtocolDecoderOutput {
31      /**
32       * Callback for {@link ProtocolDecoder} to generate decoded messages.
33       * {@link ProtocolDecoder} must call {@link #write(Object)} for each
34       * decoded messages.
35       *
36       * @param message the decoded message
37       */
38      void write(Object message);
39  
40      /**
41       * Flushes all messages you wrote via {@link #write(Object)} to
42       * the next filter.
43       */
44      void flush();
45  }