Package io.grpc.internal

Class TransportTracer

java.lang.Object

io.grpc.internal.TransportTracer

public final class TransportTracer
extends Object

A class for gathering statistics about a transport. This is an experimental feature. Can only be called from the transport thread unless otherwise noted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TransportTracer.Factory
static interface	TransportTracer.FlowControlReader	An interface for reading the local and remote flow control windows of the transport.
static final class	TransportTracer.FlowControlWindows	A container that holds the local and remote flow control window sizes.

Constructor Summary

Constructors

Constructor	Description
TransportTracer()

Method Summary

Modifier and Type	Method	Description
static TransportTracer.Factory	getDefaultFactory()
InternalChannelz.TransportStats	getStats()	Returns a read only set of current stats.
void	reportKeepAliveSent()	Reports that a keep alive message was sent.
void	reportLocalStreamStarted()	Called by the client to report a stream has started.
void	reportMessageReceived()	Reports that a message was successfully received.
void	reportMessageSent(int numMessages)	Reports that some messages were successfully sent.
void	reportRemoteStreamStarted()	Called by the server to report a stream has started.
void	reportStreamClosed(boolean success)	Reports that a stream closed with the specified Status.
void	setFlowControlWindowReader(TransportTracer.FlowControlReader flowControlWindowReader)	Registers a TransportTracer.FlowControlReader that can be used to read the local and remote flow control window sizes.

Methods inherited from class java.lang.Object

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

Constructor Details

TransportTracer

public TransportTracer()

Method Details

getStats

public InternalChannelz.TransportStats getStats()

Returns a read only set of current stats.

reportLocalStreamStarted

public void reportLocalStreamStarted()

Called by the client to report a stream has started.

reportRemoteStreamStarted

public void reportRemoteStreamStarted()

Called by the server to report a stream has started.

reportStreamClosed

public void reportStreamClosed(boolean success)

Reports that a stream closed with the specified Status.

reportMessageSent

public void reportMessageSent(int numMessages)

Reports that some messages were successfully sent. numMessages must be at least 0.

reportMessageReceived

public void reportMessageReceived()

Reports that a message was successfully received. This method is thread safe.

reportKeepAliveSent

public void reportKeepAliveSent()

Reports that a keep alive message was sent.

setFlowControlWindowReader

public void setFlowControlWindowReader(TransportTracer.FlowControlReader flowControlWindowReader)

Registers a TransportTracer.FlowControlReader that can be used to read the local and remote flow control window sizes.

getDefaultFactory

public static TransportTracer.Factory getDefaultFactory()