com.linecorp.armeria.client.thrift.THttpClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of armeria-thrift0.9 Show documentation

Asynchronous HTTP/2 RPC/REST client/server library built on top of Java 8, Netty, Thrift and gRPC (armeria-thrift0.9)

The newest version!

/*
 * Copyright 2016 LINE Corporation
 *
 * LINE Corporation licenses this file to you 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:
 *
 *   https://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.linecorp.armeria.client.thrift;

import com.linecorp.armeria.client.ClientBuilderParams;
import com.linecorp.armeria.client.RpcClient;
import com.linecorp.armeria.common.RpcResponse;
import com.linecorp.armeria.common.util.Unwrappable;

/**
 * A generic Thrift-over-HTTP client.
 *
 * You will usually create a Thrift client object that implements a specific Thrift service interface
 * (e.g. {@code HelloService.AsyncIface}):
 * 
{@code
 * HelloService.AsyncIface client = Clients.newClient(
 *         "tbinary+http://127.0.0.1/hello", HelloService.AsyncIface.class);
 * client.hello("John Doe", ...);
 * }
 * However, if you want a generic Thrift client that works with any Thrift services, this client may be useful:
 * {@code
 * ThriftClient client = Clients.newClient("tbinary+http://127.0.0.1/", ThriftClient.class);
 * client.execute("/hello", HelloService.Iface.class, "hello", "John Doe");
 * client.execute("/foo", FooService.Iface.class, "foo", "arg1", "arg2", ...);
 * }
 */
public interface THttpClient extends Unwrappable, ClientBuilderParams {
    /**
     * Executes the specified Thrift call.
     *
     * @param path the path of the Thrift service
     * @param serviceType the Thrift service interface
     * @param method the method name
     * @param args the arguments of the call
     */
    RpcResponse execute(String path, Class serviceType, String method, Object... args);

    /**
     * Executes the specified multiplexed Thrift call.
     *
     * @param path the path of the Thrift service
     * @param serviceType the Thrift service interface
     * @param serviceName the Thrift service name
     * @param method the method name
     * @param args the arguments of the call
     */
    RpcResponse executeMultiplexed(
            String path, Class serviceType, String serviceName, String method, Object... args);

    @Override
    RpcClient unwrap();
}