From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../repo/sleepycat/CheckpointCapability.html | 291 +++++++++++++++++++++ 1 file changed, 291 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html (limited to 'apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html') diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html new file mode 100644 index 0000000..9d9eaf1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html @@ -0,0 +1,291 @@ + + + + + + +CheckpointCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.repo.sleepycat
+

Interface CheckpointCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface CheckpointCapability
+extends Capability
    +
    Capability to control BDB checkpointing.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    HotBackupCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidforceCheckpoint() +
      Forces a checkpoint to run now, even if checkpointer is suspended or + disabled.
      +
      voidresumeCheckpointer() +
      Resumes the checkpointer if it was suspended.
      +
      voidsuspendCheckpointer(long suspensionTime) +
      Suspend the checkpointer until the suspension time has expired or until + manually resumed.
      +
      voidsync() +
      Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        suspendCheckpointer

        +
        void suspendCheckpointer(long suspensionTime)
        +
        Suspend the checkpointer until the suspension time has expired or until + manually resumed. If a checkpoint is in progress, this method will block + until it is finished. If checkpointing is disabled, calling this method + has no effect. + +

        Calling this method repeatedly resets the suspension time. Each + invocation of suspendCheckpointer is like a lease renewal or heartbeat.

        +
        Parameters:
        suspensionTime - minimum length of suspension, in milliseconds, + unless checkpointer is manually resumed
        +
        • +
      + + + +
        +
      • +

        resumeCheckpointer

        +
        void resumeCheckpointer()
        +
        Resumes the checkpointer if it was suspended. If checkpointing is + disabled or if not suspended, calling this method has no effect.
        +
        • +
      + + + +
        +
      • +

        forceCheckpoint

        +
        void forceCheckpoint()
+                     throws PersistException
        +
        Forces a checkpoint to run now, even if checkpointer is suspended or + disabled. If a checkpoint is in progress, then this method will block + until it is finished, and then run another checkpoint. This method does + not return until the requested checkpoint has finished.
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + +
        +
      • +

        sync

        +
        void sync()
+          throws PersistException
        +
        Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.
        +
        Throws:
        +
        PersistException
        Since:
        +
        1.2.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3