com.uber.tchannel.api.handlers.AsyncRequestHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tchannel-core Show documentation

There is a newer version: 0.8.30

/*
 * Copyright (c) 2016 Uber Technologies, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.uber.tchannel.api.handlers;

import com.google.common.util.concurrent.ListenableFuture;
import com.uber.tchannel.messages.Request;
import com.uber.tchannel.messages.Response;

/**
 * Allows requests to be handle asynchronously by letting the actual handler return a future.
 */
public interface AsyncRequestHandler extends RequestHandler {

    /**
     * Main handle method for the AsyncRequestHandler that returns a ListenableFuture. This method
     * should not make any blocking calls so that the calling thread is reliquished quickly.
     *
     * @param request Request to handle
     * @return A ListenableFuture representing the result of the request handling.
     */
    ListenableFuture handleAsync(Request request);
}