Modifier and Type	Class and Description
public abstract static class	ServerStreamTracer.Factory
private static class	ServerStreamTracer.ReadOnlyServerCall<ReqT, RespT> Deprecated Will be deleted when `serverCallStarted(ServerCall)` is removed. This class exists solely to help transition to the `ServerCallInfo` based API.
public abstract static class	ServerStreamTracer.ServerCallInfo<ReqT, RespT> A data class with info about the started `ServerCall`.

Access	Constructor and Description
public	ServerStreamTracer()

Modifier and Type	Method and Description
public Context	filterContext(Context context) Called before the interceptors and the call handlers and make changes to the Context object if needed.
public void	serverCallStarted(ServerStreamTracer.ServerCallInfo<?, ?> callInfo) Called when `ServerCall` is created.
public void	serverCallStarted(ServerCall<?, ?> call) Deprecated Implement `serverCallStarted(ServerCallInfo)` instead. Called when `ServerCall` is created.

ServerStreamTracer	back to summary
public ServerStreamTracer()

filterContext	back to summary
public Context filterContext(Context context) Called before the interceptors and the call handlers and make changes to the Context object if needed.

serverCallStarted	back to summary
public void serverCallStarted(ServerStreamTracer.ServerCallInfo<?, ?> callInfo) Called when `ServerCall` is created. This is for the tracer to access information about the `ServerCall`. Called after `filterContext` and before the application call handler. Annotations @SuppressWarnings:deprecation

serverCallStarted	back to summary
public void serverCallStarted(ServerCall<?, ?> call) Deprecated Implement `serverCallStarted(ServerCallInfo)` instead. This method will be removed in a future release of gRPC. Called when `ServerCall` is created. This is for the tracer to access information about the `ServerCall`. Called after `filterContext` and before the application call handler. Annotations @Deprecated

public abstract Class ServerStreamTracer.Factory

Class Inheritance

extends Object

java.lang.Object
io.grpc.ServerStreamTracer.Factory

Constructor Summary

Access	Constructor and Description
public	Factory()

Method Summary

Modifier and Type	Method and Description
public abstract ServerStreamTracer	newServerStreamTracer(String the fully qualified method name fullMethodName, Metadata the received request headers. It can be safely mutated within this method. It should not be saved because it is not safe for read or write after the method returns. headers) Creates a `ServerStreamTracer` for a new server stream.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Factory	back to summary
public Factory()

Method Detail

newServerStreamTracer back to summary

public abstract ServerStreamTracer newServerStreamTracer(String fullMethodName, Metadata headers)

Creates a ServerStreamTracer for a new server stream.

Called right before the stream is created

Parameters

fullMethodName:String: the fully qualified method name
headers:Metadata: the received request headers. It can be safely mutated within this method. It should not be saved because it is not safe for read or write after the method returns.

io.grpc back to summary

private final Class ServerStreamTracer.ReadOnlyServerCall<ReqT, RespT>

Class Inheritance

extends ForwardingServerCall<ReqT, RespT>

java.lang.Object
io.grpc.ServerCall
io.grpc.PartialForwardingServerCall
io.grpc.ForwardingServerCall
io.grpc.ServerStreamTracer.ReadOnlyServerCall

Annotations

@Deprecated

Deprecated

Will be deleted when serverCallStarted(ServerCall) is removed.

This class exists solely to help transition to the ServerCallInfo based API.

Field Summary

Modifier and Type	Field and Description
private final ServerStreamTracer.ServerCallInfo<ReqT, RespT>	callInfo

Constructor Summary

Access	Constructor and Description
private	ReadOnlyServerCall(ServerStreamTracer.ServerCallInfo<ReqT, RespT> callInfo)

Method Summary

Modifier and Type	Method and Description
private static <ReqT, RespT> ServerStreamTracer.ReadOnlyServerCall<ReqT, RespT>	create(ServerStreamTracer.ServerCallInfo<ReqT, RespT> callInfo) Deprecated as a consequence of `ServerStreamTracer.ReadOnlyServerCall` being deprecated.
protected ServerCall<ReqT, RespT>	delegate() Implements abstract io.grpc.ForwardingServerCall.delegate. Returns the delegated `ServerCall`.
public Attributes	getAttributes() Overrides io.grpc.PartialForwardingServerCall.getAttributes. Returns properties of a single call.
public String	getAuthority() Overrides io.grpc.PartialForwardingServerCall.getAuthority. Gets the authority this call is addressed to.
public MethodDescriptor<ReqT, RespT>	getMethodDescriptor() Overrides io.grpc.ForwardingServerCall.getMethodDescriptor. The `MethodDescriptor` for the call.
public boolean	isCancelled() Overrides io.grpc.PartialForwardingServerCall.isCancelled. Returns `true` when the call is cancelled and the server is encouraged to abort processing to save resources, since the client will not be processing any further methods.
public boolean	isReady() Overrides io.grpc.PartialForwardingServerCall.isReady. If `true`, indicates that the call is capable of sending additional messages without requiring excessive buffering internally.

Inherited from io.grpc.ForwardingServerCall:: sendMessage

Field Detail

callInfo	back to summary
private final ServerStreamTracer.ServerCallInfo<ReqT, RespT> callInfo

Constructor Detail

ReadOnlyServerCall	back to summary
private ReadOnlyServerCall(ServerStreamTracer.ServerCallInfo<ReqT, RespT> callInfo)

Method Detail

create	back to summary
private static <ReqT, RespT> ServerStreamTracer.ReadOnlyServerCall<ReqT, RespT> create(ServerStreamTracer.ServerCallInfo<ReqT, RespT> callInfo) Deprecated as a consequence of `ServerStreamTracer.ReadOnlyServerCall` being deprecated. See corresponding docs for further information.

delegate back to summary

delegate	back to summary
protected ServerCall<ReqT, RespT> delegate() Implements abstract io.grpc.ForwardingServerCall.delegate. Doc from io.grpc.ForwardingServerCall.delegate. Returns the delegated `ServerCall`. Annotations @Override

protected ServerCall<ReqT, RespT> delegate()

Implements abstract io.grpc.ForwardingServerCall.delegate.

Doc from io.grpc.ForwardingServerCall.delegate.

Returns the delegated ServerCall.

Annotations

@Override

getAttributes back to summary

getAttributes	back to summary
public Attributes getAttributes() Overrides io.grpc.PartialForwardingServerCall.getAttributes. Doc from io.grpc.ServerCall.getAttributes. Returns properties of a single call. Attributes originate from the transport and can be altered by `ServerTransportFilter`. Returns:Attributes non-`null` Attributes container Annotations @Override

public Attributes getAttributes()

Overrides io.grpc.PartialForwardingServerCall.getAttributes.

Doc from io.grpc.ServerCall.getAttributes.

Returns properties of a single call.

Attributes originate from the transport and can be altered by ServerTransportFilter.

Returns:Attributes

non-null Attributes container

Annotations

@Override

getAuthority back to summary

getAuthority	back to summary
public String getAuthority() Overrides io.grpc.PartialForwardingServerCall.getAuthority. Doc from io.grpc.ServerCall.getAuthority. Gets the authority this call is addressed to. Returns:String the authority string. `null` if not available. Annotations @Override

public String getAuthority()

Overrides io.grpc.PartialForwardingServerCall.getAuthority.

Doc from io.grpc.ServerCall.getAuthority.

Gets the authority this call is addressed to.

Returns:String

the authority string. null if not available.

Annotations

@Override

getMethodDescriptor back to summary

getMethodDescriptor	back to summary
public MethodDescriptor<ReqT, RespT> getMethodDescriptor() Overrides io.grpc.ForwardingServerCall.getMethodDescriptor. Doc from io.grpc.ServerCall.getMethodDescriptor. The `MethodDescriptor` for the call. Annotations @Override

public MethodDescriptor<ReqT, RespT> getMethodDescriptor()

Overrides io.grpc.ForwardingServerCall.getMethodDescriptor.

Doc from io.grpc.ServerCall.getMethodDescriptor.

The MethodDescriptor for the call.

Annotations

@Override

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Overrides io.grpc.PartialForwardingServerCall.isCancelled. Doc from io.grpc.ServerCall.isCancelled. Returns `true` when the call is cancelled and the server is encouraged to abort processing to save resources, since the client will not be processing any further methods. Cancellations can be caused by timeouts, explicit cancel by client, network errors, and similar. This method may safely be called concurrently from multiple threads. Annotations @Override

public boolean isCancelled()

Overrides io.grpc.PartialForwardingServerCall.isCancelled.

Doc from io.grpc.ServerCall.isCancelled.

Returns true when the call is cancelled and the server is encouraged to abort processing to save resources, since the client will not be processing any further methods. Cancellations can be caused by timeouts, explicit cancel by client, network errors, and similar.

This method may safely be called concurrently from multiple threads.

Annotations

@Override

isReady back to summary

isReady	back to summary
public boolean isReady() Overrides io.grpc.PartialForwardingServerCall.isReady. Doc from io.grpc.ServerCall.isReady. If `true`, indicates that the call is capable of sending additional messages without requiring excessive buffering internally. This event is just a suggestion and the application is free to ignore it, however doing so may result in excessive buffering within the call. If `false`, `Listener#onReady()` will be called after `isReady()` transitions to `true`. This abstract class's implementation always returns `true`. Implementations generally override the method. Annotations @Override

public boolean isReady()

Overrides io.grpc.PartialForwardingServerCall.isReady.

Doc from io.grpc.ServerCall.isReady.

If true, indicates that the call is capable of sending additional messages without requiring excessive buffering internally. This event is just a suggestion and the application is free to ignore it, however doing so may result in excessive buffering within the call.

If false, Listener#onReady() will be called after isReady() transitions to true.

This abstract class's implementation always returns true. Implementations generally override the method.

Annotations

@Override

io.grpc back to summary

public abstract Class ServerStreamTracer.ServerCallInfo<ReqT, RespT>

Class Inheritance

extends Object

java.lang.Object
io.grpc.ServerStreamTracer.ServerCallInfo

A data class with info about the started ServerCall.

Constructor Summary

Access	Constructor and Description
public	ServerCallInfo()

Method Summary

Modifier and Type	Method and Description
public abstract Attributes	getAttributes()
public abstract String	getAuthority()
public abstract MethodDescriptor<ReqT, RespT>	getMethodDescriptor()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ServerCallInfo	back to summary
public ServerCallInfo()

Method Detail

getAttributes	back to summary
public abstract Attributes getAttributes()

getAuthority	back to summary
public abstract String getAuthority() Annotations @Nullable

getMethodDescriptor	back to summary
public abstract MethodDescriptor<ReqT, RespT> getMethodDescriptor()

public abstract Class ServerStreamTracer

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public abstract Class ServerStreamTracer.Factory

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class ServerStreamTracer.ReadOnlyServerCall<ReqT, RespT>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class ServerStreamTracer.ServerCallInfo<ReqT, RespT>

Constructor Summary

Method Summary

Constructor Detail

Method Detail