com.hazelcast.internal.config

Class RingbufferConfigReadOnly

java.lang.Object

com.hazelcast.config.RingbufferConfig

com.hazelcast.internal.config.RingbufferConfigReadOnly

All Implemented Interfaces:

NamedConfig, DataSerializable, IdentifiedDataSerializable, SplitBrainMergeTypeProvider

public class RingbufferConfigReadOnly
extends RingbufferConfig

Field Summary

Fields inherited from class com.hazelcast.config.RingbufferConfig

DEFAULT_ASYNC_BACKUP_COUNT, DEFAULT_CAPACITY, DEFAULT_IN_MEMORY_FORMAT, DEFAULT_SYNC_BACKUP_COUNT, DEFAULT_TTL_SECONDS

Constructor Summary

Constructors

Constructor and Description
RingbufferConfigReadOnly(RingbufferConfig config)

Method Summary

Modifier and Type	Method and Description
RingbufferStoreConfig	getRingbufferStoreConfig() Get the RingbufferStore (load and store ringbuffer items from/to a database) configuration.
RingbufferConfig	setAsyncBackupCount(int asyncBackupCount) Sets the number of asynchronous backups.
RingbufferConfig	setBackupCount(int backupCount) Sets the number of synchronous backups.
RingbufferConfig	setCapacity(int capacity) Sets the capacity of the ringbuffer.
RingbufferConfig	setInMemoryFormat(InMemoryFormat inMemoryFormat) Sets the in-memory format.
RingbufferConfig	setMergePolicyConfig(MergePolicyConfig mergePolicyConfig) Sets the MergePolicyConfig for this ringbuffer.
RingbufferConfig	setRingbufferStoreConfig(RingbufferStoreConfig ringbufferStoreConfig) Set the RingbufferStore (load and store ringbuffer items from/to a database) configuration.
RingbufferConfig	setSplitBrainProtectionName(String splitBrainProtectionName) Sets the split brain protection name for operations.
RingbufferConfig	setTimeToLiveSeconds(int timeToLiveSeconds) Sets the time to live in seconds which is the maximum number of seconds for each item to stay in the ringbuffer before being removed.

Methods inherited from class com.hazelcast.config.RingbufferConfig

equals, getAsyncBackupCount, getBackupCount, getCapacity, getClassId, getFactoryId, getInMemoryFormat, getMergePolicyConfig, getName, getProvidedMergeTypes, getSplitBrainProtectionName, getTimeToLiveSeconds, getTotalBackupCount, hashCode, readData, setName, toString, writeData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RingbufferConfigReadOnly

public RingbufferConfigReadOnly(RingbufferConfig config)

Method Detail

getRingbufferStoreConfig

public RingbufferStoreConfig getRingbufferStoreConfig()

Description copied from class: RingbufferConfig

Get the RingbufferStore (load and store ringbuffer items from/to a database) configuration.

Overrides:

getRingbufferStoreConfig in class RingbufferConfig

Returns:

the ringbuffer store configuration

setCapacity

public RingbufferConfig setCapacity(int capacity)

Description copied from class: RingbufferConfig

Sets the capacity of the ringbuffer.

Overrides:

setCapacity in class RingbufferConfig

Parameters:

capacity - the capacity

Returns:

the updated Config

See Also:

RingbufferConfig.getCapacity()

setAsyncBackupCount

public RingbufferConfig setAsyncBackupCount(int asyncBackupCount)

Description copied from class: RingbufferConfig

Sets the number of asynchronous backups. 0 means no backups.

Overrides:

setAsyncBackupCount in class RingbufferConfig

Parameters:

asyncBackupCount - the number of asynchronous synchronous backups to set

Returns:

the updated SemaphoreConfig

See Also:

RingbufferConfig.setBackupCount(int), RingbufferConfig.getAsyncBackupCount()

setBackupCount

public RingbufferConfig setBackupCount(int backupCount)

Description copied from class: RingbufferConfig

Sets the number of synchronous backups.

Overrides:

setBackupCount in class RingbufferConfig

Parameters:

backupCount - the number of synchronous backups to set

Returns:

the updated SemaphoreConfig

See Also:

RingbufferConfig.setAsyncBackupCount(int), RingbufferConfig.getBackupCount()

setTimeToLiveSeconds

public RingbufferConfig setTimeToLiveSeconds(int timeToLiveSeconds)

Description copied from class: RingbufferConfig

Sets the time to live in seconds which is the maximum number of seconds for each item to stay in the ringbuffer before being removed.

Entries that are older than timeToLiveSeconds are removed from the ringbuffer on the next ringbuffer operation (read or write).

Time to live can be disabled by setting timeToLiveSeconds to 0. It means that items won't get removed because they expire. They may only be overwritten. When timeToLiveSeconds is disabled and after the tail does a full loop in the ring, the ringbuffer size will always be equal to the capacity.

The timeToLiveSeconds can be any integer between 0 and Integer.MAX_VALUE. 0 means infinite. The default is 0.

Overrides:

setTimeToLiveSeconds in class RingbufferConfig

Parameters:

timeToLiveSeconds - the time to live period in seconds

Returns:

the updated RingbufferConfig

setInMemoryFormat

public RingbufferConfig setInMemoryFormat(InMemoryFormat inMemoryFormat)

Description copied from class: RingbufferConfig

Sets the in-memory format.

The in-memory format controls the format of the stored item in the ringbuffer:

1. InMemoryFormat.OBJECT: the item is stored in deserialized format (a regular object)
2. InMemoryFormat.BINARY: the item is stored in serialized format (a binary blob)

The default is binary. The object InMemoryFormat is useful when:

1. the object stored in object format has a smaller footprint than in binary format
2. if there are readers using a filter. Since for every filter invocation, the object needs to be available in object format.

Overrides:

setInMemoryFormat in class RingbufferConfig

Parameters:

inMemoryFormat - the new in memory format

Returns:

the updated Config

setRingbufferStoreConfig

public RingbufferConfig setRingbufferStoreConfig(RingbufferStoreConfig ringbufferStoreConfig)

Description copied from class: RingbufferConfig

Set the RingbufferStore (load and store ringbuffer items from/to a database) configuration.

Overrides:

setRingbufferStoreConfig in class RingbufferConfig

Parameters:

ringbufferStoreConfig - set the RingbufferStore configuration to this configuration

Returns:

the ringbuffer configuration

setSplitBrainProtectionName

public RingbufferConfig setSplitBrainProtectionName(String splitBrainProtectionName)

Description copied from class: RingbufferConfig

Sets the split brain protection name for operations.

Overrides:

setSplitBrainProtectionName in class RingbufferConfig

Parameters:

splitBrainProtectionName - the split brain protection name

Returns:

the updated configuration

setMergePolicyConfig

public RingbufferConfig setMergePolicyConfig(MergePolicyConfig mergePolicyConfig)

Description copied from class: RingbufferConfig

Sets the MergePolicyConfig for this ringbuffer.

Overrides:

setMergePolicyConfig in class RingbufferConfig

Returns:

the ringbuffer configuration