com.azure.storage.blob.ProgressReceiver 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

This module contains client library for Microsoft Azure Blob Storage.

There is a newer version: 12.29.0

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.storage.blob;

import com.azure.core.util.ProgressListener;
import com.azure.storage.blob.models.ParallelTransferOptions;

import reactor.core.publisher.Flux;

/**
 * A {@code ProgressReceiver} is an object that can be used to report progress on network transfers. When specified on
 * transfer operations, the {@code reportProgress} method will be called periodically with the total number of bytes
 * transferred. The user may configure this method to report progress in whatever format desired. It is recommended
 * that this type be used in conjunction with {@link ProgressReporter#addProgressReporting(Flux, ProgressReceiver)} to
 * enable reporting on sequential transfers. Note that any method accepting a {@link ParallelTransferOptions} will use
 * the {@code ProgressReceiver} specified there and will handle the logic to coordinate the reporting between parallel
 * operations.
 * @deprecated Use {@link ProgressListener}.
 */
@Deprecated
public interface ProgressReceiver extends ProgressListener {

    /**
     * The callback function invoked as progress is reported.
     *
     * @param bytesTransferred The total number of bytes transferred during this transaction.
     */
    void reportProgress(long bytesTransferred);

    @Override
    default void handleProgress(long bytesTransferred) {
        reportProgress(bytesTransferred);
    }
}