Package 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	Description
static interface	GrpcServiceContext.GrpcProtocol

Nested classes/interfaces inherited from interface io.servicetalk.transport.api.ConnectionInfo

ConnectionInfo.Protocol

Method Summary

Modifier and Type	Method	Description
GrpcExecutionContext	executionContext()	Get the ExecutionContext for this ConnectionInfo.
GrpcServiceContext.GrpcProtocol	protocol()	Get the ConnectionInfo.Protocol for this ConnectionInfo.
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 io.servicetalk.concurrent.api.AsyncCloseable

closeAsync, closeAsyncGracefully

Methods inherited from interface io.servicetalk.transport.api.ConnectionContext

parent

Methods inherited from interface io.servicetalk.transport.api.ConnectionInfo

localAddress, remoteAddress, socketOption, sslConfig, sslSession

Methods inherited from interface io.servicetalk.grpc.api.GrpcMetadata

path, requestContext

Methods inherited from interface io.servicetalk.concurrent.api.ListenableAsyncCloseable

onClose, onClosing

Method Details

executionContext

GrpcExecutionContext executionContext()

Description copied from interface: ConnectionInfo

Get the ExecutionContext for this ConnectionInfo.

The ExecutionContext.ioExecutor() will represent the thread responsible for IO for this ConnectionInfo. Note that this maybe different that what was used to create this object because at this time a specific IoExecutor has been selected.

Specified by:

executionContext in interface ConnectionInfo

Returns:

the ExecutionContext for this ConnectionInfo.

protocol

GrpcServiceContext.GrpcProtocol protocol()

Description copied from interface: ConnectionInfo

Get the ConnectionInfo.Protocol for this ConnectionInfo.

Specified by:

protocol in interface ConnectionInfo

Returns:

the ConnectionInfo.Protocol for this 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().