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    *   https://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.util.internal.ObjectUtil;
20  
21  /**
22   * An abstract class that defines a SocksMessage, providing common properties for
23   * {@link SocksRequest} and {@link SocksResponse}.
24   *
25   * @see SocksRequest
26   * @see SocksResponse
27   */
28  
29  public abstract class SocksMessage {
30      private final SocksMessageType type;
31      private final SocksProtocolVersion protocolVersion = SocksProtocolVersion.SOCKS5;
32  
33      protected SocksMessage(SocksMessageType type) {
34          this.type = ObjectUtil.checkNotNull(type, "type");
35      }
36  
37      /**
38       * Returns the {@link SocksMessageType} of this {@link SocksMessage}
39       *
40       * @return The {@link SocksMessageType} of this {@link SocksMessage}
41       */
42      public SocksMessageType type() {
43          return type;
44      }
45  
46      /**
47       * Returns the {@link SocksProtocolVersion} of this {@link SocksMessage}
48       *
49       * @return The {@link SocksProtocolVersion} of this {@link SocksMessage}
50       */
51      public SocksProtocolVersion protocolVersion() {
52          return protocolVersion;
53      }
54  
55      /**
56       * @deprecated Do not use; this method was intended for an internal use only.
57       */
58      @Deprecated
59      public abstract void encodeAsByteBuf(ByteBuf byteBuf);
60  }