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 package org.apache.hc.core5.http2.nio;
28
29 import java.io.IOException;
30 import java.nio.ByteBuffer;
31
32 import org.apache.hc.core5.http.HttpException;
33
34 /**
35 * Abstract asynchronous ping exchange handler.
36 *
37 * @since 5.0
38 */
39 public interface AsyncPingHandler {
40
41 /**
42 * Returns content of ping message.
43 *
44 * @return the ping message content.
45 */
46 ByteBuffer getData();
47
48 /**
49 * Triggered to signal receipt of a ping response message.
50 *
51 * @param feedback the ping message feedback.
52 */
53 void consumeResponse(ByteBuffer feedback) throws HttpException, IOException;
54
55 /**
56 * Triggered to signal a failure in data processing.
57 *
58 * @param cause the cause of the failure.
59 */
60 void failed(Exception cause);
61
62 /**
63 * Triggered to cancel the message exchange.
64 */
65 void cancel();
66
67 }