View Javadoc

1   /*
2    * Copyright 2017 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.handler.ssl;
17  
18  /**
19   * Event that is fired once the close_notify was received or if an failure happens before it was received.
20   */
21  public final class SslCloseCompletionEvent extends SslCompletionEvent {
22  
23      public static final SslCloseCompletionEvent SUCCESS = new SslCloseCompletionEvent();
24  
25      /**
26       * Creates a new event that indicates a successful receiving of close_notify.
27       */
28      private SslCloseCompletionEvent() { }
29  
30      /**
31       * Creates a new event that indicates an close_notify was not received because of an previous error.
32       * Use {@link #SUCCESS} to indicate a success.
33       */
34      public SslCloseCompletionEvent(Throwable cause) {
35          super(cause);
36      }
37  }