Class InProcessTransport
- All Implemented Interfaces:
ClientTransport
,ConnectionClientTransport
,ManagedClientTransport
,ServerTransport
,InternalInstrumented<InternalChannelz.SocketStats>
,InternalWithLogId
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
private static class
Nested classes/interfaces inherited from interface io.grpc.internal.ClientTransport
ClientTransport.PingCallback
Nested classes/interfaces inherited from interface io.grpc.internal.ManagedClientTransport
ManagedClientTransport.Listener
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final SocketAddress
private final long
private Attributes
private final String
private final int
private ManagedClientTransport.Listener
private final boolean
private final InUseStateAggregator
<InProcessTransport.InProcessStream> (package private) static boolean
private static final Logger
private final InternalLogId
private int
private ScheduledExecutorService
private ObjectPool
<ScheduledExecutorService> private Attributes
private List
<ServerStreamTracer.Factory> private ServerTransportListener
private boolean
private Status
private final Set
<InProcessTransport.InProcessStream> private boolean
private Thread.UncaughtExceptionHandler
private final String
-
Constructor Summary
ConstructorsConstructorDescriptionInProcessTransport
(SocketAddress address, int maxInboundMetadataSize, String authority, String userAgent, Attributes eagAttrs, boolean includeCauseWithStatus, long assumedMessageSize) -
Method Summary
Modifier and TypeMethodDescriptionprivate static Status
cleanStatus
(Status status, boolean includeCauseWithStatus) Returns a new status with the same code and description.private ClientStream
failedClientStream
(StatsTraceContext statsTraceCtx, Status status) Returns a set of attributes, which may vary depending on the state of the transport.getLogId()
Returns an ID that is primarily used in debug logs.Returns an executor for scheduling provided by the transport.com.google.common.util.concurrent.ListenableFuture
<InternalChannelz.SocketStats> getStats()
Returns the stats object.private static int
metadataSize
(Metadata metadata) newStream
(MethodDescriptor<?, ?> method, Metadata headers, CallOptions callOptions, ClientStreamTracer[] tracers) Creates a new stream for sending messages to a remote end-point.private void
private void
void
ping
(ClientTransport.PingCallback callback, Executor executor) Pings a remote endpoint.void
shutdown()
Initiates an orderly shutdown of the transport.void
Initiates an orderly shutdown of the transport.void
shutdownNow
(Status reason) Initiates a forceful shutdown in which preexisting and new calls are closed.start
(ManagedClientTransport.Listener listener) Starts transport.toString()
-
Field Details
-
log
-
isEnabledSupportTracingMessageSizes
static boolean isEnabledSupportTracingMessageSizes -
logId
-
address
-
clientMaxInboundMetadataSize
private final int clientMaxInboundMetadataSize -
authority
-
userAgent
-
serverMaxInboundMetadataSize
private int serverMaxInboundMetadataSize -
includeCauseWithStatus
private final boolean includeCauseWithStatus -
serverSchedulerPool
-
serverScheduler
-
serverTransportListener
-
serverStreamAttributes
-
clientTransportListener
-
assumedMessageSize
private final long assumedMessageSize -
shutdown
private boolean shutdown -
terminated
private boolean terminated -
shutdownStatus
-
streams
-
serverStreamTracerFactories
-
attributes
-
uncaughtExceptionHandler
-
inUseState
-
-
Constructor Details
-
InProcessTransport
public InProcessTransport(SocketAddress address, int maxInboundMetadataSize, String authority, String userAgent, Attributes eagAttrs, boolean includeCauseWithStatus, long assumedMessageSize)
-
-
Method Details
-
start
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 interfaceManagedClientTransport
- 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
-
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(io.grpc.Status, io.grpc.internal.ClientStreamListener.RpcProgress, io.grpc.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 theClientCall
.- Specified by:
newStream
in interfaceClientTransport
- Parameters:
method
- the descriptor of the remote method to be called for this stream.headers
- to send at the beginning of the callcallOptions
- runtime options of the calltracers
- 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.
-
failedClientStream
-
ping
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 interfaceClientTransport
-
shutdown
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 (onceManagedClientTransport.Listener.transportShutdown(io.grpc.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 interfaceManagedClientTransport
-
shutdown
public void shutdown()Description copied from interface:ServerTransport
Initiates an orderly shutdown of the transport. Existing streams continue, but new streams will eventually begin failing. New streams "eventually" begin failing because shutdown may need to be processed on a separate thread. May only be called once.- Specified by:
shutdown
in interfaceServerTransport
-
shutdownNow
Description copied from interface:ServerTransport
Initiates a forceful shutdown in which preexisting and new calls are closed. Existing calls should be closed with the providedreason
.- Specified by:
shutdownNow
in interfaceManagedClientTransport
- Specified by:
shutdownNow
in interfaceServerTransport
-
toString
-
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 interfaceInternalWithLogId
-
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 interfaceConnectionClientTransport
-
getScheduledExecutorService
Description copied from interface:ServerTransport
Returns an executor for scheduling provided by the transport. The service should be configured to allow cancelled scheduled runnables to be GCed.The executor may not be used after the transport terminates. The caller should ensure any outstanding tasks are cancelled when the transport terminates.
- Specified by:
getScheduledExecutorService
in interfaceServerTransport
-
getStats
Description copied from interface:InternalInstrumented
Returns the stats object.- Specified by:
getStats
in interfaceInternalInstrumented<InternalChannelz.SocketStats>
-
notifyShutdown
-
notifyTerminated
private void notifyTerminated() -
metadataSize
-
cleanStatus
Returns a new status with the same code and description. If includeCauseWithStatus is true, cause is also included.For InProcess transport to behave in the same way as the other transports, when exchanging statuses between client and server and vice versa, the cause should be excluded from the status. For easier debugging, the status may be optionally included.
-