001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.nio.reactor;
029
030/**
031 * SessionRequestCallback interface can be used to get notifications of
032 * completion of session requests asynchronously without having to wait
033 * for it, blocking the current thread of execution.
034 *
035 * @since 4.0
036 */
037public interface SessionRequestCallback {
038
039    /**
040     * Triggered on successful completion of a {@link SessionRequest}.
041     * The {@link SessionRequest#getSession()} method can now be used to obtain
042     * the new I/O session.
043     *
044     * @param request session request.
045     */
046    void completed(SessionRequest request);
047
048    /**
049     * Triggered on unsuccessful completion a {@link SessionRequest}.
050     * The {@link SessionRequest#getException()} method can now be used to
051     * obtain the cause of the error.
052     *
053     * @param request session request.
054     */
055    void failed(SessionRequest request);
056
057    /**
058     * Triggered if a {@link SessionRequest} times out.
059     *
060     * @param request session request.
061     */
062    void timeout(SessionRequest request);
063
064    /**
065     * Triggered on cancellation of a {@link SessionRequest}.
066     *
067     * @param request session request.
068     */
069    void cancelled(SessionRequest request);
070
071}