Package io.grpc

Class ClientTransportFilter

java.lang.Object

io.grpc.ClientTransportFilter

@ExperimentalApi("https://gitub.com/grpc/grpc-java/issues/10652")
public abstract class ClientTransportFilter
extends Object

Listens on the client transport life-cycle events. These filters do not have the capability to modify the channels or transport life-cycle event behavior, but they can be useful hooks for transport observability. Multiple filters may be registered to the client.

Since:

1.62.0

Constructor Summary

Constructors

Constructor	Description
ClientTransportFilter()

Method Summary

Modifier and Type	Method	Description
Attributes	transportReady(Attributes transportAttrs)	Called when a transport is ready to accept traffic (when a connection has been established).
void	transportTerminated(Attributes transportAttrs)	Called when a transport completed shutting down.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientTransportFilter

public ClientTransportFilter()

Method Details

transportReady

public Attributes transportReady(Attributes transportAttrs)

Called when a transport is ready to accept traffic (when a connection has been established). The default implementation is a no-op.

Parameters:

transportAttrs - current transport attributes

Returns:

new transport attributes. Default implementation returns the passed-in attributes intact.

transportTerminated

public void transportTerminated(Attributes transportAttrs)

Called when a transport completed shutting down. All resources have been released. All streams have either been closed or transferred off this transport. Default implementation is a no-op

Parameters:

transportAttrs - the effective transport attributes, which is what is returned by transportReady(io.grpc.Attributes) of the last executed filter.