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, read() must be used to read data, and it is an error to call read(). When Binary is defined as outbound, write() must be used to write data, and it is an error to call write().

See Also:

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

Method Summary

Modifier and Type	Method and Description
int	read(ByteBuffer buffer) Reads a sequence of bytes into the given buffer.
int	write(ByteBuffer buffer) Writes a sequence of bytes to this channel from the given buffer.

Method Detail

write

int write(ByteBuffer buffer)
   throws IOException

Writes a sequence of bytes to this channel from the given buffer. The internal buffer is expected to grow as more data is written. The behavior of this method is expected to be the same as WritableByteChannel.write().

Parameters:

buffer - The buffer from which bytes are to be retrieved.

Returns:

The number of bytes written, possibly zero.

Throws:

IOException

read

int read(ByteBuffer buffer)
  throws IOException

Reads a sequence of bytes into the given buffer. The behavior of this method is expected to be the same as ReadableByteChannel.read().

Parameters:

buffer - The buffer into which bytes are to be transferred.

Returns:

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream.

Throws:

IOException