net.devh.springboot.autoconfigure.grpc.client

Interface GrpcChannelFactory

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AbstractChannelFactory, AddressChannelFactory, DiscoveryClientChannelFactory

public interface GrpcChannelFactory
extends java.lang.AutoCloseable

This factory creates grpc Channels for a given service name. Implementations are encouraged to utilize connection pooling and thus close should be called before disposing it.

Since:

5/17/16

Method Summary

Modifier and Type	Method and Description
io.grpc.Channel	createChannel(java.lang.String name) Creates a new channel for the given service name.
io.grpc.Channel	createChannel(java.lang.String name, java.util.List<io.grpc.ClientInterceptor> interceptors) Creates a new channel for the given service name.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

createChannel

io.grpc.Channel createChannel(java.lang.String name)

Creates a new channel for the given service name. The returned channel will use all globally registered ClientInterceptors.

Note: The underlying implementation might reuse existing ManagedChannels allow connection reuse.

Parameters:

name - The name of the service.

Returns:

The newly created channel for the given service.

createChannel

io.grpc.Channel createChannel(java.lang.String name,
                              java.util.List<io.grpc.ClientInterceptor> interceptors)

Creates a new channel for the given service name. The returned channel will use all globally registered ClientInterceptors.

Note: The underlying implementation might reuse existing ManagedChannels allow connection reuse.

Note: The given interceptors will be applied after the global interceptors. But the interceptors that were applied last, will be called first.

Parameters:

name - The name of the service.

interceptors - A list of additional client interceptors that should be added to the channel.

Returns:

The newly created channel for the given service.