codes.sf.springboot.grpc.client

Interface GrpcChannelSource

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface GrpcChannelSource

A strategy interface for resolving Channels for gRPC stubs.

GrpcChannelSource is usually where your service discovery logic goes. It is the place where you map the client stubs to their server implementations.

Auto configuration will autodetect the GrpcChannelSource bean and use it to resolve channels for new gRPC stub instances. In other words you may register your GrpcChannelSource as a simple @Bean in your @Configuration classes.

Note that there must be at most one GrpcChannelSource in the ApplicationContext, otherwise you'll get an error.

If no GrpcChannelSource is found in the ApplicationContext, auto configuration will

• first look for a Channel in the ApplicationContext to use instead;
• if no channel bean is found, it will configure a new plaintext one with target from environment property grpc.client.target;
• finally if no property is found, it will default to creating a new plaintext channel bean with target "localhost:6565"

If you're creating a GrpcChannelSource that returns a constant channel, consider using convenience function GrpcChannelSource.of(Channel)

Since:

0.0.1

Method Summary

Modifier and Type	Method and Description
static GrpcChannelSource	of(io.grpc.Channel channel) Convenience method for build GrpcChannelSource that returns a constant channel instance.
io.grpc.Channel	resolve(java.lang.Class<? extends io.grpc.stub.AbstractStub<?>> stubClass) Resolve channel for stub type.

Method Detail

resolve

io.grpc.Channel resolve(java.lang.Class<? extends io.grpc.stub.AbstractStub<?>> stubClass)

Resolve channel for stub type.

Parameters:

stubClass - the stub type

Returns:

resolved channel, may not be null

of

static GrpcChannelSource of(io.grpc.Channel channel)

Convenience method for build GrpcChannelSource that returns a constant channel instance.

Parameters:

channel - the constant channel instance to return

Returns:

newly constructed GrpcChannelSource