com.gemstone.gemfire.cache
Interface DiskWriteAttributes

All Superinterfaces:

Serializable

public interface DiskWriteAttributes
extends Serializable

Immutable parameter object for describing how region entries should be written to disk.

Since:

3.2

See Also:

DiskWriteAttributesFactory, AttributesFactory.setDiskWriteAttributes(com.gemstone.gemfire.cache.DiskWriteAttributes), RegionAttributes.getDiskWriteAttributes(), Region.writeToDisk()

Method Summary

boolean	equals(Object o) Two DiskWriteAttributes are equal if the both specify the synchronous writes, or they both specify asynchronous writes with the same time interval, bytes threshold, maxOplogSize and rolling values
long	getBytesThreshold() Returns the number of unwritten bytes of data that can be enqueued before being written to disk.
int	getMaxOplogSize() Get the maximum size in megabytes a single oplog (operation log) file should be
long	getTimeInterval() Returns the number of milliseconds that can elapse before unwritten data is written to disk.
boolean	isRollOplogs() Returns true if the oplogs is to be rolled to a more condensed format (on disk)
boolean	isSynchronous() Returns true if this DiskWriteAttributes object configures synchronous writes.

Method Detail

isSynchronous

boolean isSynchronous()

Returns true if this DiskWriteAttributes object configures synchronous writes.

Returns:

Returns true if writes to disk are synchronous and false otherwise

isRollOplogs

boolean isRollOplogs()

Returns true if the oplogs is to be rolled to a more condensed format (on disk)

Returns:

Returns true if the oplogs is to be rolled or false otherwise

getMaxOplogSize

int getMaxOplogSize()

Get the maximum size in megabytes a single oplog (operation log) file should be

Returns:

the maximum size the operations log file can be

Throws:

IllegalArgumentException - if the property value is not a valid positive number

getTimeInterval

long getTimeInterval()

Returns the number of milliseconds that can elapse before unwritten data is written to disk. If this DiskWriteAttributes configures synchronous writing, then timeInterval has no meaning.

Returns:

Returns the time interval in milliseconds that can elapse between two writes to disk

Throws:

IllegalArgumentException - if the property value is not a valid positive number

getBytesThreshold

long getBytesThreshold()

Returns the number of unwritten bytes of data that can be enqueued before being written to disk. If this DiskWriteAttributes configures synchronous writing, then bytesThreshold has no meaning.

Returns:

Returns the number of bytes that can be buffered before being written to disk

Throws:

IllegalArgumentException - if the property value is not a valid positive number

equals

boolean equals(Object o)

Two DiskWriteAttributes are equal if the both specify the synchronous writes, or they both specify asynchronous writes with the same time interval, bytes threshold, maxOplogSize and rolling values

Overrides:

equals in class Object

Returns:

true if o is equal else false