View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.hc.core5.http2.nio.command;
29  
30  import org.apache.hc.core5.annotation.Internal;
31  import org.apache.hc.core5.http2.nio.AsyncPingHandler;
32  import org.apache.hc.core5.reactor.Command;
33  import org.apache.hc.core5.util.Args;
34  
35  /**
36   * HTTP/2 ping command.
37   *
38   * @since 5.0
39   */
40  @Internal
41  public final class PingCommand implements Command {
42  
43      private final AsyncPingHandler handler;
44  
45      public PingCommand(final AsyncPingHandler handler) {
46          this.handler = Args.notNull(handler, "Handler");
47      }
48  
49      public AsyncPingHandler getHandler() {
50          return handler;
51      }
52  
53      @Override
54      public boolean cancel() {
55          handler.cancel();
56          return true;
57      }
58  
59  }