org.apache.pulsar.common.policies.data.DispatchRate Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.pulsar.common.policies.data;
import org.apache.pulsar.common.policies.data.impl.DispatchRateImpl;
/**
* Dispatch rate.
*/
public interface DispatchRate {
int getDispatchThrottlingRateInMsg();
long getDispatchThrottlingRateInByte();
boolean isRelativeToPublishRate(); /* throttles dispatch relatively publish-rate */
int getRatePeriodInSecond(); /* by default dispatch-rate will be calculate per 1 second */
interface Builder {
Builder dispatchThrottlingRateInMsg(int dispatchThrottlingRateMsg);
Builder dispatchThrottlingRateInByte(long dispatchThrottlingRateBytes);
Builder relativeToPublishRate(boolean relativeToPublishRate);
Builder ratePeriodInSecond(int ratePeriodInSeconds);
DispatchRate build();
}
static Builder builder() {
return DispatchRateImpl.builder();
}
}