com.io7m.cardant.client.api.CAClientTransferStatistics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.io7m.cardant.client.api Show documentation

Inventory system (Client API)

The newest version!

/*
 * Copyright © 2023 Mark Raynsford  https://www.io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */


package com.io7m.cardant.client.api;

/**
 * A snapshot of a transfer.
 *
 * @param sizeExpected    The expected size
 * @param sizeTransferred The amount transferred so far
 * @param octetsPerSecond The average octets per second
 */

public record CAClientTransferStatistics(
  long sizeExpected,
  long sizeTransferred,
  double octetsPerSecond)
{
  /**
   * @return The completion "percentage" in the range {@code [0, 1]}
   */

  public double percentNormalized()
  {
    return (double) this.sizeTransferred / (double) this.sizeExpected;
  }

  /**
   * @return The completion percentage in the range {@code [0, 100]}
   */

  public double percent()
  {
    return this.percentNormalized() * 100.0;
  }
}