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.http.nio.reactor;
29
30 /**
31 * SessionRequestCallback interface can be used to get notifications of
32 * completion of session requests asynchronously without having to wait
33 * for it, blocking the current thread of execution.
34 *
35 * @since 4.0
36 */
37 public interface SessionRequestCallback {
38
39 /**
40 * Triggered on successful completion of a {@link SessionRequest}.
41 * The {@link SessionRequest#getSession()} method can now be used to obtain
42 * the new I/O session.
43 *
44 * @param request session request.
45 */
46 void completed(SessionRequest request);
47
48 /**
49 * Triggered on unsuccessful completion a {@link SessionRequest}.
50 * The {@link SessionRequest#getException()} method can now be used to
51 * obtain the cause of the error.
52 *
53 * @param request session request.
54 */
55 void failed(SessionRequest request);
56
57 /**
58 * Triggered if a {@link SessionRequest} times out.
59 *
60 * @param request session request.
61 */
62 void timeout(SessionRequest request);
63
64 /**
65 * Triggered on cancellation of a {@link SessionRequest}.
66 *
67 * @param request session request.
68 */
69 void cancelled(SessionRequest request);
70
71 }