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  package io.netty.handler.codec.socks;
17  
18  import io.netty.buffer.ByteBuf;
19  import io.netty.channel.ChannelHandler;
20  import io.netty.channel.ChannelHandlerContext;
21  import io.netty.handler.codec.MessageToByteEncoder;
22  
23  /**
24   * Encodes an {@link SocksMessage} into a {@link ByteBuf}.
25   * {@link MessageToByteEncoder} implementation.
26   * Use this with {@link SocksInitRequest}, {@link SocksInitResponse}, {@link SocksAuthRequest},
27   * {@link SocksAuthResponse}, {@link SocksCmdRequest} and {@link SocksCmdResponse}
28   */
29  @ChannelHandler.Sharable
30  public class SocksMessageEncoder extends MessageToByteEncoder<SocksMessage> {
31      private static final String name = "SOCKS_MESSAGE_ENCODER";
32  
33      /**
34       * @deprecated Will be removed at the next minor version bump.
35       */
36      @Deprecated
37      public static String getName() {
38          return name;
39      }
40  
41      @Override
42      @SuppressWarnings("deprecation")
43      protected void encode(ChannelHandlerContext ctx, SocksMessage msg, ByteBuf out) throws Exception {
44          msg.encodeAsByteBuf(out);
45      }
46  }