org.logstash.beats.Batch 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: 4.36

package org.logstash.beats;

/** Interface representing a Batch of {@link Message}. */
public interface Batch extends Iterable {
  /**
   * Returns the protocol of the sent messages that this batch was constructed from
   *
   * @return byte - either '1' or '2'
   */
  byte getProtocol();

  /**
   * Number of messages that the batch is expected to contain.
   *
   * @return int - number of messages
   */
  int getBatchSize();

  /**
   * Set the number of messages that the batch is expected to contain.
   *
   * @param batchSize int - number of messages
   */
  void setBatchSize(int batchSize);

  /**
   * Returns the highest sequence number of the batch.
   *
   * @return
   */
  int getHighestSequence();
  /**
   * Current number of messages in the batch
   *
   * @return int
   */
  int size();

  /**
   * Is the batch currently empty?
   *
   * @return boolean
   */
  boolean isEmpty();

  /**
   * Is the batch complete?
   *
   * @return boolean
   */
  boolean isComplete();

  /**
   * Release the resources associated with the batch. Consumers of the batch *must* release after
   * use.
   */
  void release();
}