Top Description Constructors Methods
io.grpc

public abstract Class ServerTransportFilter

extends Object
Class Inheritance
Annotations
@ExperimentalApi:https://github.com/grpc/grpc-java/issues/2132
Listens on server transport life-cycle events, with the capability to read and/or change transport attributes. Attributes returned by this filter will be merged into ServerCall#getAttributes.

Multiple filters maybe registered to a server, in which case the output of a filter is the input of the next filter. For example, what returned by transportReady of a filter is passed to the same method of the next filter, and the last filter's return value is the effective transport attributes.

Grpc defines commonly used attributes.

Constructor Summary

AccessConstructor and Description
public
ServerTransportFilter()

Method Summary

Modifier and TypeMethod and Description
public Attributes

Returns:

new transport attributes. Default implementation returns the passed-in attributes intact.
transportReady(Attributes
current transport attributes
transportAttrs)

Called when a transport is ready to process streams.

public void
transportTerminated(Attributes
the effective transport attributes, which is what returned by transportReady of the last executed filter.
transportAttrs)

Called when a transport is terminated.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ServerTransportFilterback to summary
public ServerTransportFilter()

Method Detail

transportReadyback to summary
public Attributes transportReady(Attributes transportAttrs)

Called when a transport is ready to process streams. All necessary handshakes, e.g., TLS handshake, are done at this point.

Note the implementation should always inherit the passed-in attributes using Attributes.newBuilder(transportAttrs), instead of creating one from scratch.

Parameters
transportAttrs:Attributes

current transport attributes

Returns:Attributes

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

transportTerminatedback to summary
public void transportTerminated(Attributes transportAttrs)

Called when a transport is terminated. Default implementation is no-op.

Parameters
transportAttrs:Attributes

the effective transport attributes, which is what returned by transportReady of the last executed filter.