Class TagContextBinarySerializer

java.lang.Object

io.opencensus.tags.propagation.TagContextBinarySerializer

Direct Known Subclasses:

NoopTags.NoopTagContextBinarySerializer, TagContextBinarySerializerImpl

public abstract class TagContextBinarySerializer
extends Object

Object for serializing and deserializing TagContexts with the binary format.

See opencensus-specs for the specification of the cross-language binary serialization format.

Since:

0.8

Constructor Summary

Constructors

Constructor	Description
TagContextBinarySerializer()

Method Summary

Modifier and Type	Method	Description
abstract TagContext	fromByteArray(byte[] bytes)	Creates a TagContext from the given on-the-wire encoded representation.
abstract byte[]	toByteArray(TagContext tags)	Serializes the TagContext into the on-the-wire representation.

Methods inherited from class Object

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

Constructor Details

TagContextBinarySerializer

public TagContextBinarySerializer()

Method Details

toByteArray

public abstract byte[] toByteArray(TagContext tags)
                            throws TagContextSerializationException

Serializes the TagContext into the on-the-wire representation.

This method should be the inverse of fromByteArray(byte[]).

Tags that have a TagMetadata with TagMetadata.TagTtl.NO_PROPAGATION will not be serialized.

Parameters:

tags - the TagContext to serialize.

Returns:

the on-the-wire representation of a TagContext.

Throws:

TagContextSerializationException - if the result would be larger than the maximum allowed serialized size.

Since:

0.8

fromByteArray

public abstract TagContext fromByteArray(byte[] bytes)
                                  throws TagContextDeserializationException

Creates a TagContext from the given on-the-wire encoded representation.

This method should be the inverse of toByteArray(TagContext).

Parameters:

bytes - on-the-wire representation of a TagContext.

Returns:

a TagContext deserialized from bytes.

Throws:

TagContextDeserializationException - if there is a parse error, the input contains invalid tags, or the input is larger than the maximum allowed serialized size.

Since:

0.8