diff options
Diffstat (limited to 'content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/persistence/SnapShot.html')
| -rw-r--r-- | content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/persistence/SnapShot.html | 343 |
1 files changed, 343 insertions, 0 deletions
diff --git a/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/persistence/SnapShot.html b/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/persistence/SnapShot.html new file mode 100644 index 000000000..5903d68c0 --- /dev/null +++ b/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/persistence/SnapShot.html @@ -0,0 +1,343 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_352) on Wed Jan 25 17:31:44 CET 2023 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SnapShot (Apache ZooKeeper - Server 3.8.1 API)</title> +<meta name="date" content="2023-01-25"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SnapShot (Apache ZooKeeper - Server 3.8.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SnapShot.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/zookeeper/server/persistence/FileTxnSnapLog.SnapDirContentCheckException.html" title="class in org.apache.zookeeper.server.persistence"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/zookeeper/server/persistence/SnapshotInfo.html" title="class in org.apache.zookeeper.server.persistence"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/persistence/SnapShot.html" target="_top">Frames</a></li> +<li><a href="SnapShot.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.zookeeper.server.persistence</div> +<h2 title="Interface SnapShot" class="title">Interface SnapShot</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/zookeeper/server/persistence/FileSnap.html" title="class in org.apache.zookeeper.server.persistence">FileSnap</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">SnapShot</span></pre> +<div class="block">snapshot interface for the persistence layer. + implement this interface for implementing + snapshots.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/persistence/SnapShot.html#close--">close</a></span>()</code> +<div class="block">free resources from this snapshot immediately</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/persistence/SnapShot.html#deserialize-org.apache.zookeeper.server.DataTree-java.util.Map-">deserialize</a></span>(<a href="../../../../../org/apache/zookeeper/server/DataTree.html" title="class in org.apache.zookeeper.server">DataTree</a> dt, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> sessions)</code> +<div class="block">deserialize a data tree from the last valid snapshot and + return the last zxid that was deserialized</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/persistence/SnapShot.html#findMostRecentSnapshot--">findMostRecentSnapshot</a></span>()</code> +<div class="block">find the most recent snapshot file</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/zookeeper/server/persistence/SnapshotInfo.html" title="class in org.apache.zookeeper.server.persistence">SnapshotInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/persistence/SnapShot.html#getLastSnapshotInfo--">getLastSnapshotInfo</a></span>()</code> +<div class="block">get information of the last saved/restored snapshot</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/persistence/SnapShot.html#serialize-org.apache.zookeeper.server.DataTree-java.util.Map-java.io.File-boolean-">serialize</a></span>(<a href="../../../../../org/apache/zookeeper/server/DataTree.html" title="class in org.apache.zookeeper.server">DataTree</a> dt, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> sessions, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> name, + boolean fsync)</code> +<div class="block">persist the datatree and the sessions into a persistence storage</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="deserialize-org.apache.zookeeper.server.DataTree-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deserialize</h4> +<pre>long deserialize(<a href="../../../../../org/apache/zookeeper/server/DataTree.html" title="class in org.apache.zookeeper.server">DataTree</a> dt, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> sessions) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">deserialize a data tree from the last valid snapshot and + return the last zxid that was deserialized</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dt</code> - the datatree to be deserialized into</dd> +<dd><code>sessions</code> - the sessions to be deserialized into</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the last zxid that was deserialized from the snapshot</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="serialize-org.apache.zookeeper.server.DataTree-java.util.Map-java.io.File-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serialize</h4> +<pre>void serialize(<a href="../../../../../org/apache/zookeeper/server/DataTree.html" title="class in org.apache.zookeeper.server">DataTree</a> dt, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> sessions, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> name, + boolean fsync) + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">persist the datatree and the sessions into a persistence storage</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dt</code> - the datatree to be serialized</dd> +<dd><code>sessions</code> - the session timeouts to be serialized</dd> +<dd><code>name</code> - the object name to store snapshot into</dd> +<dd><code>fsync</code> - sync the snapshot immediately after write</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="findMostRecentSnapshot--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findMostRecentSnapshot</h4> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> findMostRecentSnapshot() + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">find the most recent snapshot file</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the most recent snapshot file</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="getLastSnapshotInfo--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastSnapshotInfo</h4> +<pre><a href="../../../../../org/apache/zookeeper/server/persistence/SnapshotInfo.html" title="class in org.apache.zookeeper.server.persistence">SnapshotInfo</a> getLastSnapshotInfo()</pre> +<div class="block">get information of the last saved/restored snapshot</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>info of last snapshot</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close() + throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">free resources from this snapshot immediately</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SnapShot.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/zookeeper/server/persistence/FileTxnSnapLog.SnapDirContentCheckException.html" title="class in org.apache.zookeeper.server.persistence"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/zookeeper/server/persistence/SnapshotInfo.html" title="class in org.apache.zookeeper.server.persistence"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/persistence/SnapShot.html" target="_top">Frames</a></li> +<li><a href="SnapShot.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2008–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |