io.opentracing.propagation

Interface Binary

public interface Binary

Binary is an interface defining the required operations for a binary carrier for Tracer.inject() and Tracer.extract(). Binary can be defined either as inbound (extraction) or outbound (injection). When Binary is defined as inbound, extractionBuffer() will be called to retrieve the ByteBuffer containing the data used for SpanContext extraction. When Binary is defined as outbound, setInjectBufferLength() will be called in order to hint the required buffer length to inject the SpanContext, and injectionBuffer() will be called afterwards to retrieve the actual ByteBuffer used for the SpanContext injection.

See Also:

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

Method Summary

Modifier and Type	Method and Description
ByteBuffer	extractionBuffer() Gets the buffer containing the data used for SpanContext extraction.
ByteBuffer	injectionBuffer(int lenght) Gets the buffer used to store data as part of SpanContext injection.

Method Detail

injectionBuffer

ByteBuffer injectionBuffer(int lenght)

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.

extractionBuffer

ByteBuffer extractionBuffer()

Gets the buffer containing the data used for SpanContext extraction. It is an error to call this method when Binary is used for SpanContext injection.

Returns:

The buffer used for SpanContext extraction.