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.http.nio;
28
29 import java.io.IOException;
30
31 import org.apache.hc.core5.http.EntityDetails;
32 import org.apache.hc.core5.http.HttpException;
33 import org.apache.hc.core5.http.HttpResponse;
34 import org.apache.hc.core5.http.protocol.HttpContext;
35
36 /**
37 * Abstract asynchronous client side message exchange handler that acts as a request producer
38 * and a response consumer.
39 *
40 * @since 5.0
41 */
42 public interface AsyncClientExchangeHandler extends AsyncDataExchangeHandler {
43
44 /**
45 * Triggered to signal the ability of the underlying request channel
46 * to accept a request messages. The data producer can choose to send
47 * a request message immediately inside the call or asynchronously
48 * at some later point.
49 *
50 * @param channel the request channel capable to accepting a request message.
51 * @param context the actual execution context.
52 */
53 void produceRequest(RequestChannel channel, HttpContext context) throws HttpException, IOException;
54
55 /**
56 * Triggered to signal receipt of a response message head.
57 *
58 * @param response the response message head.
59 * @param entityDetails the response entity details or {@code null} if the response
60 * does not enclose an entity.
61 * @param context the actual execution context.
62 */
63 void consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext context) throws HttpException, IOException;
64
65 /**
66 * Triggered to signal receipt of an intermediate (1xx) HTTP response.
67 *
68 * @param response the intermediate (1xx) HTTP response.
69 * @param context the actual execution context.
70 */
71 void consumeInformation(HttpResponse response, HttpContext context) throws HttpException, IOException;
72
73 /**
74 * Triggered to cancel the message exchange.
75 */
76 void cancel();
77
78 }