查看本类的 API文档回源码主页即时通讯网 - 即时通讯开发者社区!
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.common.ByteBuffer;
23  import org.apache.mina.common.WriteFuture;
24  
25  /**
26   * Callback for {@link ProtocolEncoder} to generate encoded {@link ByteBuffer}s.
27   * {@link ProtocolEncoder} must call {@link #write(ByteBuffer)} for each encoded
28   * message.
29   * 
30   * @author The Apache Directory Project (mina-dev@directory.apache.org)
31   * @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (Fri, 13 Jul 2007) $
32   */
33  public interface ProtocolEncoderOutput {
34      /**
35       * Callback for {@link ProtocolEncoder} to generate encoded
36       * {@link ByteBuffer}s. {@link ProtocolEncoder} must call
37       * {@link #write(ByteBuffer)} for each encoded message.
38       * 
39       * @param buf the buffer which contains encoded data
40       */
41      void write(ByteBuffer buf);
42  
43      /**
44       * Merges all buffers you wrote via {@link #write(ByteBuffer)} into
45       * one {@link ByteBuffer} and replaces the old fragmented ones with it.
46       * This method is useful when you want to control the way MINA generates
47       * network packets.
48       */
49      void mergeAll();
50  
51      /**
52       * Flushes all buffers you wrote via {@link #write(ByteBuffer)} to
53       * the session.  This operation is asynchronous; please wait for
54       * the returned {@link WriteFuture} if you want to wait for
55       * the buffers flushed.
56       * 
57       * @return <tt>null</tt> if there is nothing to flush at all.
58       */
59      WriteFuture flush();
60  }