View Javadoc
1   /*
2    * Copyright 2022 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.netty5.channel.unix;
17  
18  import io.netty5.util.internal.ObjectUtil;
19  
20  import java.nio.ByteBuffer;
21  
22  /**
23   * A {@link GenericUnixChannelOption} which uses an {@link ByteBuffer} as {@code optval}. The user is responsible
24   * to fill the {@link ByteBuffer} in a correct manner, so it works with the {@param level} and {@param optname}.
25   */
26  public final class RawUnixChannelOption extends GenericUnixChannelOption<ByteBuffer> {
27  
28      private final int length;
29  
30      /**
31       * Creates a new instance.
32       *
33       * @param name      the name that is used.
34       * @param level     the level.
35       * @param length    the expected length of the optvalue.
36       * @param optname   the optname.
37       */
38      public RawUnixChannelOption(String name, int level, int optname, int length) {
39          super(name, level, optname);
40          this.length = ObjectUtil.checkPositive(length, "length");
41      }
42  
43      /**
44       * The length of the optval.
45       *
46       * @return the length.
47       */
48      public int length() {
49          return length;
50      }
51  
52      @Override
53      public void validate(ByteBuffer value) {
54          super.validate(value);
55          if (value.remaining() != length) {
56              throw new IllegalArgumentException("Length of value does not match. Expected "
57                      + length + ", but got " + value.remaining());
58          }
59      }
60  }