Interface ClientTransportFactory

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CallCredentialsApplyingTransportFactory, InProcessChannelBuilder.InProcessClientTransportFactory, NettyChannelBuilder.NettyTransportFactory

public interface ClientTransportFactory
extends Closeable

Pre-configured factory for creating ConnectionClientTransport instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ClientTransportFactory.ClientTransportOptions	Options passed to newClientTransport(SocketAddress, ClientTransportFactory.ClientTransportOptions, ChannelLogger).
static final class	ClientTransportFactory.SwapChannelCredentialsResult

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.

Method Details

newClientTransport

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

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.

Parameters:

serverAddress - the address that the transport is connected to

options - additional configuration

channelLogger - logger for the transport.

getScheduledExecutorService

ScheduledExecutorService getScheduledExecutorService()

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.

swapChannelCredentials

@CheckReturnValue
@Nullable
ClientTransportFactory.SwapChannelCredentialsResult swapChannelCredentials(ChannelCredentials channelCreds)

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

close

void close()

Releases any resources.

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getSupportedSocketAddressTypes

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

Returns the SocketAddress types this transport supports.