cpp_client_telemetry/lib/include/public/IBandwidthController.hpp

//
// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
#ifndef IBANDWIDTHCONTROLLER_HPP
#define IBANDWIDTHCONTROLLER_HPP

#include "ctmacros.hpp"

namespace MAT_NS_BEGIN
{
    class IBandwidthController {
    public:
        virtual ~IBandwidthController() {}

        /// <summary>
        /// Query the current proposed bandwidth for uploading telemetry events.
        ///
        /// This method is called each time the SDK is preparing to send some
        /// events in an HTTP request.
        ///
        /// The library might not be able to actually honor the return value more
        /// than just not transmitting anything if the proposed bandwidth is 0 and
        /// resuming the upload when it isn't.
        /// </summary>
        /// <returns>Proposed bandwidth in bytes per second</returns>
        virtual unsigned GetProposedBandwidthBps() = 0;
    };
} MAT_NS_END

#endif