Package com.linecorp.armeria.common.grpc

Class GrpcCallOptions

java.lang.Object

com.linecorp.armeria.common.grpc.GrpcCallOptions

@UnstableApi
public final class GrpcCallOptions
extends Object

Retrieves CallOptions from a given RequestContext. This might be useful while providing common middleware that needs to act on options configured at the gRPC client's call site.

Here is an example of how custom call options might be propagated between a gRPC stub and a decorator.

     MyGrpcStub client = GrpcClients
         .builder(grpcServerUri)
         .decorator((delegate, ctx, req) -> {
             CallOptions options = GrpcCallOptions.get(ctx);
             MyOption myOption = options.getOption(myOptionKey);

             // act on myOption if needed

             return delegate.execute(ctx, req);
         })
         .build(MyGrpcStub.class)

     client
       .withOption(myOptionKey, myOptionValue)
       .echo(...)
 

Method Summary

Modifier and Type	Method	Description
static @Nullable io.grpc.CallOptions	get(RequestContext ctx)	Returns CallOptions which was set to the specified RequestContext using set(RequestContext, CallOptions).
static void	set(RequestContext ctx, io.grpc.CallOptions options)	Sets the specified CallOptions to the RequestContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

@Nullable
public static @Nullable io.grpc.CallOptions get(RequestContext ctx)

Returns CallOptions which was set to the specified RequestContext using set(RequestContext, CallOptions).

set

public static void set(RequestContext ctx,
 io.grpc.CallOptions options)

Sets the specified CallOptions to the RequestContext.