com.palantir.dialogue.Clients Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dialogue-target Show documentation
Palantir open source project
The newest version!
/*
 * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.dialogue;

import com.google.common.util.concurrent.ListenableFuture;
import java.util.concurrent.Future;

/**
 * Provides functionality for generated code to make both blocking and asynchronous calls without
 * duplicating logic.
 */
public interface Clients {
    /**
     * Makes a request to the specified {@link EndpointChannel} and deserializes the response using a provided
     * deserializer.
     */
     ListenableFuture call(EndpointChannel channel, Request request, Deserializer deserializer);

    /**
     * Makes a request to the specified {@link Endpoint} and deserializes the response using a provided deserializer.
     * Deprecated. prefer {@link #bind} as this allows pre-computing values to save CPU
     */
     ListenableFuture call(Channel channel, Endpoint endpoint, Request request, Deserializer deserializer);

    /**
     * Blocking version of {@link #call(EndpointChannel, Request, Deserializer)}.
     */
    default  T callBlocking(EndpointChannel channel, Request request, Deserializer deserializer) {
        return block(call(channel, request, deserializer));
    }

    default EndpointChannel bind(Channel channel, Endpoint endpoint) {
        return new EndpointChannel() {
            @Override
            public ListenableFuture execute(Request request) {
                // this default implementation exists just in case people take new :dialogue-target but have an old
                // version of :dialogue-serde
                return channel.execute(endpoint, request);
            }
        };
    }

    /**
     * Similar to {@link com.google.common.util.concurrent.Futures#getUnchecked(Future)}, except with custom handling
     * for conjure exceptions and cancellation on interruption.
     *
     * Deprecated. prefer {@link #callBlocking(EndpointChannel, Request, Deserializer)} as it makes the blocking
     * explicit.
     */
     T block(ListenableFuture future);
}