Modifier and Type	Class and Description
public abstract static class	ClientStreamTracer.Factory Factory class for `ClientStreamTracer`.
public static class	ClientStreamTracer.StreamInfo Information about a stream.

Modifier and Type	Field and Description
public static final CallOptions.Key<Long>	NAME_RESOLUTION_DELAYED Indicates how long the call was delayed, in nanoseconds, due to waiting for name resolution result.

Access	Constructor and Description
public	ClientStreamTracer()

Modifier and Type	Method and Description
public void	createPendingStream() Name resolution is completed and the connection starts getting established.
public void	inboundHeaders() Headers has been received from the server.
public void	inboundTrailers(Metadata the mutable trailing metadata. Modifications to it will be seen by interceptors and the application. trailers) Trailing metadata has been received from the server.
public void	outboundHeaders() Headers has been sent to the socket.
public void	streamCreated(Attributes transportAttrs, Metadata the mutable initial metadata. Modifications to it will be sent to the socket but not be seen by client interceptors and the application. headers) The stream is being created on a ready transport.

NAME_RESOLUTION_DELAYED	back to summary
public static final CallOptions.Key<Long> NAME_RESOLUTION_DELAYED Indicates how long the call was delayed, in nanoseconds, due to waiting for name resolution result. If the call option is not set, the call did not experience name resolution delay.

ClientStreamTracer	back to summary
public ClientStreamTracer()

Method Detail

createPendingStream	back to summary
public void createPendingStream() Name resolution is completed and the connection starts getting established. This method is only invoked on the streams that encounter such delay. gRPC buffers the client call if the remote address and configurations, e.g. timeouts and retry policy, are not ready. Asynchronously gRPC internally does the name resolution to get this information. The streams that are processed immediately on ready transports by the time the RPC comes do not go through the pending process, thus this callback will not be invoked.

createPendingStream

public void createPendingStream()

Name resolution is completed and the connection starts getting established. This method is only invoked on the streams that encounter such delay.

gRPC buffers the client call if the remote address and configurations, e.g. timeouts and retry policy, are not ready. Asynchronously gRPC internally does the name resolution to get this information. The streams that are processed immediately on ready transports by the time the RPC comes do not go through the pending process, thus this callback will not be invoked.

inboundHeaders	back to summary
public void inboundHeaders() Headers has been received from the server.

inboundTrailers

back to summary

public void inboundTrailers(Metadata trailers)

Trailing metadata has been received from the server.

Parameters

trailers:Metadata: the mutable trailing metadata. Modifications to it will be seen by interceptors and the application.

Since

1.17.0

outboundHeaders	back to summary
public void outboundHeaders() Headers has been sent to the socket.

streamCreated

back to summary

public void streamCreated(Attributes transportAttrs, Metadata headers)

The stream is being created on a ready transport.

Parameters

headers:Metadata: the mutable initial metadata. Modifications to it will be sent to the socket but not be seen by client interceptors and the application.

Since

1.40.0

io.grpc back to summary

public abstract Class ClientStreamTracer.Factory

Class Inheritance

extends Object

java.lang.Object
io.grpc.ClientStreamTracer.Factory

Factory class for ClientStreamTracer.

Constructor Summary

Access	Constructor and Description
public	Factory()

Method Summary

Modifier and Type	Method and Description
public ClientStreamTracer	newClientStreamTracer(ClientStreamTracer.StreamInfo information about the stream info, Metadata the mutable headers of the stream. It can be safely mutated within this method. Changes made to it will be sent by the stream. It should not be saved because it is not safe for read or write after the method returns. headers) Creates a `ClientStreamTracer` for a new client 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

newClientStreamTracer back to summary

public ClientStreamTracer newClientStreamTracer(ClientStreamTracer.StreamInfo info, Metadata headers)

Creates a ClientStreamTracer for a new client stream. This is called inside the transport when it's creating the stream.

Parameters

info:ClientStreamTracer.StreamInfo: information about the stream
headers:Metadata: the mutable headers of the stream. It can be safely mutated within this method. Changes made to it will be sent by the stream. It should not be saved because it is not safe for read or write after the method returns.

Since

1.20.0

io.grpc back to summary

public final Class ClientStreamTracer.StreamInfo

Class Inheritance

extends Object

java.lang.Object
io.grpc.ClientStreamTracer.StreamInfo

Annotations

@ExperimentalApi:https://github.com/grpc/grpc-java/issues/2861

Information about a stream.

Note this class doesn't override equals() and hashCode, as is the case for CallOptions.

Since: 1.20.0

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ClientStreamTracer.StreamInfo.Builder Builds `StreamInfo` objects.

Field Summary

Modifier and Type	Field and Description
private final CallOptions	callOptions
private final boolean	isTransparentRetry
private final int	previousAttempts

Constructor Summary

Access	Constructor and Description
pack-priv	StreamInfo(CallOptions callOptions, int previousAttempts, boolean isTransparentRetry)

Method Summary

Modifier and Type	Method and Description
public CallOptions	getCallOptions() Returns the effective CallOptions of the call.
public int	getPreviousAttempts() Returns the number of preceding attempts for the RPC.
public boolean	isTransparentRetry() Whether the stream is a transparent retry.
public static ClientStreamTracer.StreamInfo.Builder	newBuilder() Creates an empty Builder.
public ClientStreamTracer.StreamInfo.Builder	toBuilder() Converts this StreamInfo into a new Builder.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

callOptions	back to summary
private final CallOptions callOptions

isTransparentRetry	back to summary
private final boolean isTransparentRetry

previousAttempts	back to summary
private final int previousAttempts

Constructor Detail

StreamInfo	back to summary
pack-priv StreamInfo(CallOptions callOptions, int previousAttempts, boolean isTransparentRetry)

Method Detail

getCallOptions	back to summary
public CallOptions getCallOptions() Returns the effective CallOptions of the call.

getPreviousAttempts	back to summary
public int getPreviousAttempts() Returns the number of preceding attempts for the RPC. Since 1.40.0

getPreviousAttempts

back to summary

public int getPreviousAttempts()

Returns the number of preceding attempts for the RPC.

Since: 1.40.0

isTransparentRetry	back to summary
public boolean isTransparentRetry() Whether the stream is a transparent retry. Since 1.40.0

isTransparentRetry

back to summary

public boolean isTransparentRetry()

Whether the stream is a transparent retry.

Since: 1.40.0

newBuilder	back to summary
public static ClientStreamTracer.StreamInfo.Builder newBuilder() Creates an empty Builder. Since 1.21.0

newBuilder

back to summary

public static ClientStreamTracer.StreamInfo.Builder newBuilder()

Creates an empty Builder.

Since: 1.21.0

toBuilder	back to summary
public ClientStreamTracer.StreamInfo.Builder toBuilder() Converts this StreamInfo into a new Builder. Since 1.21.0

toBuilder

back to summary

public ClientStreamTracer.StreamInfo.Builder toBuilder()

Converts this StreamInfo into a new Builder.

Since: 1.21.0

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

io.grpc back to summary

public final Class ClientStreamTracer.StreamInfo.Builder

Class Inheritance

extends Object

java.lang.Object
io.grpc.ClientStreamTracer.StreamInfo.Builder

Builds StreamInfo objects.

Since: 1.21.0

Field Summary

Modifier and Type	Field and Description
private CallOptions	callOptions
private boolean	isTransparentRetry
private int	previousAttempts

Constructor Summary

Access	Constructor and Description
pack-priv	Builder()

Method Summary

Modifier and Type	Method and Description
public ClientStreamTracer.StreamInfo	build() Builds a new StreamInfo.
public ClientStreamTracer.StreamInfo.Builder	setCallOptions(CallOptions callOptions) Sets the effective CallOptions of the call.
public ClientStreamTracer.StreamInfo.Builder	setIsTransparentRetry(boolean isTransparentRetry) Sets whether the stream is a transparent retry.
public ClientStreamTracer.StreamInfo.Builder	setPreviousAttempts(int previousAttempts) Set the number of preceding attempts of the RPC.

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

Field Detail

callOptions	back to summary
private CallOptions callOptions

isTransparentRetry	back to summary
private boolean isTransparentRetry

previousAttempts	back to summary
private int previousAttempts

Constructor Detail

Builder	back to summary
pack-priv Builder()

Method Detail

build	back to summary
public ClientStreamTracer.StreamInfo build() Builds a new StreamInfo.

setCallOptions	back to summary
public ClientStreamTracer.StreamInfo.Builder setCallOptions(CallOptions callOptions) Sets the effective CallOptions of the call. This field is optional.

setIsTransparentRetry	back to summary
public ClientStreamTracer.StreamInfo.Builder setIsTransparentRetry(boolean isTransparentRetry) Sets whether the stream is a transparent retry. Since 1.40.0

setIsTransparentRetry

back to summary

public ClientStreamTracer.StreamInfo.Builder setIsTransparentRetry(boolean isTransparentRetry)

Sets whether the stream is a transparent retry.

Since: 1.40.0

setPreviousAttempts	back to summary
public ClientStreamTracer.StreamInfo.Builder setPreviousAttempts(int previousAttempts) Set the number of preceding attempts of the RPC. Since 1.40.0

setPreviousAttempts

back to summary

public ClientStreamTracer.StreamInfo.Builder setPreviousAttempts(int previousAttempts)

Set the number of preceding attempts of the RPC.

Since: 1.40.0