com.swirlds.common.io.extendable.extensions.CountingStreamExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2016-2024 Hedera Hashgraph, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.swirlds.common.io.extendable.extensions;

import com.swirlds.base.units.UnitConstants;
import com.swirlds.common.io.extendable.extensions.internal.Counter;
import com.swirlds.common.io.extendable.extensions.internal.StandardCounter;
import com.swirlds.common.io.extendable.extensions.internal.ThreadSafeCounter;

/**
 * A stream extension that counts the number of bytes that pass through it
 */
public class CountingStreamExtension extends AbstractStreamExtension {

    private final Counter counter;

    /**
     * Create a new thread safe counting stream extension.
     */
    public CountingStreamExtension() {
        this(true);
    }

    /**
     * Create a counting stream extension.
     *
     * @param threadSafe if true then the extension will be thread safe, if false then it will not be thread safe (and
     *                   perhaps it will be slightly more performant)
     */
    public CountingStreamExtension(final boolean threadSafe) {
        if (threadSafe) {
            counter = new ThreadSafeCounter();
        } else {
            counter = new StandardCounter();
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void newByte(final int aByte) {
        counter.addToCount(1);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void newBytes(final byte[] bytes, final int offset, final int length) {
        counter.addToCount(length);
    }

    /**
     * Resets the number of bytes read
     */
    public void resetCount() {
        counter.resetCount();
    }

    /**
     * @return the number of bytes that have passed by this stream since the last reset
     */
    public long getCount() {
        return counter.getCount();
    }

    /**
     * Get the number of bytes, in kibibytes.
     *
     * @return the number of bytes that have passed by this stream since the last reset
     */
    public double getKibiBytes() {
        return counter.getCount() * UnitConstants.BYTES_TO_KIBIBYTES;
    }

    /**
     * Get the number of bytes, in mebibytes.
     *
     * @return the number of bytes that have passed by this stream since the last reset
     */
    public double getMebiBytes() {
        return counter.getCount() * UnitConstants.BYTES_TO_MEBIBYTES;
    }

    /**
     * Get the number of bytes, in gibibytes.
     *
     * @return the number of bytes that have passed by this stream since the last reset
     */
    public double getGibiBytes() {
        return counter.getCount() * UnitConstants.BYTES_TO_GIBIBYTES;
    }

    /**
     * Returns the number bytes read and resets the count to 0
     *
     * @return the number of bytes read since the last reset
     */
    public long getAndResetCount() {
        return counter.getAndResetCount();
    }
}