http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/DistributedLogManager.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/DistributedLogManager.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/DistributedLogManager.html new file mode 100644 index 0000000..aeeb15d --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/DistributedLogManager.html @@ -0,0 +1,1014 @@ +<!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_92) on Sun Jan 08 19:29:04 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DistributedLogManager (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="DistributedLogManager (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":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/DistributedLogManager.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/DistributedLogConstants.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/DLSN.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/DistributedLogManager.html" target="_top">Frames</a></li> +<li><a href="DistributedLogManager.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 DistributedLogManager" class="title">Interface DistributedLogManager</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">DistributedLogManager</span> +extends <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/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></pre> +<div class="block">A DistributedLogManager is responsible for managing a single place of storing + edit logs. It may correspond to multiple files, a backup node, etc. + Even when the actual underlying storage is rolled, or failed and restored, + each conceptual place of storage corresponds to exactly one instance of + this class, which is created when the EditLog is first opened.</div> +</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#delete--">delete</a></span>()</code> +<div class="block">Delete the log.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/AppendOnlyStreamReader.html" title="class in org.apache.distributedlog">AppendOnlyStreamReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getAppendOnlyStreamReader--">getAppendOnlyStreamReader</a></span>()</code> +<div class="block">Get a reader to read a log stream as a sequence of bytes</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/AppendOnlyStreamWriter.html" title="class in org.apache.distributedlog">AppendOnlyStreamWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getAppendOnlyStreamWriter--">getAppendOnlyStreamWriter</a></span>()</code> +<div class="block">Begin appending to the end of the log stream which is being treated as a sequence of bytes</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getAsyncLogReader-org.apache.distributedlog.DLSN-">getAsyncLogReader</a></span>(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getAsyncLogReader-long-">getAsyncLogReader</a></span>(long fromTxnId)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getAsyncLogReaderWithLock-org.apache.distributedlog.DLSN-">getAsyncLogReaderWithLock</a></span>(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getAsyncLogReaderWithLock-org.apache.distributedlog.DLSN-java.lang.String-">getAsyncLogReaderWithLock</a></span>(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN, + <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> subscriberId)</code> +<div class="block">Get a log reader with lock starting from <i>fromDLSN</i> and using <i>subscriberId</i>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getAsyncLogReaderWithLock-java.lang.String-">getAsyncLogReaderWithLock</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> subscriberId)</code> +<div class="block">Get a log reader using <i>subscriberId</i> with lock.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getDLSNNotLessThanTxId-long-">getDLSNNotLessThanTxId</a></span>(long transactionId)</code> +<div class="block">Get the <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog"><code>DLSN</code></a> of first log record whose transaction id is not less than <code>transactionId</code>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getFirstDLSNAsync--">getFirstDLSNAsync</a></span>()</code> +<div class="block">Get first DLSN in the log.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getFirstTxId--">getFirstTxId</a></span>()</code> +<div class="block">Get the earliest Transaction Id available in the log</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/LogReader.html" title="interface in org.apache.distributedlog">LogReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getInputStream-org.apache.distributedlog.DLSN-">getInputStream</a></span>(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/LogReader.html" title="interface in org.apache.distributedlog">LogReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getInputStream-long-">getInputStream</a></span>(long fromTxnId)</code> +<div class="block">Get the input stream starting with fromTxnId for the specified log</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getLastDLSN--">getLastDLSN</a></span>()</code> +<div class="block">Get Latest DLSN in the log</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getLastDLSNAsync--">getLastDLSNAsync</a></span>()</code> +<div class="block">Get Latest DLSN in the log - async</div> +</td> +</tr> +<tr id="i15" 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/DistributedLogManager.html#getLastLogRecord--">getLastLogRecord</a></span>()</code> +<div class="block">Get the last log record in the stream</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<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/DistributedLogManager.html#getLastLogRecordAsync--">getLastLogRecordAsync</a></span>()</code> +<div class="block">Get Latest log record with DLSN in the log - async</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getLastTxId--">getLastTxId</a></span>()</code> +<div class="block">Get Latest Transaction Id in the log</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getLastTxIdAsync--">getLastTxIdAsync</a></span>()</code> +<div class="block">Get Latest Transaction Id in the log - async</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getLogRecordCount--">getLogRecordCount</a></span>()</code> +<div class="block">Get the number of log records in the active portion of the log + Any log segments that have already been truncated will not be included</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getLogRecordCountAsync-org.apache.distributedlog.DLSN-">getLogRecordCountAsync</a></span>(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> beginDLSN)</code> +<div class="block">Get the number of log records in the active portion of the log - async.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<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/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getLogSegments--">getLogSegments</a></span>()</code> +<div class="block">Get log segments.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/namespace/NamespaceDriver.html" title="interface in org.apache.distributedlog.namespace">NamespaceDriver</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getNamespaceDriver--">getNamespaceDriver</a></span>()</code> +<div class="block">Get the namespace driver used by this manager.</div> +</td> +</tr> +<tr id="i23" 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/DistributedLogManager.html#getStreamName--">getStreamName</a></span>()</code> +<div class="block">Get the name of the stream managed by this log manager</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/subscription/SubscriptionsStore.html" title="interface in org.apache.distributedlog.subscription">SubscriptionsStore</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#getSubscriptionsStore--">getSubscriptionsStore</a></span>()</code> +<div class="block">Get the subscriptions store provided by the distributedlog manager.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#isEndOfStreamMarked--">isEndOfStreamMarked</a></span>()</code> +<div class="block">Check if an end of stream marker was added to the stream + A stream with an end of stream marker cannot be appended to</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#openAsyncLogReader-org.apache.distributedlog.DLSN-">openAsyncLogReader</a></span>(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN)</code> +<div class="block">Open an async log reader to read records from a log starting from <code>fromDLSN</code></div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#openAsyncLogReader-long-">openAsyncLogReader</a></span>(long fromTxnId)</code> +<div class="block">Open an async log reader to read records from a log starting from <code>fromTxnId</code>.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogWriter.html" title="interface in org.apache.distributedlog">AsyncLogWriter</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#openAsyncLogWriter--">openAsyncLogWriter</a></span>()</code> +<div class="block">Open async log writer to write records to the log stream.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#purgeLogsOlderThan-long-">purgeLogsOlderThan</a></span>(long minTxIdToKeep)</code> +<div class="block">The DistributedLogManager may archive/purge any logs for transactionId + less than or equal to minImageTxId.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#recover--">recover</a></span>()</code> +<div class="block">Run recovery on the log.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#registerListener-org.apache.distributedlog.callback.LogSegmentListener-">registerListener</a></span>(<a href="../../../org/apache/distributedlog/callback/LogSegmentListener.html" title="interface in org.apache.distributedlog.callback">LogSegmentListener</a> listener)</code> +<div class="block">Register <i>listener</i> on log segment updates of this stream.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/AsyncLogWriter.html" title="interface in org.apache.distributedlog">AsyncLogWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#startAsyncLogSegmentNonPartitioned--">startAsyncLogSegmentNonPartitioned</a></span>()</code> +<div class="block">Begin writing to the log stream identified by the name</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/LogWriter.html" title="interface in org.apache.distributedlog">LogWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#startLogSegmentNonPartitioned--">startLogSegmentNonPartitioned</a></span>()</code> +<div class="block">Begin writing to the log stream identified by the name</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/DistributedLogManager.html#unregisterListener-org.apache.distributedlog.callback.LogSegmentListener-">unregisterListener</a></span>(<a href="../../../org/apache/distributedlog/callback/LogSegmentListener.html" title="interface in org.apache.distributedlog.callback">LogSegmentListener</a> listener)</code> +<div class="block">Unregister <i>listener</i> on log segment updates from this stream.</div> +</td> +</tr> +</table> +<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> +<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> +</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="getStreamName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStreamName</h4> +<pre><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> getStreamName()</pre> +<div class="block">Get the name of the stream managed by this log manager</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>streamName</dd> +</dl> +</li> +</ul> +<a name="getNamespaceDriver--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNamespaceDriver</h4> +<pre><a href="../../../org/apache/distributedlog/namespace/NamespaceDriver.html" title="interface in org.apache.distributedlog.namespace">NamespaceDriver</a> getNamespaceDriver()</pre> +<div class="block">Get the namespace driver used by this manager.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the namespace driver</dd> +</dl> +</li> +</ul> +<a name="getLogSegments--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogSegments</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/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>> getLogSegments() + 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">Get log segments.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>log segments</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></dd> +</dl> +</li> +</ul> +<a name="registerListener-org.apache.distributedlog.callback.LogSegmentListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerListener</h4> +<pre>void registerListener(<a href="../../../org/apache/distributedlog/callback/LogSegmentListener.html" title="interface in org.apache.distributedlog.callback">LogSegmentListener</a> listener) + 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">Register <i>listener</i> on log segment updates of this stream.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>listener</code> - listener to receive update log segment list.</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></dd> +</dl> +</li> +</ul> +<a name="unregisterListener-org.apache.distributedlog.callback.LogSegmentListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unregisterListener</h4> +<pre>void unregisterListener(<a href="../../../org/apache/distributedlog/callback/LogSegmentListener.html" title="interface in org.apache.distributedlog.callback">LogSegmentListener</a> listener)</pre> +<div class="block">Unregister <i>listener</i> on log segment updates from this stream.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>listener</code> - listener to receive update log segment list.</dd> +</dl> +</li> +</ul> +<a name="openAsyncLogWriter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openAsyncLogWriter</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogWriter.html" title="interface in org.apache.distributedlog">AsyncLogWriter</a>> openAsyncLogWriter()</pre> +<div class="block">Open async log writer to write records to the log stream.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>result represents the open result</dd> +</dl> +</li> +</ul> +<a name="startLogSegmentNonPartitioned--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startLogSegmentNonPartitioned</h4> +<pre><a href="../../../org/apache/distributedlog/LogWriter.html" title="interface in org.apache.distributedlog">LogWriter</a> startLogSegmentNonPartitioned() + 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">Begin writing to the log stream identified by the name</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the writer interface to generate log records</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></dd> +</dl> +</li> +</ul> +<a name="startAsyncLogSegmentNonPartitioned--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startAsyncLogSegmentNonPartitioned</h4> +<pre><a href="../../../org/apache/distributedlog/AsyncLogWriter.html" title="interface in org.apache.distributedlog">AsyncLogWriter</a> startAsyncLogSegmentNonPartitioned() + 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">Begin writing to the log stream identified by the name</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the writer interface to generate log records</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></dd> +</dl> +</li> +</ul> +<a name="getAppendOnlyStreamWriter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAppendOnlyStreamWriter</h4> +<pre><a href="../../../org/apache/distributedlog/AppendOnlyStreamWriter.html" title="class in org.apache.distributedlog">AppendOnlyStreamWriter</a> getAppendOnlyStreamWriter() + 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">Begin appending to the end of the log stream which is being treated as a sequence of bytes</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the writer interface to generate log records</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></dd> +</dl> +</li> +</ul> +<a name="getAppendOnlyStreamReader--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAppendOnlyStreamReader</h4> +<pre><a href="../../../org/apache/distributedlog/AppendOnlyStreamReader.html" title="class in org.apache.distributedlog">AppendOnlyStreamReader</a> getAppendOnlyStreamReader() + 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">Get a reader to read a log stream as a sequence of bytes</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the writer interface to generate log records</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></dd> +</dl> +</li> +</ul> +<a name="getInputStream-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInputStream</h4> +<pre><a href="../../../org/apache/distributedlog/LogReader.html" title="interface in org.apache.distributedlog">LogReader</a> getInputStream(long fromTxnId) + 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">Get the input stream starting with fromTxnId for the specified log</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fromTxnId</code> - - the first transaction id we want to read</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the stream starting with transaction fromTxnId</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 a stream cannot be found.</dd> +</dl> +</li> +</ul> +<a name="getInputStream-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInputStream</h4> +<pre><a href="../../../org/apache/distributedlog/LogReader.html" title="interface in org.apache.distributedlog">LogReader</a> getInputStream(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN) + 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="openAsyncLogReader-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openAsyncLogReader</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>> openAsyncLogReader(long fromTxnId)</pre> +<div class="block">Open an async log reader to read records from a log starting from <code>fromTxnId</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fromTxnId</code> - transaction id to start reading from</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>async log reader</dd> +</dl> +</li> +</ul> +<a name="openAsyncLogReader-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openAsyncLogReader</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>> openAsyncLogReader(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN)</pre> +<div class="block">Open an async log reader to read records from a log starting from <code>fromDLSN</code></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fromDLSN</code> - dlsn to start reading from</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>async log reader</dd> +</dl> +</li> +</ul> +<a name="getAsyncLogReader-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsyncLogReader</h4> +<pre><a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a> getAsyncLogReader(long fromTxnId) + 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="getAsyncLogReader-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsyncLogReader</h4> +<pre><a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a> getAsyncLogReader(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN) + 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="getAsyncLogReaderWithLock-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsyncLogReaderWithLock</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>> getAsyncLogReaderWithLock(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN)</pre> +</li> +</ul> +<a name="getAsyncLogReaderWithLock-org.apache.distributedlog.DLSN-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsyncLogReaderWithLock</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>> getAsyncLogReaderWithLock(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> fromDLSN, + <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> subscriberId)</pre> +<div class="block">Get a log reader with lock starting from <i>fromDLSN</i> and using <i>subscriberId</i>. + If two readers tried to open using same subscriberId, one would succeed, while the other + will be blocked until it gets the lock.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fromDLSN</code> - start dlsn</dd> +<dd><code>subscriberId</code> - subscriber id</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>async log reader</dd> +</dl> +</li> +</ul> +<a name="getAsyncLogReaderWithLock-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsyncLogReaderWithLock</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/AsyncLogReader.html" title="interface in org.apache.distributedlog">AsyncLogReader</a>> getAsyncLogReaderWithLock(<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> subscriberId)</pre> +<div class="block">Get a log reader using <i>subscriberId</i> with lock. The reader will start reading from + its last commit position recorded in subscription store. If no last commit position found + in subscription store, it would start reading from head of the stream. + + If the two readers tried to open using same subscriberId, one would succeed, while the other + will be blocked until it gets the lock.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>subscriberId</code> - subscriber id</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>async log reader</dd> +</dl> +</li> +</ul> +<a name="getDLSNNotLessThanTxId-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDLSNNotLessThanTxId</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>> getDLSNNotLessThanTxId(long transactionId)</pre> +<div class="block">Get the <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog"><code>DLSN</code></a> of first log record whose transaction id is not less than <code>transactionId</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>transactionId</code> - transaction id</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>dlsn of first log record whose transaction id is not less than transactionId.</dd> +</dl> +</li> +</ul> +<a name="getLastLogRecord--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastLogRecord</h4> +<pre><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a> getLastLogRecord() + 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">Get the last log record in the stream</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the last log record in the 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 a stream cannot be found.</dd> +</dl> +</li> +</ul> +<a name="getFirstTxId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFirstTxId</h4> +<pre>long getFirstTxId() + 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">Get the earliest Transaction Id available in the log</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>earliest transaction id</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></dd> +</dl> +</li> +</ul> +<a name="getLastTxId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastTxId</h4> +<pre>long getLastTxId() + 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">Get Latest Transaction Id in the log</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>latest transaction id</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></dd> +</dl> +</li> +</ul> +<a name="getLastDLSN--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastDLSN</h4> +<pre><a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> getLastDLSN() + 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">Get Latest DLSN in the log</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>last dlsn</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></dd> +</dl> +</li> +</ul> +<a name="getLastLogRecordAsync--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastLogRecordAsync</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>> getLastLogRecordAsync()</pre> +<div class="block">Get Latest log record with DLSN in the log - async</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>latest log record with DLSN</dd> +</dl> +</li> +</ul> +<a name="getLastTxIdAsync--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastTxIdAsync</h4> +<pre>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>> getLastTxIdAsync()</pre> +<div class="block">Get Latest Transaction Id in the log - async</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>latest transaction id</dd> +</dl> +</li> +</ul> +<a name="getFirstDLSNAsync--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFirstDLSNAsync</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>> getFirstDLSNAsync()</pre> +<div class="block">Get first DLSN in the log.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>first dlsn in the stream</dd> +</dl> +</li> +</ul> +<a name="getLastDLSNAsync--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastDLSNAsync</h4> +<pre>com.twitter.util.Future<<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>> getLastDLSNAsync()</pre> +<div class="block">Get Latest DLSN in the log - async</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>latest transaction id</dd> +</dl> +</li> +</ul> +<a name="getLogRecordCount--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogRecordCount</h4> +<pre>long getLogRecordCount() + 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">Get the number of log records in the active portion of the log + Any log segments that have already been truncated will not be included</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>number of log records</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></dd> +</dl> +</li> +</ul> +<a name="getLogRecordCountAsync-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogRecordCountAsync</h4> +<pre>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true"; title="class or interface in java.lang">Long</a>> getLogRecordCountAsync(<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> beginDLSN)</pre> +<div class="block">Get the number of log records in the active portion of the log - async. + Any log segments that have already been truncated will not be included</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>future number of log records</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></dd> +</dl> +</li> +</ul> +<a name="recover--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>recover</h4> +<pre>void recover() + 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">Run recovery on the log.</div> +<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="isEndOfStreamMarked--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEndOfStreamMarked</h4> +<pre>boolean isEndOfStreamMarked() + 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">Check if an end of stream marker was added to the stream + A stream with an end of stream marker cannot be appended to</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the marker was added to the stream, false otherwise</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></dd> +</dl> +</li> +</ul> +<a name="delete--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>void delete() + 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">Delete the log.</div> +<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> - if the deletion fails</dd> +</dl> +</li> +</ul> +<a name="purgeLogsOlderThan-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>purgeLogsOlderThan</h4> +<pre>void purgeLogsOlderThan(long minTxIdToKeep) + 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">The DistributedLogManager may archive/purge any logs for transactionId + less than or equal to minImageTxId. + This is to be used only when the client explicitly manages deletion. If + the cleanup policy is based on sliding time window, then this method need + not be called.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>minTxIdToKeep</code> - the earliest txid that must be retained</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 purging fails</dd> +</dl> +</li> +</ul> +<a name="getSubscriptionsStore--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSubscriptionsStore</h4> +<pre><a href="../../../org/apache/distributedlog/subscription/SubscriptionsStore.html" title="interface in org.apache.distributedlog.subscription">SubscriptionsStore</a> getSubscriptionsStore()</pre> +<div class="block">Get the subscriptions store provided by the distributedlog manager.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>subscriptions store manages subscriptions for current stream.</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/DistributedLogManager.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/DistributedLogConstants.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/DLSN.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/DistributedLogManager.html" target="_top">Frames</a></li> +<li><a href="DistributedLogManager.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/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/Entry.Builder.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/Entry.Builder.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/Entry.Builder.html new file mode 100644 index 0000000..fed115a --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/Entry.Builder.html @@ -0,0 +1,470 @@ +<!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_92) on Sun Jan 08 19:29:05 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Entry.Builder (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="Entry.Builder (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":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/Entry.Builder.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.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/Entry.Reader.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/Entry.Builder.html" target="_top">Frames</a></li> +<li><a href="Entry.Builder.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="Class Entry.Builder" class="title">Class Entry.Builder</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.Entry.Builder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../org/apache/distributedlog/Entry.html" title="class in org.apache.distributedlog">Entry</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">Entry.Builder</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">Build the record set object.</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="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/Entry.html" title="class in org.apache.distributedlog">Entry</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#build--">build</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Reader.html" title="interface in org.apache.distributedlog">Entry.Reader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#buildReader--">buildReader</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#deserializeRecordSet-boolean-">deserializeRecordSet</a></span>(boolean enabled)</code> +<div class="block">Enable/disable deserialize record set.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#reset--">reset</a></span>()</code> +<div class="block">Reset the builder.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#setData-byte:A-int-int-">setData</a></span>(byte[] data, + int offset, + int length)</code> +<div class="block">Set the serialized bytes data of this record set.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#setEntryId-long-">setEntryId</a></span>(long entryId)</code> +<div class="block">Set the entry id of this log record set.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#setEnvelopeEntry-boolean-">setEnvelopeEntry</a></span>(boolean enabled)</code> +<div class="block">Set whether this record set is enveloped or not.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#setInputStream-java.io.InputStream-">setInputStream</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> in)</code> +<div class="block">Set the input stream of the serialized bytes data of this record set.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#setLogSegmentInfo-long-long-">setLogSegmentInfo</a></span>(long lssn, + long startSequenceId)</code> +<div class="block">Set the segment info of the log segment that this record + set belongs to.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.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> +<div class="block">Set the record set starts from <code>dlsn</code>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/Entry.Builder.html#skipTo-long-">skipTo</a></span>(long txid)</code> +<div class="block">Set the record set starts from <code>txid</code>.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="reset--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> reset()</pre> +<div class="block">Reset the builder.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="setLogSegmentInfo-long-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogSegmentInfo</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> setLogSegmentInfo(long lssn, + long startSequenceId)</pre> +<div class="block">Set the segment info of the log segment that this record + set belongs to.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>lssn</code> - log segment sequence number</dd> +<dd><code>startSequenceId</code> - start sequence id of this log segment</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="setEntryId-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEntryId</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> setEntryId(long entryId)</pre> +<div class="block">Set the entry id of this log record set.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>entryId</code> - entry id assigned for this log record set.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="setEnvelopeEntry-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnvelopeEntry</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> setEnvelopeEntry(boolean enabled)</pre> +<div class="block">Set whether this record set is enveloped or not.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>enabled</code> - flag indicates whether this record set is enveloped or not.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="setData-byte:A-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> setData(byte[] data, + int offset, + int length)</pre> +<div class="block">Set the serialized bytes data of this record set.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>data</code> - serialized bytes data of this record set.</dd> +<dd><code>offset</code> - offset of the bytes data</dd> +<dd><code>length</code> - length of the bytes data</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="setInputStream-java.io.InputStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInputStream</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> setInputStream(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> in)</pre> +<div class="block">Set the input stream of the serialized bytes data of this record set.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - input stream</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="skipTo-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipTo</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> skipTo(<a href="http://download.oracle.com/javase/6/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> + <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> dlsn)</pre> +<div class="block">Set the record set starts from <code>dlsn</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>dlsn</code> - dlsn to skip to</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="skipTo-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipTo</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> skipTo(long txid)</pre> +<div class="block">Set the record set starts from <code>txid</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>txid</code> - txid to skip to</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="deserializeRecordSet-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deserializeRecordSet</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Builder.html" title="class in org.apache.distributedlog">Entry.Builder</a> deserializeRecordSet(boolean enabled)</pre> +<div class="block">Enable/disable deserialize record set.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>enabled</code> - flag to enable/disable dserialize record set.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="build--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.html" title="class in org.apache.distributedlog">Entry</a> build()</pre> +</li> +</ul> +<a name="buildReader--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>buildReader</h4> +<pre>public <a href="../../../org/apache/distributedlog/Entry.Reader.html" title="interface in org.apache.distributedlog">Entry.Reader</a> buildReader() + 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/Entry.Builder.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.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/Entry.Reader.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/Entry.Builder.html" target="_top">Frames</a></li> +<li><a href="Entry.Builder.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>
