Class ForwardingConnectionClientTransport

java.lang.Object

io.grpc.internal.ForwardingConnectionClientTransport

All Implemented Interfaces:

ClientTransport, ConnectionClientTransport, ManagedClientTransport, InternalInstrumented<InternalChannelz.SocketStats>, InternalWithLogId

Direct Known Subclasses:

CallCredentialsApplyingTransportFactory.CallCredentialsApplyingTransport, InternalSubchannel.CallTracingTransport

abstract class ForwardingConnectionClientTransport
extends Object
implements ConnectionClientTransport

Nested Class Summary

Nested classes/interfaces inherited from interface ClientTransport

ClientTransport.PingCallback

Nested classes/interfaces inherited from interface ManagedClientTransport

ManagedClientTransport.Listener

Constructor Summary

Constructors

Constructor	Description
ForwardingConnectionClientTransport()

Method Summary

Modifier and Type	Method	Description
protected abstract ConnectionClientTransport	delegate()
Attributes	getAttributes()	Returns a set of attributes, which may vary depending on the state of the transport.
InternalLogId	getLogId()	Returns an ID that is primarily used in debug logs.
com.google.common.util.concurrent.ListenableFuture<InternalChannelz.SocketStats>	getStats()	Returns the stats object.
ClientStream	newStream(MethodDescriptor<?,?> method, Metadata headers, CallOptions callOptions, ClientStreamTracer[] tracers)	Creates a new stream for sending messages to a remote end-point.
void	ping(ClientTransport.PingCallback callback, Executor executor)	Pings a remote endpoint.
void	shutdown(Status status)	Initiates an orderly shutdown of the transport.
void	shutdownNow(Status status)	Initiates a forceful shutdown in which preexisting and new calls are closed.
Runnable	start(ManagedClientTransport.Listener listener)	Starts transport.
String	toString()

Methods inherited from class Object

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

Constructor Details

ForwardingConnectionClientTransport

ForwardingConnectionClientTransport()

Method Details

start

public Runnable start(ManagedClientTransport.Listener listener)

Description copied from interface: ManagedClientTransport

Starts transport. This method may only be called once.

This method and the returned Runnable should not throw any exceptions.

Specified by:

start in interface ManagedClientTransport

Parameters:

listener - non-null listener of transport events

Returns:

a Runnable that is executed after-the-fact by the original caller, typically after locks are released

shutdown

public void shutdown(Status status)

Description copied from interface: ManagedClientTransport

Initiates an orderly shutdown of the transport. Existing streams continue, but the transport will not own any new streams. New streams will either fail (once ManagedClientTransport.Listener.transportShutdown(Status) callback called), or be transferred off this transport (in which case they may succeed). This method may only be called once.

Specified by:

shutdown in interface ManagedClientTransport

shutdownNow

public void shutdownNow(Status status)

Description copied from interface: ManagedClientTransport

Initiates a forceful shutdown in which preexisting and new calls are closed. Existing calls should be closed with the provided reason.

Specified by:

shutdownNow in interface ManagedClientTransport

newStream

public ClientStream newStream(MethodDescriptor<?,?> method,
 Metadata headers,
 CallOptions callOptions,
 ClientStreamTracer[] tracers)

Description copied from interface: ClientTransport

Creates a new stream for sending messages to a remote end-point.

This method returns immediately and does not wait for any validation of the request. If creation fails for any reason, ClientStreamListener.closed(Status, ClientStreamListener.RpcProgress, Metadata) will be called to provide the error information. Any sent messages for this stream will be buffered until creation has completed (either successfully or unsuccessfully).

This method is called under the Context of the ClientCall.

Specified by:

newStream in interface ClientTransport

Parameters:

method - the descriptor of the remote method to be called for this stream.

headers - to send at the beginning of the call

callOptions - runtime options of the call

tracers - a non-empty array of tracers. The last element in it is reserved to be set by the load balancer's pick result and otherwise is a no-op tracer.

Returns:

the newly created stream.

ping

public void ping(ClientTransport.PingCallback callback,
 Executor executor)

Description copied from interface: ClientTransport

Pings a remote endpoint. When an acknowledgement is received, the given callback will be invoked using the given executor.

Pings are not necessarily sent to the same endpoint, thus a successful ping only means at least one endpoint responded, but doesn't imply the availability of other endpoints (if there is any).

This is an optional method. Transports that do not have any mechanism by which to ping the remote endpoint may throw UnsupportedOperationException.

Specified by:

ping in interface ClientTransport

getLogId

public InternalLogId getLogId()

Description copied from interface: InternalWithLogId

Returns an ID that is primarily used in debug logs. It usually contains the class name and a numeric ID that is unique among the instances.

The subclasses of this interface usually want to include the log ID in their Object.toString() results.

Specified by:

getLogId in interface InternalWithLogId

getAttributes

public Attributes getAttributes()

Description copied from interface: ConnectionClientTransport

Returns a set of attributes, which may vary depending on the state of the transport. The keys should define in what states they will be present.

Specified by:

getAttributes in interface ConnectionClientTransport

toString

public String toString()

Overrides:

toString in class Object

getStats

public com.google.common.util.concurrent.ListenableFuture<InternalChannelz.SocketStats> getStats()

Description copied from interface: InternalInstrumented

Returns the stats object.

Specified by:

getStats in interface InternalInstrumented<InternalChannelz.SocketStats>

delegate

protected abstract ConnectionClientTransport delegate()