@Beta public enum TopicOverloadPolicy extends Enum<TopicOverloadPolicy>
HazelcastInstance.getReliableTopic(String)
.
The reliable topic uses a Ringbuffer
to store the messages. A ringbuffer doesn't track where
readers are, so therefore it has no concept of a slow consumers. This provides many advantages like high performance reads, but
it also gives the ability to the reader to reread the same message multiple times in case of error.
Because a ringbuffer has a capacity and to prevent that a fast producer overwrites the messages needed by a slow consumer, a
time to live time can be set on the ringbuffer. See RingbufferConfig.setTimeToLiveSeconds(int)
.
This TopicOverloadPolicy
controls how the publisher is going to deal with the situation that a ringbuffer is full
and the oldest item in the ringbuffer is not old enough to get overwritten.
So keep in mind that a this retention period keep the messages in memory, even though it might by that all readers already
have completed reading.Enum Constant and Description |
---|
BLOCK
The caller will wait till there space in the ringbuffer.
|
DISCARD_NEWEST
The message that was to be published, is discarded.
|
DISCARD_OLDEST
Using this policy, a message that has not expired can be overwritten.
|
ERROR
The publish call immediately fails.
|
Modifier and Type | Method and Description |
---|---|
static TopicOverloadPolicy |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static TopicOverloadPolicy[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final TopicOverloadPolicy DISCARD_OLDEST
public static final TopicOverloadPolicy DISCARD_NEWEST
public static final TopicOverloadPolicy BLOCK
public static final TopicOverloadPolicy ERROR
public static TopicOverloadPolicy[] values()
for (TopicOverloadPolicy c : TopicOverloadPolicy.values()) System.out.println(c);
public static TopicOverloadPolicy valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2016 Hazelcast, Inc.. All Rights Reserved.