View Javadoc

1   /*
2    *   @(#) $Id: ProtocolEncoderOutput.java 210062 2005-07-11 03:52:38Z trustin $
3    *
4    *   Copyright 2004 The Apache Software Foundation
5    *
6    *   Licensed under the Apache License, Version 2.0 (the "License");
7    *   you may not use this file except in compliance with the License.
8    *   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, software
13   *   distributed under the License is distributed on an "AS IS" BASIS,
14   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   *   See the License for the specific language governing permissions and
16   *   limitations under the License.
17   *
18   */
19  package org.apache.mina.protocol;
20  
21  import org.apache.mina.common.ByteBuffer;
22  
23  /***
24   * Callback for {@link ProtocolEncoder} to generate encoded {@link ByteBuffer}s.
25   * {@link ProtocolEncoder} must call {@link #write(ByteBuffer)} for each decoded
26   * messages.
27   * 
28   * @author Trustin Lee (trustin@apache.org)
29   * @version $Rev: 210062 $, $Date: 2005-07-11 12:52:38 +0900 $
30   */
31  public interface ProtocolEncoderOutput
32  {
33      /***
34       * Callback for {@link ProtocolEncoder} to generate encoded
35       * {@link ByteBuffer}s. {@link ProtocolEncoder} must call
36       * {@link #write(ByteBuffer)} for each decoded messages.
37       * 
38       * @param buf the buffer which contains encoded data
39       */
40      void write( ByteBuffer buf );
41      
42      /***
43       * Merges all buffers you wrote via {@link #write(ByteBuffer)} into
44       * one {@link ByteBuffer} and replaces the old fragmented ones with it.
45       * This method is useful when you want to control the way MINA generates
46       * network packets.
47       */
48      void mergeAll();
49  }