View Javadoc

1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  
17  package org.jboss.netty.handler.codec.oneone;
18  
19  import org.jboss.netty.channel.ChannelHandlerContext;
20  import org.jboss.netty.channel.MessageEvent;
21  
22  /**
23   * Special {@link OneToOneEncoder} which enforce strict ordering of encoding and writing. This
24   * class should get extend by implementations that needs this enforcement to guaranteer no corruption.
25   * Basically all "message" based {@link OneToOneEncoder} mostly don't need this, where "stream" based
26   * are often in need of it.
27   *
28   */
29  public abstract class OneToOneStrictEncoder extends OneToOneEncoder {
30  
31      @Override
32      protected boolean doEncode(ChannelHandlerContext ctx, MessageEvent e) throws Exception {
33          // Synchronize on the channel to guaranteer the strict ordering
34          synchronized (ctx.getChannel()) {
35              return super.doEncode(ctx, e);
36          }
37      }
38  }