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.channel;
17  
18  import java.net.SocketAddress;
19  
20  /**
21   * Represents the properties of a {@link Channel} implementation.
22   */
23  public final class ChannelMetadata {
24  
25      private final boolean hasDisconnect;
26  
27      /**
28       * Create a new instance
29       *
30       * @param hasDisconnect     {@code true} if and only if the channel has the {@code disconnect()} operation
31       *                          that allows a user to disconnect and then call {@link Channel#connect(SocketAddress)}
32       *                          again, such as UDP/IP.
33       */
34      public ChannelMetadata(boolean hasDisconnect) {
35          this.hasDisconnect = hasDisconnect;
36      }
37  
38      /**
39       * Returns {@code true} if and only if the channel has the {@code disconnect()} operation
40       * that allows a user to disconnect and then call {@link Channel#connect(SocketAddress)} again,
41       * such as UDP/IP.
42       */
43      public boolean hasDisconnect() {
44          return hasDisconnect;
45      }
46  }