Package brave.rpc

Class RpcServerRequest

java.lang.Object

brave.Request

brave.rpc.RpcRequest

brave.rpc.RpcServerRequest

public abstract class RpcServerRequest
extends RpcRequest

Marks an interface for use in RpcServerHandler.handleReceive(RpcServerRequest). This gives a standard type to consider when parsing an incoming context.

Since:

5.8

See Also:

RpcServerResponse

Constructor Summary

Constructors

Constructor	Description
RpcServerRequest()

Method Summary

Modifier and Type	Method	Description
protected String	propagationField(String keyName)	Returns one value corresponding to the specified propagation field, or null.
Span.Kind	spanKind()

Methods inherited from class brave.rpc.RpcRequest

method, parseRemoteIpAndPort, service, startTimestamp

Methods inherited from class brave.Request

toString, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

RpcServerRequest

public RpcServerRequest()

Method Detail

spanKind

public final Span.Kind spanKind()

Specified by:

spanKind in class Request

propagationField

@Nullable
protected String propagationField(String keyName)

Returns one value corresponding to the specified propagation field, or null.

Note: Header based requests will use headers, but this could be read from RPC envelopes or even binary data.

Notes

This is only used when injecting a trace context as internally implemented by RpcClientHandler. Calls during sampling or parsing are invalid and may be ignored by instrumentation.

Header based requests will use headers, but this could set RPC envelopes or even binary data.

Parameters:

keyName - key used for Propagation.Getter.get(Object, Object)

Since:

5.12

See Also:

GETTER, Propagation.keys(), BaggagePropagation.allKeyNames(Propagation)