com.gemstone.gemfire.cache.DiskWriteAttributes Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.gemstone.gemfire.cache;

/**
 * Immutable parameter object for describing how {@linkplain
 * Region.Entry region entries} should be written to disk.
 *
 * @see DiskWriteAttributesFactory
 * @see AttributesFactory#setDiskWriteAttributes
 * @see RegionAttributes#getDiskWriteAttributes
 * @see Region#writeToDisk
 *
 * @author David Whitlock
 * @author Mitul Bid
 *
 * @since 3.2
 * @deprecated as of 6.5 use {@link DiskStore} instead
 */
@Deprecated
public interface DiskWriteAttributes
  extends java.io.Serializable {



  //////////////////////  Instance Methods  //////////////////////

 

  /**
   * Returns true if this DiskWriteAttributes object
   * configures synchronous writes.
   * 
   * @return Returns true if writes to disk are synchronous and false otherwise
   * @deprecated as of 6.5 use {@link RegionAttributes#isDiskSynchronous} instead.
   */
  @Deprecated
  public boolean isSynchronous();
  
  
  /** 
   * Returns true if the oplogs is to be rolled to a more condensed format (on disk)
   * 
   * @return Returns true if the oplogs is to be rolled or false otherwise
   */
  public boolean isRollOplogs();

  /** 
   * Get the maximum size in megabytes a single oplog (operation log) file should be 
   * 
   * @return the maximum size the operations log file can be
   * @deprecated as of 6.5 use {@link DiskStore#getMaxOplogSize()} 
   * instead.
   */
  @Deprecated
  public int getMaxOplogSize();

  /**
   * 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.
   * 
   * @return Returns the time interval in milliseconds that can elapse between two writes to disk
   * @deprecated as of 6.5 use {@link DiskStore#getTimeInterval()} 
   * instead.
   */
  @Deprecated
  public long getTimeInterval();

  /**
   * 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.
   * 
   * @return Returns the number of bytes that can be buffered before being written to disk
   * @deprecated as of 6.5 use {@link DiskStore#getQueueSize()} 
   * instead.
   */
  @Deprecated
  public long getBytesThreshold();

  /**
   * 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
   * compaction values
   * 
   * @return true if o is equal else false
   */
  public boolean equals(Object o);

}