http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/ef7245e8/content/docs/latest/api/java/org/apache/distributedlog/LocalDLMEmulator.html ---------------------------------------------------------------------- diff --git a/content/docs/latest/api/java/org/apache/distributedlog/LocalDLMEmulator.html b/content/docs/latest/api/java/org/apache/distributedlog/LocalDLMEmulator.html new file mode 100644 index 0000000..1693022 --- /dev/null +++ b/content/docs/latest/api/java/org/apache/distributedlog/LocalDLMEmulator.html @@ -0,0 +1,571 @@ +<!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_121) on Wed Apr 26 11:46:58 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LocalDLMEmulator (Apache DistributedLog for Java, version latest)</title> +<meta name="date" content="2017-04-26"> +<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="LocalDLMEmulator (Apache DistributedLog for Java, version latest)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":10,"i7":10,"i8":9,"i9":10,"i10":9,"i11":9,"i12":9,"i13":10,"i14":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/LocalDLMEmulator.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/distributedlog/Entry.Writer.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LocalDLMEmulator.Builder.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LocalDLMEmulator.html" target="_top">Frames</a></li> +<li><a href="LocalDLMEmulator.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><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </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.distributedlog</div> +<h2 title="Class LocalDLMEmulator" class="title">Class LocalDLMEmulator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.distributedlog.LocalDLMEmulator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">LocalDLMEmulator</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Utility class for setting up bookkeeper ensembles + and bringing individual bookies up and down</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.Builder.html" title="class in org.apache.distributedlog">LocalDLMEmulator.Builder</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#DLOG_NAMESPACE">DLOG_NAMESPACE</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#checkBookiesUp-int-int-">checkBookiesUp</a></span>(int count, + int timeout)</code> +<div class="block">Check that a number of bookies are available</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static org.apache.zookeeper.ZooKeeper</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#connectZooKeeper-java.lang.String-int-">connectZooKeeper</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> zkHost, + int zkPort)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static org.apache.zookeeper.ZooKeeper</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#connectZooKeeper-java.lang.String-int-int-">connectZooKeeper</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> zkHost, + int zkPort, + int zkTimeoutSec)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#createDLMURI-java.lang.String-">createDLMURI</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#createDLMURI-java.lang.String-java.lang.String-">createDLMURI</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> zkServers, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#getBkLedgerPath--">getBkLedgerPath</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#getUri--">getUri</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#getZkServers--">getZkServers</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#main-java.lang.String:A-">main</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] args)</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>org.apache.bookkeeper.proto.BookieServer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#newBookie--">newBookie</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/distributedlog/LocalDLMEmulator.Builder.html" title="class in org.apache.distributedlog">LocalDLMEmulator.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#newBuilder--">newBuilder</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static org.apache.commons.lang3.tuple.Pair<org.apache.bookkeeper.shims.zk.ZooKeeperServerShim,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#runZookeeperOnAnyPort-java.io.File-">runZookeeperOnAnyPort</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> zkDir)</code> +<div class="block">Try to start zookkeeper locally on any port.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>static org.apache.commons.lang3.tuple.Pair<org.apache.bookkeeper.shims.zk.ZooKeeperServerShim,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#runZookeeperOnAnyPort-int-java.io.File-">runZookeeperOnAnyPort</a></span>(int basePort, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> zkDir)</code> +<div class="block">Try to start zookkeeper locally on any port beginning with some base port.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#start--">start</a></span>()</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LocalDLMEmulator.html#teardown--">teardown</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DLOG_NAMESPACE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DLOG_NAMESPACE</h4> +<pre>public static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> DLOG_NAMESPACE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.distributedlog.LocalDLMEmulator.DLOG_NAMESPACE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="newBuilder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newBuilder</h4> +<pre>public static <a href="../../../org/apache/distributedlog/LocalDLMEmulator.Builder.html" title="class in org.apache.distributedlog">LocalDLMEmulator.Builder</a> newBuilder()</pre> +</li> +</ul> +<a name="start--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public void start() + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="teardown--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>teardown</h4> +<pre>public void teardown() + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="getZkServers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getZkServers</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getZkServers()</pre> +</li> +</ul> +<a name="getUri--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUri</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> getUri()</pre> +</li> +</ul> +<a name="newBookie--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newBookie</h4> +<pre>public org.apache.bookkeeper.proto.BookieServer newBookie() + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="checkBookiesUp-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkBookiesUp</h4> +<pre>public int checkBookiesUp(int count, + int timeout) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Check that a number of bookies are available</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>count</code> - number of bookies required</dd> +<dd><code>timeout</code> - number of seconds to wait for bookies to start</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if bookies are not started by the time the timeout hits</dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="getBkLedgerPath--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBkLedgerPath</h4> +<pre>public static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getBkLedgerPath()</pre> +</li> +</ul> +<a name="connectZooKeeper-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>connectZooKeeper</h4> +<pre>public static org.apache.zookeeper.ZooKeeper connectZooKeeper(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> zkHost, + int zkPort) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, + org.apache.zookeeper.KeeperException, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +<dd><code>org.apache.zookeeper.KeeperException</code></dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code></dd> +</dl> +</li> +</ul> +<a name="connectZooKeeper-java.lang.String-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>connectZooKeeper</h4> +<pre>public static org.apache.zookeeper.ZooKeeper connectZooKeeper(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> zkHost, + int zkPort, + int zkTimeoutSec) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, + org.apache.zookeeper.KeeperException, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +<dd><code>org.apache.zookeeper.KeeperException</code></dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code></dd> +</dl> +</li> +</ul> +<a name="createDLMURI-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDLMURI</h4> +<pre>public static <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> createDLMURI(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="createDLMURI-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDLMURI</h4> +<pre>public static <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> createDLMURI(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> zkServers, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> path) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="runZookeeperOnAnyPort-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>runZookeeperOnAnyPort</h4> +<pre>public static org.apache.commons.lang3.tuple.Pair<org.apache.bookkeeper.shims.zk.ZooKeeperServerShim,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>> runZookeeperOnAnyPort(<a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> zkDir) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Try to start zookkeeper locally on any port.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="runZookeeperOnAnyPort-int-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>runZookeeperOnAnyPort</h4> +<pre>public static org.apache.commons.lang3.tuple.Pair<org.apache.bookkeeper.shims.zk.ZooKeeperServerShim,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a>> runZookeeperOnAnyPort(int basePort, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> zkDir) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Try to start zookkeeper locally on any port beginning with some base port. + Dump some socket info when bind fails.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="main-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>[] args) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</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/LocalDLMEmulator.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/distributedlog/Entry.Writer.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LocalDLMEmulator.Builder.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LocalDLMEmulator.html" target="_top">Frames</a></li> +<li><a href="LocalDLMEmulator.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><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </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 © 2016-2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/ef7245e8/content/docs/latest/api/java/org/apache/distributedlog/LogReader.html ---------------------------------------------------------------------- diff --git a/content/docs/latest/api/java/org/apache/distributedlog/LogReader.html b/content/docs/latest/api/java/org/apache/distributedlog/LogReader.html new file mode 100644 index 0000000..f78b33c --- /dev/null +++ b/content/docs/latest/api/java/org/apache/distributedlog/LogReader.html @@ -0,0 +1,447 @@ +<!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_121) on Wed Apr 26 11:46:58 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LogReader (Apache DistributedLog for Java, version latest)</title> +<meta name="date" content="2017-04-26"> +<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="LogReader (Apache DistributedLog for Java, version latest)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":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/LogReader.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/distributedlog/LocalDLMEmulator.Builder.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LogReader.html" target="_top">Frames</a></li> +<li><a href="LogReader.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.distributedlog</div> +<h2 title="Interface LogReader" class="title">Interface LogReader</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io">AsyncCloseable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">LogReader</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>, <a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io">AsyncCloseable</a></pre> +<div class="block"><i>LogReader</i> is a `synchronous` reader reading records from a DL log. + + <h3>Lifecycle of a Reader</h3> + + A reader is a <i>sequential</i> reader that read records from a DL log starting + from a given position. The position could be a <i>DLSN</i> (via <a href="../../../org/apache/distributedlog/DistributedLogManager.html#getInputStream-org.apache.distributedlog.DLSN-"><code>DistributedLogManager.getInputStream(DLSN)</code></a> + or a <i>Transaction ID</i> (via <a href="../../../org/apache/distributedlog/DistributedLogManager.html#getInputStream-long-"><code>DistributedLogManager.getInputStream(long)</code></a>. + <p> + After the reader is open, it could call <a href="../../../org/apache/distributedlog/LogReader.html#readNext-boolean-"><code>readNext(boolean)</code></a> or <a href="../../../org/apache/distributedlog/LogReader.html#readBulk-boolean-int-"><code>readBulk(boolean, int)</code></a> + to read records out the log from provided position. + <p> + Closing the reader (via <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close--"; title="class or interface in java.io"><code>Closeable.close()</code></a> will release all the resources occupied + by this reader instance. + <p> + Exceptions could be thrown during reading records. Once the exception is thrown, + the reader is set to an error state and it isn't usable anymore. It is the application's + responsibility to handle the exceptions and re-create readers if necessary. + <p> + Example: + <pre> + DistributedLogManager dlm = ...; + long nextTxId = ...; + LogReader reader = dlm.getInputStream(nextTxId); + + while (true) { // keep reading & processing records + LogRecord record; + try { + record = reader.readNext(false); + nextTxId = record.getTransactionId(); + // process the record + ... + } catch (IOException ioe) { + // handle the exception + ... + reader = dlm.getInputStream(nextTxId + 1); + } + } + + </pre> + + <h3>Read Records</h3> + + Reading records from an <i>endless</i> log in `synchronous` way isn't as + trivial as in `asynchronous` way (via <a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog"><code>AsyncLogReader</code></a>. Because it + lacks of callback mechanism. LogReader introduces a flag `nonBlocking` on + controlling the <i>waiting</i> behavior on `synchronous` reads. + + <h4>Blocking vs NonBlocking</h4> + + <i>Blocking</i> (nonBlocking = false) means the reads will wait for records + before returning read calls. While <i>NonBlocking</i> (nonBlocking = true) + means the reads will only check readahead cache and return whatever records + available in the readahead cache. + <p> + The <i>waiting</i> period varies in <i>blocking</i> mode. If the reader is + catching up with writer (there are records in the log), the read call will + wait until records are read and returned. If the reader is caught up with + writer (there are no more records in the log at read time), the read call + will wait for a small period of time (defined in + <a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html#getReadAheadWaitTime--"><code>DistributedLogConfiguration.getReadAheadWaitTime()</code></a> and return whatever + records available in the readahead cache. In other words, if a reader sees + no record on blocking reads, it means the reader is `caught-up` with the + writer. + <p> + <i>Blocking</i> and <i>NonBlocking</i> modes are useful for building replicated + state machines. Applications could use <i>blocking</i> reads till caught up + with latest data. Once they are caught up with latest data, they could start + serving their service and turn to <i>non-blocking</i> read mode and tail read + data from the logs. + <p> + See examples below. + + <h4>Read Single Record</h4> + + <a href="../../../org/apache/distributedlog/LogReader.html#readNext-boolean-"><code>readNext(boolean)</code></a> is reading individual records from a DL log. + + <pre> + LogReader reader = ... + + // keep reading records in blocking way until no records available in the log + LogRecord record = reader.readNext(false); + while (null != record) { + // process the record + ... + // read next record + records = reader.readNext(false); + } + + ... + + // reader is caught up with writer, doing non-blocking reads to tail the log + while (true) { + record = reader.readNext(true) + // process the new records + ... + } + </pre> + + <h4>Read Batch of Records</h4> + + <a href="../../../org/apache/distributedlog/LogReader.html#readBulk-boolean-int-"><code>readBulk(boolean, int)</code></a> is a convenient way to read a batch of records + from a DL log. + + <pre> + LogReader reader = ... + int N = 10; + + // keep reading N records in blocking way until no records available in the log + List<LogRecord> records = reader.readBulk(false, N); + while (!records.isEmpty()) { + // process the list of records + ... + if (records.size() < N) { // no more records available in the log + break; + } + // read next N records + records = reader.readBulk(false, N); + } + + ... + + // reader is caught up with writer, doing non-blocking reads to tail the log + while (true) { + records = reader.readBulk(true, N) + // process the new records + ... + } + + </pre> + + <p> + NOTE: Extending <a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io"><code>AsyncCloseable</code></a>: BKSyncLogReader is implemented based on BKAsyncLogReader, exposing + the <a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io"><code>AsyncCloseable</code></a> interface so the reader could be closed asynchronously</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog"><code>AsyncLogReader</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.distributedlog.io.AsyncCloseable"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.distributedlog.io.<a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io">AsyncCloseable</a></h3> +<code><a href="../../../org/apache/distributedlog/io/AsyncCloseable.html#CLOSE_FUNC">CLOSE_FUNC</a>, <a href="../../../org/apache/distributedlog/io/AsyncCloseable.html#CLOSE_FUNC_IGNORE_ERRORS">CLOSE_FUNC_IGNORE_ERRORS</a>, <a href="../../../org/apache/distributedlog/io/AsyncCloseable.html#NULL">NULL</a></code></li> +</ul> +</li> +</ul> +<!-- ========== 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><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogReader.html#readBulk-boolean-int-">readBulk</a></span>(boolean nonBlocking, + int numLogRecords)</code> +<div class="block">Read the next <i>numLogRecords</i> log records from the stream</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogReader.html#readNext-boolean-">readNext</a></span>(boolean nonBlocking)</code> +<div class="block">Read the next log record from the stream.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.io.Closeable"> +<!-- --> +</a> +<h3>Methods inherited from interface java.io.<a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close--"; title="class or interface in java.io">close</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.distributedlog.io.AsyncCloseable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.distributedlog.io.<a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io">AsyncCloseable</a></h3> +<code><a href="../../../org/apache/distributedlog/io/AsyncCloseable.html#asyncClose--">asyncClose</a></code></li> +</ul> +</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="readNext-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readNext</h4> +<pre><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a> readNext(boolean nonBlocking) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Read the next log record from the stream. + <p> + If <i>nonBlocking</i> is set to true, the call returns immediately by just polling + records from read ahead cache. It would return <i>null</i> if there isn't any records + available in the read ahead cache. + <p> + If <i>nonBlocking</i> is set to false, it would does blocking call. The call will + block until return a record if there are records in the stream (aka catching up). + Otherwise it would wait up to <a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html#getReadAheadWaitTime--"><code>DistributedLogConfiguration.getReadAheadWaitTime()</code></a> + milliseconds and return null if there isn't any more records in the stream.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>nonBlocking</code> - should the read make blocking calls to the backend or rely on the + readAhead cache</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an operation from the stream or null if at end of stream</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if there is an error reading from the stream</dd> +</dl> +</li> +</ul> +<a name="readBulk-boolean-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readBulk</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>> readBulk(boolean nonBlocking, + int numLogRecords) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Read the next <i>numLogRecords</i> log records from the stream</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>nonBlocking</code> - should the read make blocking calls to the backend or rely on the + readAhead cache</dd> +<dd><code>numLogRecords</code> - maximum number of log records returned by this call.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an operation from the stream or empty list if at end of stream</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if there is an error reading from the stream</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/LogReader.html#readNext-boolean-"><code>readNext(boolean)</code></a></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/LogReader.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/distributedlog/LocalDLMEmulator.Builder.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LogReader.html" target="_top">Frames</a></li> +<li><a href="LogReader.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 © 2016-2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/ef7245e8/content/docs/latest/api/java/org/apache/distributedlog/LogRecord.Reader.html ---------------------------------------------------------------------- diff --git a/content/docs/latest/api/java/org/apache/distributedlog/LogRecord.Reader.html b/content/docs/latest/api/java/org/apache/distributedlog/LogRecord.Reader.html new file mode 100644 index 0000000..e70ab47 --- /dev/null +++ b/content/docs/latest/api/java/org/apache/distributedlog/LogRecord.Reader.html @@ -0,0 +1,360 @@ +<!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_121) on Wed Apr 26 11:46:58 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LogRecord.Reader (Apache DistributedLog for Java, version latest)</title> +<meta name="date" content="2017-04-26"> +<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="LogRecord.Reader (Apache DistributedLog for Java, version latest)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/LogRecord.Reader.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/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecord.Writer.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LogRecord.Reader.html" target="_top">Frames</a></li> +<li><a href="LogRecord.Reader.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.distributedlog</div> +<h2 title="Class LogRecord.Reader" class="title">Class LogRecord.Reader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.distributedlog.LogRecord.Reader</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">LogRecord.Reader</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Reader class to read log records from an input <code>stream</code>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Reader.html#Reader-org.apache.distributedlog.RecordStream-java.io.DataInputStream-long-">Reader</a></span>(org.apache.distributedlog.RecordStream recordStream, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/DataInputStream.html?is-external=true"; title="class or interface in java.io">DataInputStream</a> in, + long startSequenceId)</code> +<div class="block">Construct the reader.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Reader.html#Reader-org.apache.distributedlog.RecordStream-java.io.DataInputStream-long-boolean-">Reader</a></span>(org.apache.distributedlog.RecordStream recordStream, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/DataInputStream.html?is-external=true"; title="class or interface in java.io">DataInputStream</a> in, + long startSequenceId, + boolean deserializeRecordSet)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Reader.html#readOp--">readOp</a></span>()</code> +<div class="block">Read an log record from the input stream.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Reader.html#skipTo-org.apache.distributedlog.DLSN-">skipTo</a></span>(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> dlsn)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Reader.html#skipTo-long-boolean-">skipTo</a></span>(long txId, + boolean skipControl)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Reader-org.apache.distributedlog.RecordStream-java.io.DataInputStream-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Reader</h4> +<pre>public Reader(org.apache.distributedlog.RecordStream recordStream, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/DataInputStream.html?is-external=true"; title="class or interface in java.io">DataInputStream</a> in, + long startSequenceId)</pre> +<div class="block">Construct the reader.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>recordStream</code> - the record stream for generating <code>DLSN</code>s.</dd> +<dd><code>in</code> - The stream to read from.</dd> +<dd><code>startSequenceId</code> - the start sequence id.</dd> +</dl> +</li> +</ul> +<a name="Reader-org.apache.distributedlog.RecordStream-java.io.DataInputStream-long-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Reader</h4> +<pre>public Reader(org.apache.distributedlog.RecordStream recordStream, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/DataInputStream.html?is-external=true"; title="class or interface in java.io">DataInputStream</a> in, + long startSequenceId, + boolean deserializeRecordSet)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="readOp--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readOp</h4> +<pre>public <a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a> readOp() + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Read an log record from the input stream. + + <p/> Note that the objects returned from this method may be re-used by future + calls to the same method.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the operation read from the stream, or null at the end of the file</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - on error.</dd> +</dl> +</li> +</ul> +<a name="skipTo-long-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipTo</h4> +<pre>public boolean skipTo(long txId, + boolean skipControl) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/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="skipTo-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>skipTo</h4> +<pre>public boolean skipTo(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> dlsn) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/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/LogRecord.Reader.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/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecord.Writer.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LogRecord.Reader.html" target="_top">Frames</a></li> +<li><a href="LogRecord.Reader.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2016-2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/ef7245e8/content/docs/latest/api/java/org/apache/distributedlog/LogRecord.Writer.html ---------------------------------------------------------------------- diff --git a/content/docs/latest/api/java/org/apache/distributedlog/LogRecord.Writer.html b/content/docs/latest/api/java/org/apache/distributedlog/LogRecord.Writer.html new file mode 100644 index 0000000..ff33702 --- /dev/null +++ b/content/docs/latest/api/java/org/apache/distributedlog/LogRecord.Writer.html @@ -0,0 +1,301 @@ +<!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_121) on Wed Apr 26 11:46:58 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LogRecord.Writer (Apache DistributedLog for Java, version latest)</title> +<meta name="date" content="2017-04-26"> +<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="LogRecord.Writer (Apache DistributedLog for Java, version latest)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/LogRecord.Writer.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/distributedlog/LogRecord.Reader.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordSet.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LogRecord.Writer.html" target="_top">Frames</a></li> +<li><a href="LogRecord.Writer.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.distributedlog</div> +<h2 title="Class LogRecord.Writer" class="title">Class LogRecord.Writer</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.distributedlog.LogRecord.Writer</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">LogRecord.Writer</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Writer class to write log records into an output <code>stream</code>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Writer.html#Writer-java.io.DataOutputStream-">Writer</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/DataOutputStream.html?is-external=true"; title="class or interface in java.io">DataOutputStream</a> out)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Writer.html#getPendingBytes--">getPendingBytes</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Writer.html#writeOp-org.apache.distributedlog.LogRecord-">writeOp</a></span>(<a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a> record)</code> +<div class="block">Write an operation to the output stream.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Writer-java.io.DataOutputStream-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Writer</h4> +<pre>public Writer(<a href="http://download.oracle.com/javase/6/docs/api/java/io/DataOutputStream.html?is-external=true"; title="class or interface in java.io">DataOutputStream</a> out)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="writeOp-org.apache.distributedlog.LogRecord-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeOp</h4> +<pre>public void writeOp(<a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a> record) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Write an operation to the output stream.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>record</code> - The operation to write</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if an error occurs during writing.</dd> +</dl> +</li> +</ul> +<a name="getPendingBytes--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPendingBytes</h4> +<pre>public int getPendingBytes()</pre> +</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/LogRecord.Writer.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/distributedlog/LogRecord.Reader.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordSet.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LogRecord.Writer.html" target="_top">Frames</a></li> +<li><a href="LogRecord.Writer.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2016-2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
