Package io.micronaut.grpc.channels

Class GrpcManagedChannelConfiguration

java.lang.Object

io.micronaut.grpc.channels.GrpcManagedChannelConfiguration

All Implemented Interfaces:

io.micronaut.core.naming.Named

Direct Known Subclasses:

GrpcDefaultManagedChannelConfiguration, GrpcNamedManagedChannelConfiguration

public abstract class GrpcManagedChannelConfiguration
extends java.lang.Object
implements io.micronaut.core.naming.Named

A managed channel configuration.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected io.grpc.netty.NettyChannelBuilder	channelBuilder
static java.lang.String	CONNECT_ON_STARTUP
static java.lang.String	CONNECTION_TIMEOUT
protected java.lang.String	name
static java.lang.String	PREFIX
static java.lang.String	SETTING_TARGET
static java.lang.String	SETTING_URL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GrpcManagedChannelConfiguration(java.lang.String name, io.micronaut.context.env.Environment env, java.util.concurrent.ExecutorService executorService)	Constructors a new managed channel configuration.

Method Summary

Modifier and Type	Method	Description
io.grpc.netty.NettyChannelBuilder	getChannelBuilder()
java.time.Duration	getConnectionTimeout()
java.lang.String	getName()
boolean	isConnectOnStartup()

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

SETTING_TARGET

public static final java.lang.String SETTING_TARGET

See Also:

Constant Field Values

SETTING_URL

public static final java.lang.String SETTING_URL

See Also:

Constant Field Values

CONNECT_ON_STARTUP

public static final java.lang.String CONNECT_ON_STARTUP

See Also:

Constant Field Values

CONNECTION_TIMEOUT

public static final java.lang.String CONNECTION_TIMEOUT

See Also:

Constant Field Values

name

protected final java.lang.String name

channelBuilder

@ConfigurationBuilder(prefixes={"use",""},
                      allowZeroArgs=true)
protected final io.grpc.netty.NettyChannelBuilder channelBuilder

Constructor Detail

GrpcManagedChannelConfiguration

protected GrpcManagedChannelConfiguration(java.lang.String name,
                                          io.micronaut.context.env.Environment env,
                                          java.util.concurrent.ExecutorService executorService)

Constructors a new managed channel configuration.

Parameters:

name - The name

env - The environment

executorService - The executor service to use

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

name of the channel

isConnectOnStartup

public boolean isConnectOnStartup()

Returns:

true if connect on startup is set for channel

Since:

3.4.0

getConnectionTimeout

public java.time.Duration getConnectionTimeout()

Returns:

connection timeout for the channel

Since:

3.4.0

getChannelBuilder

public io.grpc.netty.NettyChannelBuilder getChannelBuilder()

Returns:

The channel builder.