Package zipkin2.reporter

Class BytesMessageSender.Base

java.lang.Object

zipkin2.reporter.BytesMessageSender.Base

All Implemented Interfaces:

Closeable, BytesMessageSender

Direct Known Subclasses:

BaseHttpSender

Enclosing interface:

BytesMessageSender

public abstract static class BytesMessageSender.Base
extends Object
implements BytesMessageSender

Base class for implementation, which implements messageSizeInBytes(List) and messageSizeInBytes(List) with a given Encoding

Nested Class Summary

Nested classes/interfaces inherited from interface zipkin2.reporter.BytesMessageSender

BytesMessageSender.Base

Field Summary

Fields

Modifier and Type	Field	Description
protected Encoding	encoding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Base(Encoding encoding)

Method Summary

Modifier and Type	Method	Description
Encoding	encoding()	Returns the encoding this sender requires spans to have.
int	messageSizeInBytes(int encodedSizeInBytes)	Like BytesMessageSender.messageSizeInBytes(List), except for a single-span.
int	messageSizeInBytes(List<byte[]> encodedSpans)	Before invoking BytesMessageSender.send(List), callers must consider message overhead, which might be more than encoding overhead.

Methods inherited from class java.lang.Object

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

Methods inherited from interface zipkin2.reporter.BytesMessageSender

messageMaxBytes, send

Methods inherited from interface java.io.Closeable

close

Field Detail

encoding

protected final Encoding encoding

Constructor Detail

Base

protected Base(Encoding encoding)

Method Detail

encoding

public Encoding encoding()

Returns the encoding this sender requires spans to have.

Specified by:

encoding in interface BytesMessageSender

messageSizeInBytes

public int messageSizeInBytes(List<byte[]> encodedSpans)

Before invoking BytesMessageSender.send(List), callers must consider message overhead, which might be more than encoding overhead. This is used to not exceed BytesMessageSender.messageMaxBytes().

Note this is not always Encoding.listSizeInBytes(List), as some senders have inefficient list encoding. For example, Scribe base64's then tags each span with a category.

Specified by:

messageSizeInBytes in interface BytesMessageSender

messageSizeInBytes

public int messageSizeInBytes(int encodedSizeInBytes)

Like BytesMessageSender.messageSizeInBytes(List), except for a single-span. This is used to ensure a span is never accepted that can never be sent.

Note this is not always Encoding.listSizeInBytes(int), as some senders have inefficient list encoding. For example, Stackdriver's proto message contains other fields.

Specified by:

messageSizeInBytes in interface BytesMessageSender

Parameters:

encodedSizeInBytes - the encoded size of a span