io.servicetalk.grpc.api

Interface GrpcServiceContext

All Superinterfaces:

AsyncCloseable, ConnectionContext, ConnectionInfo, GrpcMetadata, ListenableAsyncCloseable

public interface GrpcServiceContext
extends ConnectionContext, GrpcMetadata

A gRPC service context.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GrpcServiceContext.GrpcProtocol

Nested classes/interfaces inherited from interface ConnectionInfo

ConnectionInfo.Protocol

Method Summary

Modifier and Type	Method and Description
GrpcExecutionContext	executionContext()
GrpcServiceContext.GrpcProtocol	protocol()
default ContextMap	responseContext() A response context associated with this GrpcMetadata that translates into HttpMetaData.context().
List<ContentCodec>	supportedMessageCodings() Deprecated. Will be removed along with ContentCodec.

Methods inherited from interface ConnectionContext

parent

Methods inherited from interface ConnectionInfo

localAddress, remoteAddress, socketOption, sslConfig, sslSession

Methods inherited from interface ListenableAsyncCloseable

onClose, onClosing

Methods inherited from interface AsyncCloseable

closeAsync, closeAsyncGracefully

Methods inherited from interface GrpcMetadata

path, requestContext

Method Detail

executionContext

GrpcExecutionContext executionContext()

Specified by:

executionContext in interface ConnectionInfo

protocol

GrpcServiceContext.GrpcProtocol protocol()

Specified by:

protocol in interface ConnectionInfo

supportedMessageCodings

@Deprecated
List<ContentCodec> supportedMessageCodings()

Deprecated. Will be removed along with ContentCodec.

The ContentCodec codings available for this gRPC call.

Returns:

the ContentCodec codings available for this gRPC call.

responseContext

default ContextMap responseContext()

A response context associated with this GrpcMetadata that translates into HttpMetaData.context().

Context can be used to associate a state with a response without serializing its state on the wire or transmit a state between HTTP and gRPC layers.

Notes:

1. For asynchronous endpoints that operate with a Publisher either for reading or writing data back, only modifications to the responseContext() made before the endpoint method returns are visible for HTTP headers. Any other modifications made from inside the asynchronous chain of operators or from inside the Publisher.defer(Supplier) operator will be visible only for HTTP trailers.
2. For synchronous endpoints that operate with BlockingStreamingGrpcServerResponse, only modifications to the responseContext() made before invocation of BlockingStreamingGrpcServerResponse.sendMetaData() method are visible for HTTP headers. Any other modifications made later (while operating with GrpcPayloadWriter) will be visible only for HTTP trailers.

Specified by:

responseContext in interface GrpcMetadata

Returns:

a response context associated with this GrpcMetadata that translates into HttpMetaData.context().