Class InProcessChannelBuilder.InProcessClientTransportFactory

java.lang.Object

io.grpc.inprocess.InProcessChannelBuilder.InProcessClientTransportFactory

All Implemented Interfaces:

ClientTransportFactory, Closeable, AutoCloseable

Enclosing class:

InProcessChannelBuilder

static final class InProcessChannelBuilder.InProcessClientTransportFactory
extends Object
implements ClientTransportFactory

Creates InProcess 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 long	assumedMessageSize
private boolean	closed
private final boolean	includeCauseWithStatus
private final int	maxInboundMetadataSize
private final ScheduledExecutorService	timerService
private final boolean	useSharedTimer

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InProcessClientTransportFactory(ScheduledExecutorService scheduledExecutorService, int maxInboundMetadataSize, boolean includeCauseWithStatus, long assumedMessageSize)

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 addr, 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

timerService

private final ScheduledExecutorService timerService

useSharedTimer

private final boolean useSharedTimer

maxInboundMetadataSize

private final int maxInboundMetadataSize

closed

private boolean closed

includeCauseWithStatus

private final boolean includeCauseWithStatus

assumedMessageSize

private long assumedMessageSize

Constructor Details

InProcessClientTransportFactory

private InProcessClientTransportFactory(@Nullable
 ScheduledExecutorService scheduledExecutorService,
 int maxInboundMetadataSize,
 boolean includeCauseWithStatus,
 long assumedMessageSize)

Method Details

newClientTransport

public ConnectionClientTransport newClientTransport(SocketAddress addr,
 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:

addr - 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