View Javadoc
1   /*
2    * Copyright 2017 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.http.websocketx;
17  
18  import io.netty.util.AsciiString;
19  
20  /**
21   * Defines the common schemes used for the WebSocket protocol as defined by
22   * <a href="https://tools.ietf.org/html/rfc6455">rfc6455</a>.
23   */
24  public final class WebSocketScheme {
25      /**
26       * Scheme for non-secure WebSocket connection.
27       */
28      public static final WebSocketScheme WS = new WebSocketScheme(80, "ws");
29  
30      /**
31       * Scheme for secure WebSocket connection.
32       */
33      public static final WebSocketScheme WSS = new WebSocketScheme(443, "wss");
34  
35      private final int port;
36      private final AsciiString name;
37  
38      private WebSocketScheme(int port, String name) {
39          this.port = port;
40          this.name = AsciiString.cached(name);
41      }
42  
43      public AsciiString name() {
44          return name;
45      }
46  
47      public int port() {
48          return port;
49      }
50  
51      @Override
52      public boolean equals(Object o) {
53          if (!(o instanceof WebSocketScheme)) {
54              return false;
55          }
56          WebSocketScheme other = (WebSocketScheme) o;
57          return other.port() == port && other.name().equals(name);
58      }
59  
60      @Override
61      public int hashCode() {
62          return port * 31 + name.hashCode();
63      }
64  
65      @Override
66      public String toString() {
67          return name.toString();
68      }
69  }