View Javadoc
1   /*
2    * Copyright 2016 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.channel.kqueue;
17  
18  import io.netty.buffer.ByteBuf;
19  import io.netty.buffer.ByteBufAllocator;
20  import io.netty.channel.ChannelConfig;
21  import io.netty.channel.RecvByteBufAllocator.DelegatingHandle;
22  import io.netty.channel.RecvByteBufAllocator.ExtendedHandle;
23  import io.netty.channel.unix.PreferredDirectByteBufAllocator;
24  import io.netty.util.UncheckedBooleanSupplier;
25  
26  import static java.lang.Math.max;
27  import static java.lang.Math.min;
28  
29  final class KQueueRecvByteAllocatorHandle extends DelegatingHandle implements ExtendedHandle {
30      private final PreferredDirectByteBufAllocator preferredDirectByteBufAllocator =
31              new PreferredDirectByteBufAllocator();
32  
33      private final UncheckedBooleanSupplier defaultMaybeMoreDataSupplier = new UncheckedBooleanSupplier() {
34          @Override
35          public boolean get() {
36              return maybeMoreDataToRead();
37          }
38      };
39      private boolean readEOF;
40      private long numberBytesPending;
41  
42      KQueueRecvByteAllocatorHandle(ExtendedHandle handle) {
43          super(handle);
44      }
45  
46      @Override
47      public ByteBuf allocate(ByteBufAllocator alloc) {
48          // We need to ensure we always allocate a direct ByteBuf as we can only use a direct buffer to read via JNI.
49          preferredDirectByteBufAllocator.updateAllocator(alloc);
50          return delegate().allocate(preferredDirectByteBufAllocator);
51      }
52  
53      @Override
54      public boolean continueReading(UncheckedBooleanSupplier maybeMoreDataSupplier) {
55          return readEOF || ((ExtendedHandle) delegate()).continueReading(maybeMoreDataSupplier);
56      }
57  
58      @Override
59      public boolean continueReading() {
60          // We must override the supplier which determines if there maybe more data to read.
61          return continueReading(defaultMaybeMoreDataSupplier);
62      }
63  
64      void readEOF() {
65          readEOF = true;
66      }
67  
68      void numberBytesPending(long numberBytesPending) {
69          this.numberBytesPending = numberBytesPending;
70      }
71  
72      private boolean maybeMoreDataToRead() {
73          /**
74           * kqueue with EV_CLEAR flag set requires that we read until we consume "data" bytes
75           * (see <a href="https://www.freebsd.org/cgi/man.cgi?kqueue">kqueue man</a>). However in order to
76           * respect auto read we supporting reading to stop if auto read is off. If auto read is on we force reading to
77           * continue to avoid a {@link StackOverflowError} between channelReadComplete and reading from the
78           * channel. It is expected that the {@link #KQueueSocketChannel} implementations will track if all data was not
79           * read, and will force a EVFILT_READ ready event.
80           *
81           * It is assumed EOF is handled externally by checking {@link #isReadEOF()}.
82           */
83          return lastBytesRead() == attemptedBytesRead();
84      }
85  }