Interface TransportChannel (2.91.0)

public interface TransportChannel extends BackgroundResource

Class whose instances can issue RPCs on a particular transport.

Implements

BackgroundResource

Methods

getEmptyCallContext()

public abstract ApiCallContext getEmptyCallContext()

Returns an empty ApiCallContext that is compatible with this TransportChannel.

Returns
Type Description
ApiCallContext

getGeneration()

public default long getGeneration()

Returns a monotonic generation counter tracking the number of successful refreshes or channel rotations performed by this transport channel.

Returns
Type Description
long

getTransportName()

public abstract String getTransportName()

The name of the transport.

This string can be used for identifying transports for switching logic.

Returns
Type Description
String

refresh()

public default void refresh()

Refreshes or recreates the underlying network connections of this transport channel.

By default, this is a no-op for transports that do not require stateful connection lifecycle management.

shouldRefresh()

public default boolean shouldRefresh()

Returns true if a certificate rotation has been detected on disk and the transport channel should be refreshed, or false otherwise.

Returns
Type Description
boolean