io.opentracing.propagation

Interface BinaryInject

All Known Subinterfaces:

Binary

public interface BinaryInject

BinaryInject is an interface defining the required operations for a binary carrier for Tracer.inject(io.opentracing.SpanContext, io.opentracing.propagation.Format<C>, C) only. BinaryInject is defined as outbound (injection). When called with Tracer.inject(io.opentracing.SpanContext, io.opentracing.propagation.Format<C>, C), injectionBuffer(int) will be called to retrieve the actual ByteBuffer used for the SpanContext injection.

See Also:

Format.Builtin.BINARY, Tracer.inject(SpanContext, Format, Object)

Method Summary

Modifier and Type	Method and Description
ByteBuffer	injectionBuffer(int length) Gets the buffer used to store data as part of SpanContext injection.

Method Detail

injectionBuffer

ByteBuffer injectionBuffer(int length)

Gets the buffer used to store data as part of SpanContext injection. The lenght parameter hints the buffer length required for SpanContext injection. The user may use this to allocate a new ByteBuffer or resize an existing one. It is an error to call this method when Binary is used for SpanContext extraction.

Parameters:

length - The buffer length required for SpanContext injection. It needs to be larger than zero.

Returns:

The buffer used for SpanContext injection.