com.azure.storage.blob.ProgressReporter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-storage-blob Show documentation
Show all versions of azure-storage-blob Show documentation
This module contains client library for Microsoft Azure Blob Storage.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.storage.blob;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.nio.ByteBuffer;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.locks.Lock;
/**
* {@code ProgressReporter} offers a convenient way to add progress tracking to a given Flux.
* @deprecated Use {@link com.azure.core.util.ProgressReporter}
*/
@Deprecated
public final class ProgressReporter {
private abstract static class ProgressReporterImpl implements ProgressReceiver {
long blockProgress;
final ProgressReceiver progressReceiver;
ProgressReporterImpl(ProgressReceiver progressReceiver) {
this.blockProgress = 0;
this.progressReceiver = progressReceiver;
}
@Override
public void reportProgress(long bytesTransferred) {
this.blockProgress += bytesTransferred;
}
void rewindProgress() {
this.blockProgress = 0;
}
Flux addProgressReporting(Flux data) {
return Mono.just(this).flatMapMany(progressReporter -> {
/*
Each time there is a new subscription, we will rewind the progress. This is desirable specifically
for retries, which resubscribe on each try. The first time this flowable is subscribed to, the
rewind will be a noop as there will have been no progress made. Subsequent rewinds will work as
expected.
*/
progressReporter.rewindProgress();
/*
Every time we emit some data, report it to the Tracker, which will pass it on to the end user.
*/
return data.doOnNext(buffer -> progressReporter.reportProgress(buffer.remaining()));
});
}
}
/**
* This type is used to keep track of the total amount of data transferred for a single request. This is the type we
* will use when the customer uses the factory to add progress reporting to their Flowable. We need this additional
* type because we can't keep local state directly as lambdas require captured local variables to be effectively
* final.
*/
private static class SequentialProgressReporter extends ProgressReporterImpl {
SequentialProgressReporter(ProgressReceiver progressReceiver) {
super(progressReceiver);
}
@Override
public void reportProgress(long bytesTransferred) {
super.reportProgress(bytesTransferred);
this.progressReceiver.reportProgress(this.blockProgress);
}
}
/**
* This type is used to keep track of the total amount of data transferred as a part of a parallel upload in order
* to coordinate progress reporting to the end user. We need this additional type because we can't keep local state
* directly as lambdas require captured local variables to be effectively final.
*/
private static class ParallelProgressReporter extends ProgressReporterImpl {
/*
This lock will be instantiated by the operation initiating the whole transfer to coordinate each
ProgressReporterImpl.
*/
private final Lock transferLock;
/*
We need an AtomicLong to be able to update the value referenced. Because we are already synchronizing with the
lock, we don't incur any additional performance hit here by the synchronization.
*/
private final AtomicLong totalProgress;
ParallelProgressReporter(ProgressReceiver progressReceiver, Lock lock, AtomicLong totalProgress) {
super(progressReceiver);
this.transferLock = lock;
this.totalProgress = totalProgress;
}
@Override
public void reportProgress(long bytesTransferred) {
super.reportProgress(bytesTransferred);
/*
It is typically a bad idea to lock around customer code (which the progressReceiver is) because they could
never release the lock. However, we have decided that it is sufficiently difficult for them to make their
progressReporting code threadsafe that we will take that burden and the ensuing risks. Although it is the
case that only one thread is allowed to be in onNext at once, however there are multiple independent
requests happening at once to stage/download separate chunks, so we still need to lock either way.
*/
transferLock.lock();
this.progressReceiver.reportProgress(this.totalProgress.addAndGet(bytesTransferred));
transferLock.unlock();
}
/*
This is used in the case of retries to rewind the amount of progress reported so as not to over-report at the
end.
*/
@Override
public void rewindProgress() {
/*
Blocks do not interfere with each other's block progress and there is no way that, for a single block, one
thread will be trying to add to the progress while the other is trying to zero it. The updates are strictly
sequential. Avoiding using the lock is ideal.
*/
this.totalProgress.addAndGet(-1 * this.blockProgress);
super.rewindProgress();
}
}
/**
* Adds progress reporting functionality to the given {@code Flux}. Each subscription (and therefore each retry)
* will rewind the progress reported so as not to over-report. The data reported will be the total amount of data
* emitted so far, or the "current position" of the Flux.
*
* @param data The data whose transfer progress is to be tracked.
* @param progressReceiver {@link ProgressReceiver}
* @return A {@code Flux} that emits the same data as the source but calls a callback to report the total amount of
* data emitted so far.
* @deprecated Use {@link com.azure.core.util.ProgressReporter} instead.
*/
@Deprecated
public static Flux addProgressReporting(Flux data, ProgressReceiver progressReceiver) {
if (progressReceiver == null) {
return data;
} else {
ProgressReporterImpl tracker = new SequentialProgressReporter(progressReceiver);
return tracker.addProgressReporting(data);
}
}
/**
* Adds parallel progress reporting functionality to the given {@code Flux}. Each subscription (and therefore each
* retry) will rewind the progress reported so as not to over-report. The data reported will be the total amount
* of data emitted so far, or the "current position" of the Flux in parallel.
*
* @param data The data whose transfer progress is to be tracked.
* @param progressReceiver {@link ProgressReceiver}
* @param lock This lock will be instantiated by the operation initiating the whole transfer to coordinate each
* ProgressReporterImpl.
* @param totalProgress We need an AtomicLong to be able to update the value referenced. Because we are already
* synchronizing with the lock, we don't incur any additional performance hit here by the synchronization.
* @return A {@code Flux} that emits the same data as the source but calls a callback to report the total amount of
* data emitted so far.
* @deprecated Use {@link com.azure.core.util.ProgressReporter} instead.
*/
@Deprecated
public static Flux addParallelProgressReporting(Flux data,
ProgressReceiver progressReceiver, Lock lock, AtomicLong totalProgress) {
if (progressReceiver == null) {
return data;
} else {
ParallelProgressReporter tracker = new ParallelProgressReporter(progressReceiver, lock, totalProgress);
return tracker.addProgressReporting(data);
}
}
}