View Javadoc
1   /*
2    * Copyright 2023 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.handler.codec.quic;
17  
18  import org.jetbrains.annotations.Nullable;
19  
20  import java.nio.channels.ClosedChannelException;
21  
22  /**
23   * Special {@link QuicClosedChannelException} which also provides extra info if the close was a result of a
24   * {@link QuicConnectionCloseEvent} that was triggered by the remote peer.
25   */
26  public final class QuicClosedChannelException extends ClosedChannelException {
27  
28      private final QuicConnectionCloseEvent event;
29  
30      QuicClosedChannelException(@Nullable QuicConnectionCloseEvent event) {
31          this.event = event;
32      }
33  
34      /**
35       * Returns the {@link QuicConnectionCloseEvent} that caused the closure or {@code null} if none was received.
36       *
37       * @return the event.
38       */
39      @Nullable
40      public QuicConnectionCloseEvent event() {
41          return event;
42      }
43  }