org.apache.pulsar.broker.service.persistent

Class DispatchRateLimiter

java.lang.Object

org.apache.pulsar.broker.service.persistent.DispatchRateLimiter

public class DispatchRateLimiter
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DispatchRateLimiter.Type

Constructor Summary

Constructors

Constructor and Description
DispatchRateLimiter(PersistentTopic topic, DispatchRateLimiter.Type type)

Method Summary

Modifier and Type	Method and Description
void	close()
long	getAvailableDispatchRateLimitOnMsg() returns available msg-permit if msg-dispatch-throttling is enabled else it returns -1
long	getDispatchRateOnByte() Get configured byte dispatch-throttling rate.
long	getDispatchRateOnMsg() Get configured msg dispatch-throttling rate.
static Optional<org.apache.pulsar.common.policies.data.Policies>	getPolicies(BrokerService brokerService, String topicName)
org.apache.pulsar.common.policies.data.DispatchRate	getPoliciesDispatchRate(BrokerService brokerService) Gets configured dispatch-rate from namespace policies.
static org.apache.pulsar.common.policies.data.DispatchRate	getPoliciesDispatchRate(String cluster, Optional<org.apache.pulsar.common.policies.data.Policies> policies, DispatchRateLimiter.Type type)
static Optional<org.apache.pulsar.common.policies.data.DispatchRate>	getTopicPolicyDispatchRate(BrokerService brokerService, String topicName, DispatchRateLimiter.Type type)
boolean	hasMessageDispatchPermit() checks if dispatch-rate limit is configured and if it's configured then check if permits are available or not.
boolean	isDispatchRateLimitingEnabled() Checks if dispatch-rate limiting is enabled.
static boolean	isDispatchRateNeeded(BrokerService brokerService, Optional<org.apache.pulsar.common.policies.data.Policies> policies, String topicName, DispatchRateLimiter.Type type)
static boolean	isDispatchRateNeeded(ServiceConfiguration serviceConfig, Optional<org.apache.pulsar.common.policies.data.Policies> policies, String topicName, DispatchRateLimiter.Type type)
void	onPoliciesUpdate(org.apache.pulsar.common.policies.data.Policies data)
boolean	tryDispatchPermit(long msgPermits, long bytePermits) It acquires msg and bytes permits from rate-limiter and returns if acquired permits succeed.
void	updateDispatchRate() Update dispatch-throttling-rate.
void	updateDispatchRate(org.apache.pulsar.common.policies.data.DispatchRate dispatchRate) Update dispatch rate by updating msg and byte rate-limiter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DispatchRateLimiter

public DispatchRateLimiter(PersistentTopic topic,
                           DispatchRateLimiter.Type type)

Method Detail

getAvailableDispatchRateLimitOnMsg

public long getAvailableDispatchRateLimitOnMsg()

returns available msg-permit if msg-dispatch-throttling is enabled else it returns -1

Returns:

tryDispatchPermit

public boolean tryDispatchPermit(long msgPermits,
                                 long bytePermits)

It acquires msg and bytes permits from rate-limiter and returns if acquired permits succeed.

Parameters:

msgPermits -

bytePermits -

Returns:

hasMessageDispatchPermit

public boolean hasMessageDispatchPermit()

checks if dispatch-rate limit is configured and if it's configured then check if permits are available or not.

Returns:

isDispatchRateLimitingEnabled

public boolean isDispatchRateLimitingEnabled()

Checks if dispatch-rate limiting is enabled.

Returns:

updateDispatchRate

public void updateDispatchRate()

Update dispatch-throttling-rate. gives first priority to namespace-policy configured dispatch rate else applies default broker dispatch-throttling-rate

isDispatchRateNeeded

public static boolean isDispatchRateNeeded(BrokerService brokerService,
                                           Optional<org.apache.pulsar.common.policies.data.Policies> policies,
                                           String topicName,
                                           DispatchRateLimiter.Type type)

getTopicPolicyDispatchRate

public static Optional<org.apache.pulsar.common.policies.data.DispatchRate> getTopicPolicyDispatchRate(BrokerService brokerService,
                                                                                                       String topicName,
                                                                                                       DispatchRateLimiter.Type type)

isDispatchRateNeeded

public static boolean isDispatchRateNeeded(ServiceConfiguration serviceConfig,
                                           Optional<org.apache.pulsar.common.policies.data.Policies> policies,
                                           String topicName,
                                           DispatchRateLimiter.Type type)

onPoliciesUpdate

public void onPoliciesUpdate(org.apache.pulsar.common.policies.data.Policies data)

getPoliciesDispatchRate

public static org.apache.pulsar.common.policies.data.DispatchRate getPoliciesDispatchRate(String cluster,
                                                                                          Optional<org.apache.pulsar.common.policies.data.Policies> policies,
                                                                                          DispatchRateLimiter.Type type)

getPoliciesDispatchRate

public org.apache.pulsar.common.policies.data.DispatchRate getPoliciesDispatchRate(BrokerService brokerService)

Gets configured dispatch-rate from namespace policies. Returns null if dispatch-rate is not configured

Returns:

getPolicies

public static Optional<org.apache.pulsar.common.policies.data.Policies> getPolicies(BrokerService brokerService,
                                                                                    String topicName)

updateDispatchRate

public void updateDispatchRate(org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)

Update dispatch rate by updating msg and byte rate-limiter. If dispatch-rate is configured < 0 then it closes the rate-limiter and disables appropriate rate-limiter.

Parameters:

dispatchRate -

getDispatchRateOnMsg

public long getDispatchRateOnMsg()

Get configured msg dispatch-throttling rate. Returns -1 if not configured

Returns:

getDispatchRateOnByte

public long getDispatchRateOnByte()

Get configured byte dispatch-throttling rate. Returns -1 if not configured

Returns:

close

public void close()