Uses of Class
io.grpc.Attributes
Packages that use Attributes
Package
Description
The gRPC core public API.
The in-process transport which is for when a server is in the same process as the client.
Interfaces and implementations that are internal to gRPC.
The main transport implementation based on Netty,
for both the client and the server.
Service definitions and utilities with protobuf dependency for the pre-defined gRPC services.
API that implements gRPC server as a servlet.
API that implements gRPC server as a servlet.
Utilities with advanced features in the core layer that user can optionally use.
-
Uses of Attributes in io.grpc
Fields in io.grpc declared as AttributesModifier and TypeFieldDescriptionprivate final Attributes
LoadBalancer.ResolvedAddresses.attributes
private Attributes
LoadBalancer.ResolvedAddresses.Builder.attributes
private final Attributes
NameResolver.ResolutionResult.attributes
private Attributes
NameResolver.ResolutionResult.Builder.attributes
private final Attributes
EquivalentAddressGroup.attrs
private final Attributes
LoadBalancer.CreateSubchannelArgs.attrs
private Attributes
LoadBalancer.CreateSubchannelArgs.Builder.attrs
private Attributes
Attributes.Builder.base
static final Attributes
Attributes.EMPTY
Methods in io.grpc that return AttributesModifier and TypeMethodDescriptionAttributes.Builder.build()
Build the attributes.ClientCall.getAttributes()
Returns additional properties of the call.EquivalentAddressGroup.getAttributes()
Returns the attributes.LoadBalancer.CreateSubchannelArgs.getAttributes()
Returns the attributes.LoadBalancer.ResolvedAddresses.getAttributes()
Gets the attributes associated with these addresses.abstract Attributes
LoadBalancer.Subchannel.getAttributes()
The same attributes passed toHelper.createSubchannel()
.NameResolver.ResolutionResult.getAttributes()
Gets the attributes associated with the addresses resolved by name resolution.PartialForwardingClientCall.getAttributes()
PartialForwardingServerCall.getAttributes()
ServerCall.getAttributes()
Returns properties of a single call.ServerStreamTracer.ReadOnlyServerCall.getAttributes()
Deprecated.abstract Attributes
ServerStreamTracer.ServerCallInfo.getAttributes()
InternalSubchannelAddressAttributes.getConnectedAddressAttributes()
Return attributes of the server address connected by sub channel.LoadBalancer.Subchannel.getConnectedAddressAttributes()
(Internal use only) returns attributes of the address subchannel is connected to.abstract Attributes
CallCredentials.RequestInfo.getTransportAttrs()
Returns the transport attributes.ClientTransportFilter.transportReady
(Attributes transportAttrs) Called when a transport is ready to accept traffic (when a connection has been established).ServerTransportFilter.transportReady
(Attributes transportAttrs) Called when a transport is ready to process streams.Methods in io.grpc with parameters of type AttributesModifier and TypeMethodDescriptionstatic Attributes.Builder
Attributes.newBuilder
(Attributes base) Deprecated.void
NameResolver.Listener.onAddresses
(List<EquivalentAddressGroup> servers, Attributes attributes) Handles updates on resolved addresses and attributes.final void
NameResolver.Listener2.onAddresses
(List<EquivalentAddressGroup> servers, Attributes attributes) Deprecated.This will be removed in 1.22.0Attributes.Builder.setAll
(Attributes other) LoadBalancer.CreateSubchannelArgs.Builder.setAttributes
(Attributes attrs) Attributes provided here will be included inLoadBalancer.Subchannel.getAttributes()
.LoadBalancer.ResolvedAddresses.Builder.setAttributes
(Attributes attributes) Sets the attributes.NameResolver.ResolutionResult.Builder.setAttributes
(Attributes attributes) Sets the attributes for the addresses resolved by name resolution.void
ClientStreamTracer.streamCreated
(Attributes transportAttrs, Metadata headers) The stream is being created on a ready transport.ClientTransportFilter.transportReady
(Attributes transportAttrs) Called when a transport is ready to accept traffic (when a connection has been established).ServerTransportFilter.transportReady
(Attributes transportAttrs) Called when a transport is ready to process streams.void
ClientTransportFilter.transportTerminated
(Attributes transportAttrs) Called when a transport completed shutting down.void
ServerTransportFilter.transportTerminated
(Attributes transportAttrs) Called when a transport is terminated.Constructors in io.grpc with parameters of type AttributesModifierConstructorDescriptionprivate
Builder
(Attributes base) private
CreateSubchannelArgs
(List<EquivalentAddressGroup> addrs, Attributes attrs, Object[][] customOptions) EquivalentAddressGroup
(SocketAddress addr, Attributes attrs) Singleton constructor with Attributes.EquivalentAddressGroup
(List<SocketAddress> addrs, Attributes attrs) List constructor withAttributes
.(package private)
ResolutionResult
(StatusOr<List<EquivalentAddressGroup>> addressesOrError, Attributes attributes, NameResolver.ConfigOrError serviceConfig) private
ResolvedAddresses
(List<EquivalentAddressGroup> addresses, Attributes attributes, Object loadBalancingPolicyConfig) -
Uses of Attributes in io.grpc.grpclb
Fields in io.grpc.grpclb declared as AttributesModifier and TypeFieldDescriptionprivate static final Attributes
GrpclbState.LB_PROVIDED_BACKEND_ATTRS
Methods in io.grpc.grpclb that return AttributesMethods in io.grpc.grpclb with parameters of type AttributesModifier and TypeMethodDescriptionCachedSubchannelPool.takeOrCreateSubchannel
(EquivalentAddressGroup eag, Attributes defaultAttributes) SubchannelPool.takeOrCreateSubchannel
(EquivalentAddressGroup eag, Attributes defaultAttributes) Takes aLoadBalancer.Subchannel
from the pool for the giveneag
if there is one available. -
Uses of Attributes in io.grpc.inprocess
Fields in io.grpc.inprocess declared as AttributesModifier and TypeFieldDescriptionprivate Attributes
InProcessTransport.attributes
private Attributes
InProcessTransport.serverStreamAttributes
Methods in io.grpc.inprocess that return AttributesModifier and TypeMethodDescriptionInProcessTransport.getAttributes()
InProcessTransport.InProcessStream.InProcessClientStream.getAttributes()
InProcessTransport.InProcessStream.InProcessServerStream.getAttributes()
Constructors in io.grpc.inprocess with parameters of type AttributesModifierConstructorDescriptionInProcessTransport
(SocketAddress address, int maxInboundMetadataSize, String authority, String userAgent, Attributes eagAttrs, boolean includeCauseWithStatus, long assumedMessageSize) -
Uses of Attributes in io.grpc.internal
Fields in io.grpc.internal declared as AttributesModifier and TypeFieldDescriptionDnsNameResolver.InternalResolutionResult.attributes
private final Attributes
ServerCallInfoImpl.attributes
private Attributes
ServerImpl.ServerTransportListenerImpl.attributes
private Attributes
InternalSubchannel.connectedAddressAttributes
private Attributes
ClientTransportFactory.ClientTransportOptions.eagAttributes
Fields in io.grpc.internal with type parameters of type AttributesModifier and TypeFieldDescriptionstatic final Attributes.Key
<Attributes> GrpcAttributes.ATTR_CLIENT_EAG_ATTRS
Attribute key for the attributes of theEquivalentAddressGroup
(EquivalentAddressGroup.getAttributes()
) that the transport's server address is from.Methods in io.grpc.internal that return AttributesModifier and TypeMethodDescriptionInternalSubchannel.TransportListener.filterTransport
(Attributes attributes) ManagedChannelImpl.DelayedTransportListener.filterTransport
(Attributes attributes) default Attributes
ManagedClientTransport.Listener.filterTransport
(Attributes attributes) Called just beforeManagedClientTransport.Listener.transportReady()
to allow direct modification of transport Attributes.AbstractServerStream.getAttributes()
ClientCallImpl.getAttributes()
ClientStream.getAttributes()
Attributes that the stream holds at the current moment.ConnectionClientTransport.getAttributes()
Returns a set of attributes, which may vary depending on the state of the transport.final Attributes
DelayedClientCall.getAttributes()
DelayedStream.getAttributes()
ForwardingClientStream.getAttributes()
ForwardingConnectionClientTransport.getAttributes()
ManagedChannelImpl.SubchannelImpl.getAttributes()
NoopClientStream.getAttributes()
final Attributes
RetriableStream.getAttributes()
ServerCallImpl.getAttributes()
ServerCallInfoImpl.getAttributes()
ServerStream.getAttributes()
Attributes describing stream.InternalSubchannel.getConnectedAddressAttributes()
Return attributes for server address connected by sub channel.ManagedChannelImpl.SubchannelImpl.getConnectedAddressAttributes()
InternalSubchannel.Index.getCurrentEagAttributes()
PickFirstLeafLoadBalancer.Index.getCurrentEagAttributes()
ClientTransportFactory.ClientTransportOptions.getEagAttributes()
ServerImpl.ServerTransportListenerImpl.transportReady
(Attributes attributes) ServerTransportListener.transportReady
(Attributes attributes) The transport has finished all handshakes and is ready to process streams.Methods in io.grpc.internal with parameters of type AttributesModifier and TypeMethodDescriptionPickFirstLeafLoadBalancer.createNewSubchannel
(SocketAddress addr, Attributes attrs) InternalSubchannel.TransportListener.filterTransport
(Attributes attributes) ManagedChannelImpl.DelayedTransportListener.filterTransport
(Attributes attributes) default Attributes
ManagedClientTransport.Listener.filterTransport
(Attributes attributes) Called just beforeManagedClientTransport.Listener.transportReady()
to allow direct modification of transport Attributes.static StatsTraceContext
StatsTraceContext.newClientContext
(ClientStreamTracer[] tracers, Attributes transportAtts, Metadata headers) Factory method for the client-side.ClientTransportFactory.ClientTransportOptions.setEagAttributes
(Attributes eagAttributes) Sets the non-null EquivalentAddressGroup's attributes.void
ForwardingClientStreamTracer.streamCreated
(Attributes transportAttrs, Metadata headers) ServerImpl.ServerTransportListenerImpl.transportReady
(Attributes attributes) ServerTransportListener.transportReady
(Attributes attributes) The transport has finished all handshakes and is ready to process streams.Constructors in io.grpc.internal with parameters of type AttributesModifierConstructorDescription(package private)
ServerCallInfoImpl
(MethodDescriptor<ReqT, RespT> methodDescriptor, Attributes attributes, String authority) -
Uses of Attributes in io.grpc.netty
Fields in io.grpc.netty declared as AttributesModifier and TypeFieldDescriptionprivate Attributes
NettyClientHandler.attributes
private Attributes
NettyServerHandler.attributes
Completed attributes produced by transportReady.private final Attributes
NettyServerStream.attributes
private final Attributes
ProtocolNegotiationEvent.attributes
private final Attributes
NettyClientHandler.eagAttributes
private final Attributes
NettyClientTransport.eagAttributes
private final Attributes
NettyServer.eagAttributes
private Attributes
NettyServerBuilder.eagAttributes
private final Attributes
NettyServerHandler.eagAttributes
private final Attributes
NettyServerTransport.eagAttributes
private Attributes
NettyServerHandler.negotiationAttributes
Incomplete attributes produced by negotiator.Methods in io.grpc.netty that return AttributesModifier and TypeMethodDescriptionClientTransportLifecycleManager.filterAttributes
(Attributes attributes) static Attributes
InternalProtocolNegotiationEvent.getAttributes
(ProtocolNegotiationEvent event) (package private) Attributes
NettyClientHandler.getAttributes()
The protocol negotiation attributes, available once the protocol negotiation completes; otherwise returnsAttributes.EMPTY
.NettyClientStream.getAttributes()
NettyClientTransport.getAttributes()
NettyServerStream.getAttributes()
(package private) Attributes
ProtocolNegotiationEvent.getAttributes()
GrpcHttp2ConnectionHandler.getEagAttributes()
Get the attributes of the EquivalentAddressGroup used to create this transport.NettyClientHandler.getEagAttributes()
NettyServerHandler.getEagAttributes()
Methods in io.grpc.netty with parameters of type AttributesModifier and TypeMethodDescriptionNettyChannelBuilder.LocalSocketPicker.createSocketAddress
(SocketAddress remoteAddress, Attributes attrs) Called by gRPC to pick local socket to bind to.static void
InternalNettyServerBuilder.eagAttributes
(NettyServerBuilder builder, Attributes eagAttributes) Sets the EAG attributes available to protocol negotiators.(package private) void
NettyServerBuilder.eagAttributes
(Attributes eagAttributes) Sets the EAG attributes available to protocol negotiators.ClientTransportLifecycleManager.filterAttributes
(Attributes attributes) void
GrpcHttp2ConnectionHandler.handleProtocolNegotiationCompleted
(Attributes attrs) Deprecated.Use the two argument method instead.void
GrpcHttp2ConnectionHandler.handleProtocolNegotiationCompleted
(Attributes attrs, InternalChannelz.Security securityInfo) Triggered on protocol negotiation completion.void
NettyClientHandler.handleProtocolNegotiationCompleted
(Attributes attributes, InternalChannelz.Security securityInfo) void
NettyServerHandler.handleProtocolNegotiationCompleted
(Attributes attrs, InternalChannelz.Security securityInfo) (package private) static NettyClientHandler
NettyClientHandler.newHandler
(ClientTransportLifecycleManager lifecycleManager, KeepAliveManager keepAliveManager, boolean autoFlowControl, int flowControlWindow, int maxHeaderListSize, com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchFactory, Runnable tooManyPingsRunnable, TransportTracer transportTracer, Attributes eagAttributes, String authority, ChannelLogger negotiationLogger, com.google.common.base.Ticker ticker) (package private) static NettyClientHandler
NettyClientHandler.newHandler
(io.netty.handler.codec.http2.Http2Connection connection, io.netty.handler.codec.http2.Http2FrameReader frameReader, io.netty.handler.codec.http2.Http2FrameWriter frameWriter, ClientTransportLifecycleManager lifecycleManager, KeepAliveManager keepAliveManager, boolean autoFlowControl, int flowControlWindow, int maxHeaderListSize, com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchFactory, Runnable tooManyPingsRunnable, TransportTracer transportTracer, Attributes eagAttributes, String authority, ChannelLogger negotiationLogger, com.google.common.base.Ticker ticker) (package private) static NettyServerHandler
NettyServerHandler.newHandler
(ServerTransportListener transportListener, io.netty.channel.ChannelPromise channelUnused, List<? extends ServerStreamTracer.Factory> streamTracerFactories, TransportTracer transportTracer, int maxStreams, boolean autoFlowControl, int flowControlWindow, int maxHeaderListSize, int maxMessageSize, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, long maxConnectionIdleInNanos, long maxConnectionAgeInNanos, long maxConnectionAgeGraceInNanos, boolean permitKeepAliveWithoutCalls, long permitKeepAliveTimeInNanos, int maxRstCount, long maxRstPeriodNanos, Attributes eagAttributes) (package private) static NettyServerHandler
NettyServerHandler.newHandler
(io.netty.channel.ChannelPromise channelUnused, io.netty.handler.codec.http2.Http2FrameReader frameReader, io.netty.handler.codec.http2.Http2FrameWriter frameWriter, ServerTransportListener transportListener, List<? extends ServerStreamTracer.Factory> streamTracerFactories, TransportTracer transportTracer, int maxStreams, boolean autoFlowControl, int flowControlWindow, int maxHeaderListSize, int maxMessageSize, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, long maxConnectionIdleInNanos, long maxConnectionAgeInNanos, long maxConnectionAgeGraceInNanos, boolean permitKeepAliveWithoutCalls, long permitKeepAliveTimeInNanos, int maxRstCount, long maxRstPeriodNanos, Attributes eagAttributes, com.google.common.base.Ticker ticker) static ProtocolNegotiationEvent
InternalProtocolNegotiationEvent.withAttributes
(ProtocolNegotiationEvent event, Attributes attributes) (package private) ProtocolNegotiationEvent
ProtocolNegotiationEvent.withAttributes
(Attributes attributes) Constructors in io.grpc.netty with parameters of type AttributesModifierConstructorDescriptionprivate
NettyClientHandler
(io.netty.handler.codec.http2.Http2ConnectionDecoder decoder, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder, io.netty.handler.codec.http2.Http2Settings settings, ChannelLogger negotiationLogger, ClientTransportLifecycleManager lifecycleManager, KeepAliveManager keepAliveManager, com.google.common.base.Supplier<com.google.common.base.Stopwatch> stopwatchFactory, Runnable tooManyPingsRunnable, TransportTracer transportTracer, Attributes eagAttributes, String authority, boolean autoFlowControl, AbstractNettyHandler.PingLimiter pingLimiter, com.google.common.base.Ticker ticker) (package private)
NettyClientTransport
(SocketAddress address, io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory, Map<io.netty.channel.ChannelOption<?>, ?> channelOptions, io.netty.channel.EventLoopGroup group, ProtocolNegotiator negotiator, boolean autoFlowControl, int flowControlWindow, int maxMessageSize, int maxHeaderListSize, long keepAliveTimeNanos, long keepAliveTimeoutNanos, boolean keepAliveWithoutCalls, String authority, String userAgent, Runnable tooManyPingsRunnable, TransportTracer transportTracer, Attributes eagAttributes, NettyChannelBuilder.LocalSocketPicker localSocketPicker, ChannelLogger channelLogger, boolean useGetForSafeMethods, com.google.common.base.Ticker ticker) (package private)
NettyServer
(List<? extends SocketAddress> addresses, io.netty.channel.ChannelFactory<? extends io.netty.channel.ServerChannel> channelFactory, Map<io.netty.channel.ChannelOption<?>, ?> channelOptions, Map<io.netty.channel.ChannelOption<?>, ?> childChannelOptions, ObjectPool<? extends io.netty.channel.EventLoopGroup> bossGroupPool, ObjectPool<? extends io.netty.channel.EventLoopGroup> workerGroupPool, boolean forceHeapBuffer, ProtocolNegotiator protocolNegotiator, List<? extends ServerStreamTracer.Factory> streamTracerFactories, TransportTracer.Factory transportTracerFactory, int maxStreamsPerConnection, boolean autoFlowControl, int flowControlWindow, int maxMessageSize, int maxHeaderListSize, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, long maxConnectionIdleInNanos, long maxConnectionAgeInNanos, long maxConnectionAgeGraceInNanos, boolean permitKeepAliveWithoutCalls, long permitKeepAliveTimeInNanos, int maxRstCount, long maxRstPeriodNanos, Attributes eagAttributes, InternalChannelz channelz) private
NettyServerHandler
(io.netty.channel.ChannelPromise channelUnused, io.netty.handler.codec.http2.Http2Connection connection, ServerTransportListener transportListener, List<? extends ServerStreamTracer.Factory> streamTracerFactories, TransportTracer transportTracer, io.netty.handler.codec.http2.Http2ConnectionDecoder decoder, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder, io.netty.handler.codec.http2.Http2Settings settings, int maxMessageSize, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, long maxConnectionIdleInNanos, long maxConnectionAgeInNanos, long maxConnectionAgeGraceInNanos, KeepAliveEnforcer keepAliveEnforcer, boolean autoFlowControl, int maxRstCount, long maxRstPeriodNanos, Attributes eagAttributes, com.google.common.base.Ticker ticker) NettyServerStream
(io.netty.channel.Channel channel, NettyServerStream.TransportState state, Attributes transportAttrs, String authority, StatsTraceContext statsTraceCtx) (package private)
NettyServerTransport
(io.netty.channel.Channel channel, io.netty.channel.ChannelPromise channelUnused, ProtocolNegotiator protocolNegotiator, List<? extends ServerStreamTracer.Factory> streamTracerFactories, TransportTracer transportTracer, int maxStreams, boolean autoFlowControl, int flowControlWindow, int maxMessageSize, int maxHeaderListSize, long keepAliveTimeInNanos, long keepAliveTimeoutInNanos, long maxConnectionIdleInNanos, long maxConnectionAgeInNanos, long maxConnectionAgeGraceInNanos, boolean permitKeepAliveWithoutCalls, long permitKeepAliveTimeInNanos, int maxRstCount, long maxRstPeriodNanos, Attributes eagAttributes) private
ProtocolNegotiationEvent
(Attributes attributes, InternalChannelz.Security security) -
Uses of Attributes in io.grpc.protobuf.services
Methods in io.grpc.protobuf.services with parameters of type AttributesModifier and TypeMethodDescription(package private) static SocketAddress
BinlogHelper.getPeerSocket
(Attributes streamAttributes) -
Uses of Attributes in io.grpc.rls
Fields in io.grpc.rls declared as AttributesModifier and TypeFieldDescriptionprivate final Attributes
ChildLbResolvedAddressFactory.attributes
Constructors in io.grpc.rls with parameters of type AttributesModifierConstructorDescription(package private)
ChildLbResolvedAddressFactory
(List<EquivalentAddressGroup> addresses, Attributes attributes) -
Uses of Attributes in io.grpc.servlet
Fields in io.grpc.servlet declared as AttributesModifier and TypeFieldDescriptionprivate final Attributes
ServletAdapter.attributes
private final Attributes
ServletServerStream.attributes
Methods in io.grpc.servlet that return AttributesConstructors in io.grpc.servlet with parameters of type AttributesModifierConstructorDescription(package private)
ServletServerStream
(javax.servlet.AsyncContext asyncCtx, StatsTraceContext statsTraceCtx, int maxInboundMessageSize, Attributes attributes, String authority, InternalLogId logId) -
Uses of Attributes in io.grpc.servlet.jakarta
Fields in io.grpc.servlet.jakarta declared as AttributesModifier and TypeFieldDescriptionprivate final Attributes
ServletAdapter.attributes
private final Attributes
ServletServerStream.attributes
Methods in io.grpc.servlet.jakarta that return AttributesConstructors in io.grpc.servlet.jakarta with parameters of type AttributesModifierConstructorDescription(package private)
ServletServerStream
(jakarta.servlet.AsyncContext asyncCtx, StatsTraceContext statsTraceCtx, int maxInboundMessageSize, Attributes attributes, String authority, InternalLogId logId) -
Uses of Attributes in io.grpc.util
Methods in io.grpc.util that return AttributesModifier and TypeMethodDescriptionForwardingSubchannel.getAttributes()
HealthProducerHelper.HealthProducerSubchannel.getAttributes()
OutlierDetectionLoadBalancer.OutlierDetectionSubchannel.getAttributes()
TransmitStatusRuntimeExceptionInterceptor.SerializingServerCall.getAttributes()
ForwardingSubchannel.getConnectedAddressAttributes()
Methods in io.grpc.util with parameters of type AttributesModifier and TypeMethodDescriptionvoid
ForwardingClientStreamTracer.streamCreated
(Attributes transportAttrs, Metadata headers)
toBuilder()
on theAttributes
instance instead.