Package org.apache.pulsar.broker.service

Class PublishRateLimiterImpl

java.lang.Object

org.apache.pulsar.broker.service.PublishRateLimiterImpl

All Implemented Interfaces:

AutoCloseable, PublishRateLimiter

public class PublishRateLimiterImpl
extends Object
implements PublishRateLimiter

Field Summary

Fields

Modifier and Type	Field	Description
protected LongAdder	currentPublishByteCount
protected LongAdder	currentPublishMsgCount
protected long	publishMaxByteRate
protected int	publishMaxMessageRate
protected boolean	publishRateExceeded
protected boolean	publishThrottlingEnabled

Fields inherited from interface org.apache.pulsar.broker.service.PublishRateLimiter

DISABLED_RATE_LIMITER

Constructor Summary

Constructors

Constructor	Description
PublishRateLimiterImpl(org.apache.pulsar.common.policies.data.Policies policies, String clusterName)
PublishRateLimiterImpl(org.apache.pulsar.common.policies.data.PublishRate maxPublishRate)

Method Summary

Modifier and Type	Method	Description
void	checkPublishRate()	checks and update state of current publish and marks if it has exceeded the rate-limiting threshold.
void	close()	Close the limiter.
void	incrementPublishCount(int numOfMessages, long msgSizeInBytes)	increments current publish count.
boolean	isPublishRateExceeded()	returns true if current publish has reached the rate-limiting threshold.
boolean	resetPublishCount()	reset current publish count.
boolean	tryAcquire(int numbers, long bytes)	try to acquire permit.
void	update(org.apache.pulsar.common.policies.data.Policies policies, String clusterName)	updates rate-limiting threshold based on policies.
void	update(org.apache.pulsar.common.policies.data.PublishRate maxPublishRate)	updates rate-limiting threshold based on passed in rate limiter.

Methods inherited from class java.lang.Object

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

Field Details

publishMaxMessageRate

protected volatile int publishMaxMessageRate

publishMaxByteRate

protected volatile long publishMaxByteRate

publishThrottlingEnabled

protected volatile boolean publishThrottlingEnabled

publishRateExceeded

protected volatile boolean publishRateExceeded

currentPublishMsgCount

protected volatile LongAdder currentPublishMsgCount

currentPublishByteCount

protected volatile LongAdder currentPublishByteCount

Constructor Details

PublishRateLimiterImpl

public PublishRateLimiterImpl(org.apache.pulsar.common.policies.data.Policies policies,
 String clusterName)

PublishRateLimiterImpl

public PublishRateLimiterImpl(org.apache.pulsar.common.policies.data.PublishRate maxPublishRate)

Method Details

checkPublishRate

public void checkPublishRate()

Description copied from interface: PublishRateLimiter

checks and update state of current publish and marks if it has exceeded the rate-limiting threshold.

Specified by:

checkPublishRate in interface PublishRateLimiter

incrementPublishCount

public void incrementPublishCount(int numOfMessages,
 long msgSizeInBytes)

Description copied from interface: PublishRateLimiter

increments current publish count.

Specified by:

incrementPublishCount in interface PublishRateLimiter

resetPublishCount

public boolean resetPublishCount()

Description copied from interface: PublishRateLimiter

reset current publish count.

Specified by:

resetPublishCount in interface PublishRateLimiter

Returns:

isPublishRateExceeded

public boolean isPublishRateExceeded()

Description copied from interface: PublishRateLimiter

returns true if current publish has reached the rate-limiting threshold.

Specified by:

isPublishRateExceeded in interface PublishRateLimiter

Returns:

update

public void update(org.apache.pulsar.common.policies.data.Policies policies,
 String clusterName)

Description copied from interface: PublishRateLimiter

updates rate-limiting threshold based on policies.

Specified by:

update in interface PublishRateLimiter

update

public void update(org.apache.pulsar.common.policies.data.PublishRate maxPublishRate)

Description copied from interface: PublishRateLimiter

updates rate-limiting threshold based on passed in rate limiter.

Specified by:

update in interface PublishRateLimiter

tryAcquire

public boolean tryAcquire(int numbers,
 long bytes)

Description copied from interface: PublishRateLimiter

try to acquire permit.

Specified by:

tryAcquire in interface PublishRateLimiter

close

public void close()

Description copied from interface: PublishRateLimiter

Close the limiter.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface PublishRateLimiter