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      private final int defaultMaxMessagesPerRead;
27  
28      /**
29       * Create a new instance
30       *
31       * @param hasDisconnect     {@code true} if and only if the channel has the {@code disconnect()} operation
32       *                          that allows a user to disconnect and then call {@link Channel#connect(SocketAddress)}
33       *                          again, such as UDP/IP.
34       */
35      public ChannelMetadata(boolean hasDisconnect) {
36          this(hasDisconnect, 1);
37      }
38  
39      /**
40       * Create a new instance
41       *
42       * @param hasDisconnect     {@code true} if and only if the channel has the {@code disconnect()} operation
43       *                          that allows a user to disconnect and then call {@link Channel#connect(SocketAddress)}
44       *                          again, such as UDP/IP.
45       * @param defaultMaxMessagesPerRead If a {@link MaxMessagesRecvByteBufAllocator} is in use, then this value will be
46       * set for {@link MaxMessagesRecvByteBufAllocator#maxMessagesPerRead()}. Must be {@code > 0}.
47       */
48      public ChannelMetadata(boolean hasDisconnect, int defaultMaxMessagesPerRead) {
49          if (defaultMaxMessagesPerRead <= 0) {
50              throw new IllegalArgumentException("defaultMaxMessagesPerRead: " + defaultMaxMessagesPerRead +
51                                                 " (expected > 0)");
52          }
53          this.hasDisconnect = hasDisconnect;
54          this.defaultMaxMessagesPerRead = defaultMaxMessagesPerRead;
55      }
56  
57      /**
58       * Returns {@code true} if and only if the channel has the {@code disconnect()} operation
59       * that allows a user to disconnect and then call {@link Channel#connect(SocketAddress)} again,
60       * such as UDP/IP.
61       */
62      public boolean hasDisconnect() {
63          return hasDisconnect;
64      }
65  
66      /**
67       * If a {@link MaxMessagesRecvByteBufAllocator} is in use, then this is the default value for
68       * {@link MaxMessagesRecvByteBufAllocator#maxMessagesPerRead()}.
69       */
70      public int defaultMaxMessagesPerRead() {
71          return defaultMaxMessagesPerRead;
72      }
73  }