Class NettyChannelBuilder.NettyTransportFactory

java.lang.Object

io.grpc.netty.NettyChannelBuilder.NettyTransportFactory

All Implemented Interfaces:

ClientTransportFactory, Closeable, AutoCloseable

Enclosing class:

NettyChannelBuilder

private static final class NettyChannelBuilder.NettyTransportFactory
extends Object
implements ClientTransportFactory

Creates Netty transports. Exposed for internal use, as it should be private.

Nested Class Summary

Nested classes/interfaces inherited from interface ClientTransportFactory

ClientTransportFactory.ClientTransportOptions, ClientTransportFactory.SwapChannelCredentialsResult

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	autoFlowControl
private final io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel>	channelFactory
private final Map<io.netty.channel.ChannelOption<?>, ?>	channelOptions
private boolean	closed
private final int	flowControlWindow
private final io.netty.channel.EventLoopGroup	group
private final ObjectPool<? extends io.netty.channel.EventLoopGroup>	groupPool
private final AtomicBackoff	keepAliveBackoff
private final long	keepAliveTimeNanos
private final long	keepAliveTimeoutNanos
private final boolean	keepAliveWithoutCalls
private final NettyChannelBuilder.LocalSocketPicker	localSocketPicker
private final int	maxHeaderListSize
private final int	maxMessageSize
private final ProtocolNegotiator	protocolNegotiator
private final Class<? extends SocketAddress>	transportSocketType
private final TransportTracer.Factory	transportTracerFactory
private final boolean	useGetForSafeMethods

Constructor Summary

Constructors

Constructor

Description

NettyTransportFactory(ProtocolNegotiator protocolNegotiator, io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory, Map<io.netty.channel.ChannelOption<?>, ?> channelOptions, ObjectPool<? extends io.netty.channel.EventLoopGroup> groupPool, boolean autoFlowControl, int flowControlWindow, int maxMessageSize, int maxHeaderListSize, long keepAliveTimeNanos, long keepAliveTimeoutNanos, boolean keepAliveWithoutCalls, TransportTracer.Factory transportTracerFactory, NettyChannelBuilder.LocalSocketPicker localSocketPicker, boolean useGetForSafeMethods, Class<? extends SocketAddress> transportSocketType)

Method Summary

Modifier and Type	Method	Description
void	close()	Releases any resources.
ScheduledExecutorService	getScheduledExecutorService()	Returns an executor for scheduling provided by the transport.
Collection<Class<? extends SocketAddress>>	getSupportedSocketAddressTypes()	Returns the SocketAddress types this transport supports.
ConnectionClientTransport	newClientTransport(SocketAddress serverAddress, ClientTransportFactory.ClientTransportOptions options, ChannelLogger channelLogger)	Creates an unstarted transport for exclusive use.
ClientTransportFactory.SwapChannelCredentialsResult	swapChannelCredentials(ChannelCredentials channelCreds)	Swaps to a new ChannelCredentials with all other settings unchanged.

Methods inherited from class Object

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

Field Details

protocolNegotiator

private final ProtocolNegotiator protocolNegotiator

channelFactory

private final io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory

channelOptions

private final Map<io.netty.channel.ChannelOption<?>, ?> channelOptions

groupPool

private final ObjectPool<? extends io.netty.channel.EventLoopGroup> groupPool

group

private final io.netty.channel.EventLoopGroup group

autoFlowControl

private final boolean autoFlowControl

flowControlWindow

private final int flowControlWindow

maxMessageSize

private final int maxMessageSize

maxHeaderListSize

private final int maxHeaderListSize

keepAliveTimeNanos

private final long keepAliveTimeNanos

keepAliveBackoff

private final AtomicBackoff keepAliveBackoff

keepAliveTimeoutNanos

private final long keepAliveTimeoutNanos

keepAliveWithoutCalls

private final boolean keepAliveWithoutCalls

transportTracerFactory

private final TransportTracer.Factory transportTracerFactory

localSocketPicker

private final NettyChannelBuilder.LocalSocketPicker localSocketPicker

useGetForSafeMethods

private final boolean useGetForSafeMethods

closed

private boolean closed

transportSocketType

private final Class<? extends SocketAddress> transportSocketType

Constructor Details

NettyTransportFactory

NettyTransportFactory(ProtocolNegotiator protocolNegotiator,
 io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory,
 Map<io.netty.channel.ChannelOption<?>, ?> channelOptions,
 ObjectPool<? extends io.netty.channel.EventLoopGroup> groupPool,
 boolean autoFlowControl,
 int flowControlWindow,
 int maxMessageSize,
 int maxHeaderListSize,
 long keepAliveTimeNanos,
 long keepAliveTimeoutNanos,
 boolean keepAliveWithoutCalls,
 TransportTracer.Factory transportTracerFactory,
 NettyChannelBuilder.LocalSocketPicker localSocketPicker,
 boolean useGetForSafeMethods,
 Class<? extends SocketAddress> transportSocketType)

Method Details

newClientTransport

public ConnectionClientTransport newClientTransport(SocketAddress serverAddress,
 ClientTransportFactory.ClientTransportOptions options,
 ChannelLogger channelLogger)

Description copied from interface: ClientTransportFactory

Creates an unstarted transport for exclusive use. Ownership of options is passed to the callee; the caller should not reuse or read from the options after this method is called.

Specified by:

newClientTransport in interface ClientTransportFactory

Parameters:

serverAddress - the address that the transport is connected to

options - additional configuration

channelLogger - logger for the transport.

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

Description copied from interface: ClientTransportFactory

Returns an executor for scheduling provided by the transport. The service should be configured to allow cancelled scheduled runnables to be GCed.

The executor should not be used after the factory has been closed. The caller should ensure any outstanding tasks are cancelled before the factory is closed. However, it is a known issue that ClientCallImpl may use this executor after close, so implementations should not go out of their way to prevent usage.

Specified by:

getScheduledExecutorService in interface ClientTransportFactory

swapChannelCredentials

public ClientTransportFactory.SwapChannelCredentialsResult swapChannelCredentials(ChannelCredentials channelCreds)

Description copied from interface: ClientTransportFactory

Swaps to a new ChannelCredentials with all other settings unchanged. Returns null if the ChannelCredentials is not supported by the current ClientTransportFactory settings.

Specified by:

swapChannelCredentials in interface ClientTransportFactory

close

public void close()

Description copied from interface: ClientTransportFactory

Releases any resources.

After this method has been called, it's no longer valid to call ClientTransportFactory.newClientTransport(SocketAddress, ClientTransportFactory.ClientTransportOptions, ChannelLogger). No guarantees about thread-safety are made.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ClientTransportFactory

Specified by:

close in interface Closeable

getSupportedSocketAddressTypes

public Collection<Class<? extends SocketAddress>> getSupportedSocketAddressTypes()

Description copied from interface: ClientTransportFactory

Returns the SocketAddress types this transport supports.

Specified by:

getSupportedSocketAddressTypes in interface ClientTransportFactory