com.wavefront.agent.queueing.TaskConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of proxy Show documentation

Service for batching and relaying metric traffic to Wavefront

There is a newer version: 13.4

package com.wavefront.agent.queueing;

import java.io.IOException;
import java.io.OutputStream;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Proxy-specific interface for converting data into and from queues, this potentially allows us to
 * support other converting mechanisms in the future.
 *
 * @param  type of objects stored.
 * @author [email protected]
 */
public interface TaskConverter {

  /**
   * De-serializes an object from a byte array.
   *
   * @return de-serialized object.
   */
  T fromBytes(@Nonnull byte[] bytes) throws IOException;

  /**
   * Serializes {@code value} to bytes written to the specified stream.
   *
   * @param value value to serialize.
   * @param bytes output stream to write a {@code byte[]} to.
   */
  void serializeToStream(@Nonnull T value, @Nonnull OutputStream bytes) throws IOException;

  /**
   * Attempts to retrieve task weight from a {@code byte[]}, without de-serializing the object, if
   * at all possible.
   *
   * @return task weight or null if not applicable.
   */
  @Nullable
  Integer getWeight(@Nonnull byte[] bytes);

  /** Supported compression schemas */
  enum CompressionType {
    NONE,
    GZIP,
    LZ4
  }
}