http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/49afadb4/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecord.html ---------------------------------------------------------------------- diff --git a/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecord.html b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecord.html new file mode 100644 index 0000000..ab7a4e7 --- /dev/null +++ b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecord.html @@ -0,0 +1,708 @@ +<!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>LogRecord (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="LogRecord (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":9,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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/LogRecord.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/LogReader.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecord.Reader.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.html" target="_top">Frames</a></li> +<li><a href="LogRecord.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><a href="#constructor.summary">Constr</a> | </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><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" class="title">Class LogRecord</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</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">LogRecord</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">Log record is the basic element in a log. + + <p>A log is a sequence of log records. Each log record is a sequence of bytes. + Log records are written sequentially into a stream, and will be assigned with + an unique system generated sequence number <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog"><code>DLSN</code></a> (distributedlog sequence + number). Besides <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog"><code>DLSN</code></a>, application can assign its own sequence number + while constructing log records. The application defined sequence number is called + <code>TransactionID</code> (<i>txid</i>). Either <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog"><code>DLSN</code></a> or <code>TransactionId</code> + could be used to position readers to start from specific log records. + + <h3>User Record</h3> + + <p>User records are the records written by applications and read by applications. They + are constructed via <a href="../../../org/apache/distributedlog/LogRecord.html#LogRecord-long-byte:A-"><code>LogRecord(long, byte[])</code></a> by applications and appended to + logs by writers. And they would be deserialized from bytes by the readers and return + to applications. + + <h3>Control Record</h3> + + <p>Control records are special records that written by distributedlog. They are invisible + to applications. They could be treated as <i>commit requests</i> as what people could find + in distributed consensus algorithms, since they are usually written by distributedlog to + commit application written records. <i>Commit</i> means making application written records + visible to readers to achieve consistent views among them. + + <p>They are named as 'Control Records' for controlling visibility of application written records. + + <p>The transaction id of 'Control Records' are assigned by distributedlog by inheriting from last + written user records. So we could indicate what user records that a control record is committing + by looking at its transaction id. + + <h4>EndOfStream Record</h4> + + <p><code>EoS</code>(EndOfStream) is a special control record that would be written by a writer + to seal a log. After a <i>EoS</i> record is written to a log, no writers could append any record + after that and readers will get <a href="../../../org/apache/distributedlog/exceptions/EndOfStreamException.html" title="class in org.apache.distributedlog.exceptions"><code>EndOfStreamException</code></a> + when they reach EoS. + + <p>TransactionID of EoS is <code>Long.MAX_VALUE</code>. + + <h3>Serialization & Deserialization</h3> + + <p>Data type in brackets. Interpretation should be on the basis of data types and not individual + bytes to honor Endianness. + + <pre> + LogRecord structure: + ------------------- + Bytes 0 - 7 : Metadata (Long) + Bytes 8 - 15 : TxId (Long) + Bytes 16 - 19 : Payload length (Integer) + Bytes 20 - 20+payload.length-1 : Payload (Byte[]) + + Metadata: 8 Bytes (Long) + -------- + + 0x 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 + |_____________| |_____| + | | + position flags + + Flags: 2 Bytes (least significant) + ----- + Bit 0 : If set, control record, else record with payload. + Bit 1 : If set, end of stream. + Bits 2 - 15 : Unused + </pre> + + <h3>Sequence Numbers</h3> + + <p>A record is associated with three types of sequence numbers. They are generated + and used for different purposes. Check <a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog"><code>LogRecordWithDLSN</code></a> for more details.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog"><code>LogRecordWithDLSN</code></a></dd> +</dl> +</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/LogRecord.Reader.html" title="class in org.apache.distributedlog">LogRecord.Reader</a></span></code> +<div class="block">Reader class to read log records from an input <code>stream</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.Writer.html" title="class in org.apache.distributedlog">LogRecord.Writer</a></span></code> +<div class="block">Writer class to write log records into an output <code>stream</code>.</div> +</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 int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#MAX_LOGRECORD_SIZE">MAX_LOGRECORD_SIZE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#MAX_LOGRECORDSET_SIZE">MAX_LOGRECORDSET_SIZE</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#LogRecord--">LogRecord</a></span>()</code> +<div class="block">Construct an uninitialized log record.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#LogRecord-long-byte:A-">LogRecord</a></span>(long txid, + byte[] payload)</code> +<div class="block">Construct a log record with <i>TransactionId</i> and payload.</div> +</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>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#getMetadata--">getMetadata</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#getPayload--">getPayload</a></span>()</code> +<div class="block">Return the payload of this log record.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#getPayLoadInputStream--">getPayLoadInputStream</a></span>()</code> +<div class="block">Return the payload as an <a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#getPositionWithinLogSegment--">getPositionWithinLogSegment</a></span>()</code> +<div class="block">The position in the log segment means how many records (inclusive) added to the log segment so far.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#getTransactionId--">getTransactionId</a></span>()</code> +<div class="block">Return application defined transaction id.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#isControl--">isControl</a></span>()</code> +<div class="block">Check if the record is a control record.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#isControl-long-">isControl</a></span>(long flags)</code> +<div class="block">Check flags to see if it indicates a control record.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#isRecordSet--">isRecordSet</a></span>()</code> +<div class="block">Check if the record represents a set of records.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#isRecordSet-long-">isRecordSet</a></span>(long metadata)</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#readPayload-java.io.DataInputStream-">readPayload</a></span>(<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)</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#setControl--">setControl</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#setMetadata-long-">setMetadata</a></span>(long metadata)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#setRecordSet--">setRecordSet</a></span>()</code> +<div class="block">Set the record to represent a set of records.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecord.html#setTransactionId-long-">setTransactionId</a></span>(long txid)</code> +<div class="block">Set application defined transaction id.</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="MAX_LOGRECORD_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAX_LOGRECORD_SIZE</h4> +<pre>public static final int MAX_LOGRECORD_SIZE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.distributedlog.LogRecord.MAX_LOGRECORD_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="MAX_LOGRECORDSET_SIZE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MAX_LOGRECORDSET_SIZE</h4> +<pre>public static final int MAX_LOGRECORDSET_SIZE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.distributedlog.LogRecord.MAX_LOGRECORDSET_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LogRecord--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LogRecord</h4> +<pre>protected LogRecord()</pre> +<div class="block">Construct an uninitialized log record. + + <p>NOTE: only deserializer should call this constructor.</div> +</li> +</ul> +<a name="LogRecord-long-byte:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LogRecord</h4> +<pre>public LogRecord(long txid, + byte[] payload)</pre> +<div class="block">Construct a log record with <i>TransactionId</i> and payload. + + <p>Usually writer would construct the log record for writing.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>txid</code> - application defined transaction id.</dd> +<dd><code>payload</code> - record data</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="getTransactionId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionId</h4> +<pre>public long getTransactionId()</pre> +<div class="block">Return application defined transaction id.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>transacton id.</dd> +</dl> +</li> +</ul> +<a name="setTransactionId-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionId</h4> +<pre>protected void setTransactionId(long txid)</pre> +<div class="block">Set application defined transaction id.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>txid</code> - application defined transaction id.</dd> +</dl> +</li> +</ul> +<a name="getPayload--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPayload</h4> +<pre>public byte[] getPayload()</pre> +<div class="block">Return the payload of this log record.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>payload of this log record.</dd> +</dl> +</li> +</ul> +<a name="getPayLoadInputStream--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPayLoadInputStream</h4> +<pre>public <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> getPayLoadInputStream()</pre> +<div class="block">Return the payload as an <a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>payload as input stream</dd> +</dl> +</li> +</ul> +<a name="setMetadata-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMetadata</h4> +<pre>protected void setMetadata(long metadata)</pre> +</li> +</ul> +<a name="getMetadata--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMetadata</h4> +<pre>protected long getMetadata()</pre> +</li> +</ul> +<a name="getPositionWithinLogSegment--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPositionWithinLogSegment</h4> +<pre>public int getPositionWithinLogSegment()</pre> +<div class="block">The position in the log segment means how many records (inclusive) added to the log segment so far.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>position of the record in the log segment.</dd> +</dl> +</li> +</ul> +<a name="setRecordSet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRecordSet</h4> +<pre>public void setRecordSet()</pre> +<div class="block">Set the record to represent a set of records. + + <p>The bytes in this record is the serialized format of <a href="../../../org/apache/distributedlog/LogRecordSet.html" title="class in org.apache.distributedlog"><code>LogRecordSet</code></a>.</div> +</li> +</ul> +<a name="isRecordSet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRecordSet</h4> +<pre>public boolean isRecordSet()</pre> +<div class="block">Check if the record represents a set of records.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the record represents a set of records, otherwise false.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/distributedlog/LogRecord.html#setRecordSet--"><code>setRecordSet()</code></a></dd> +</dl> +</li> +</ul> +<a name="isRecordSet-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRecordSet</h4> +<pre>public static boolean isRecordSet(long metadata)</pre> +</li> +</ul> +<a name="setControl--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setControl</h4> +<pre>public void setControl()</pre> +</li> +</ul> +<a name="isControl--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isControl</h4> +<pre>public boolean isControl()</pre> +<div class="block">Check if the record is a control record.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the record is a control record, otherwise false.</dd> +</dl> +</li> +</ul> +<a name="isControl-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isControl</h4> +<pre>public static boolean isControl(long flags)</pre> +<div class="block">Check flags to see if it indicates a control record.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>flags</code> - record flags</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the record is a control record, otherwise false.</dd> +</dl> +</li> +</ul> +<a name="readPayload-java.io.DataInputStream-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readPayload</h4> +<pre>protected void readPayload(<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) + 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.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/LogReader.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecord.Reader.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.html" target="_top">Frames</a></li> +<li><a href="LogRecord.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><a href="#constructor.summary">Constr</a> | </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><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/49afadb4/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.Reader.html ---------------------------------------------------------------------- diff --git a/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.Reader.html b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.Reader.html new file mode 100644 index 0000000..7771250 --- /dev/null +++ b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.Reader.html @@ -0,0 +1,238 @@ +<!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>LogRecordSet.Reader (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="LogRecordSet.Reader (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/LogRecordSet.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/LogRecordSet.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordSet.Writer.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/LogRecordSet.Reader.html" target="_top">Frames</a></li> +<li><a href="LogRecordSet.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>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 LogRecordSet.Reader" class="title">Interface LogRecordSet.Reader</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../org/apache/distributedlog/LogRecordSet.html" title="class in org.apache.distributedlog">LogRecordSet</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="typeNameLabel">LogRecordSet.Reader</span></pre> +<div class="block">Reader to read <a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><code>LogRecord</code></a>s from this record set.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><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/LogRecordSet.Reader.html#nextRecord--">nextRecord</a></span>()</code> +<div class="block">Read next log record from this record set.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="nextRecord--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>nextRecord</h4> +<pre><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a> nextRecord() + 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 next log record from this record set.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>next log record from this record set.</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> +</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/LogRecordSet.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/LogRecordSet.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordSet.Writer.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/LogRecordSet.Reader.html" target="_top">Frames</a></li> +<li><a href="LogRecordSet.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>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/49afadb4/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.Writer.html ---------------------------------------------------------------------- diff --git a/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.Writer.html b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.Writer.html new file mode 100644 index 0000000..f5b4096 --- /dev/null +++ b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.Writer.html @@ -0,0 +1,256 @@ +<!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>LogRecordSet.Writer (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="LogRecordSet.Writer (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/LogRecordSet.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/LogRecordSet.Reader.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordSetBuffer.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/LogRecordSet.Writer.html" target="_top">Frames</a></li> +<li><a href="LogRecordSet.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>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 LogRecordSet.Writer" class="title">Interface LogRecordSet.Writer</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/LogRecordSetBuffer.html" title="interface in org.apache.distributedlog">LogRecordSetBuffer</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../org/apache/distributedlog/LogRecordSet.html" title="class in org.apache.distributedlog">LogRecordSet</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="typeNameLabel">LogRecordSet.Writer</span> +extends <a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html" title="interface in org.apache.distributedlog">LogRecordSetBuffer</a></pre> +<div class="block">Writer to append <a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><code>LogRecord</code></a>s to <a href="../../../org/apache/distributedlog/LogRecordSet.html" title="class in org.apache.distributedlog"><code>LogRecordSet</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSet.Writer.html#writeRecord-java.nio.ByteBuffer-com.twitter.util.Promise-">writeRecord</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> record, + com.twitter.util.Promise<<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>> transmitPromise)</code> +<div class="block">Write a <a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><code>LogRecord</code></a> to this record set.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.distributedlog.LogRecordSetBuffer"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.distributedlog.<a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html" title="interface in org.apache.distributedlog">LogRecordSetBuffer</a></h3> +<code><a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#abortTransmit-java.lang.Throwable-">abortTransmit</a>, <a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#completeTransmit-long-long-long-">completeTransmit</a>, <a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#getBuffer--">getBuffer</a>, <a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#getNumBytes--">getNumBytes</a>, <a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#getNumRecords--">getNumRecords</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="writeRecord-java.nio.ByteBuffer-com.twitter.util.Promise-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>writeRecord</h4> +<pre>void writeRecord(<a href="http://download.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> record, + com.twitter.util.Promise<<a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>> transmitPromise) + throws <a href="../../../org/apache/distributedlog/exceptions/LogRecordTooLongException.html" title="class in org.apache.distributedlog.exceptions">LogRecordTooLongException</a>, + <a href="../../../org/apache/distributedlog/exceptions/WriteException.html" title="class in org.apache.distributedlog.exceptions">WriteException</a></pre> +<div class="block">Write a <a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><code>LogRecord</code></a> to this record set.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>record</code> - record to write</dd> +<dd><code>transmitPromise</code> - callback for transmit result. the promise is only + satisfied when this record set is transmitted.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/LogRecordTooLongException.html" title="class in org.apache.distributedlog.exceptions">LogRecordTooLongException</a></code> - if the record is too long</dd> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/WriteException.html" title="class in org.apache.distributedlog.exceptions">WriteException</a></code> - when encountered exception writing the record</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/LogRecordSet.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/LogRecordSet.Reader.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordSetBuffer.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/LogRecordSet.Writer.html" target="_top">Frames</a></li> +<li><a href="LogRecordSet.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>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/49afadb4/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.html ---------------------------------------------------------------------- diff --git a/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.html b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.html new file mode 100644 index 0000000..7066283 --- /dev/null +++ b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSet.html @@ -0,0 +1,420 @@ +<!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>LogRecordSet (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="LogRecordSet (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/LogRecordSet.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.Writer.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordSet.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/LogRecordSet.html" target="_top">Frames</a></li> +<li><a href="LogRecordSet.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><a href="#constructor.summary">Constr</a> | </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><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 LogRecordSet" class="title">Class LogRecordSet</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.LogRecordSet</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">LogRecordSet</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">A set of <a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><code>LogRecord</code></a>s. + + <pre> + Structure: + Bytes 0 - 4 : Metadata (version + flags) + Bytes 4 - 7 : Number of Records + Bytes 8 - 11 : Original Payload Length + Bytes 12 - 15 : Actual Payload Length + Bytes 16 - 16+length-1 : Payload + ------------------------------------------------------ + + Metadata: Version and Flags // 32 Bits + -------------------------------------- + 0 ... 0 0 0 0 0 + |_| + | + Compression Codec: // 2 Bits (Least significant) + ----------------- + 00 : No Compression + 01 : LZ4 Compression + 10 : Unused + 11 : Unused + + </pre></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 interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSet.Reader.html" title="interface in org.apache.distributedlog">LogRecordSet.Reader</a></span></code> +<div class="block">Reader to read <a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><code>LogRecord</code></a>s from this record set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSet.Writer.html" title="interface in org.apache.distributedlog">LogRecordSet.Writer</a></span></code> +<div class="block">Writer to append <a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog"><code>LogRecord</code></a>s to <a href="../../../org/apache/distributedlog/LogRecordSet.html" title="class in org.apache.distributedlog"><code>LogRecordSet</code></a>.</div> +</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 int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSet.html#HEADER_LEN">HEADER_LEN</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/LogRecordSet.html#LogRecordSet--">LogRecordSet</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="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>static <a href="../../../org/apache/distributedlog/LogRecordSet.Writer.html" title="interface in org.apache.distributedlog">LogRecordSet.Writer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSet.html#newWriter-int-org.apache.distributedlog.io.CompressionCodec.Type-">newWriter</a></span>(int initialBufferSize, + <a href="../../../org/apache/distributedlog/io/CompressionCodec.Type.html" title="enum in org.apache.distributedlog.io">CompressionCodec.Type</a> codec)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSet.html#numRecords-byte:A-">numRecords</a></span>(byte[] data)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSet.html#numRecords-org.apache.distributedlog.LogRecord-">numRecords</a></span>(<a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a> record)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/distributedlog/LogRecordSet.Reader.html" title="interface in org.apache.distributedlog">LogRecordSet.Reader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSet.html#of-org.apache.distributedlog.LogRecordWithDLSN-">of</a></span>(<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a> record)</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="HEADER_LEN"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HEADER_LEN</h4> +<pre>public static final int HEADER_LEN</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.distributedlog.LogRecordSet.HEADER_LEN">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LogRecordSet--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LogRecordSet</h4> +<pre>public LogRecordSet()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="numRecords-org.apache.distributedlog.LogRecord-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>numRecords</h4> +<pre>public static int numRecords(<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> +<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="numRecords-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>numRecords</h4> +<pre>public static int numRecords(byte[] data) + 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="newWriter-int-org.apache.distributedlog.io.CompressionCodec.Type-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newWriter</h4> +<pre>public static <a href="../../../org/apache/distributedlog/LogRecordSet.Writer.html" title="interface in org.apache.distributedlog">LogRecordSet.Writer</a> newWriter(int initialBufferSize, + <a href="../../../org/apache/distributedlog/io/CompressionCodec.Type.html" title="enum in org.apache.distributedlog.io">CompressionCodec.Type</a> codec)</pre> +</li> +</ul> +<a name="of-org.apache.distributedlog.LogRecordWithDLSN-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <a href="../../../org/apache/distributedlog/LogRecordSet.Reader.html" title="interface in org.apache.distributedlog">LogRecordSet.Reader</a> of(<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</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> +<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/LogRecordSet.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.Writer.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordSet.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/LogRecordSet.html" target="_top">Frames</a></li> +<li><a href="LogRecordSet.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><a href="#constructor.summary">Constr</a> | </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><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/49afadb4/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSetBuffer.html ---------------------------------------------------------------------- diff --git a/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSetBuffer.html b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSetBuffer.html new file mode 100644 index 0000000..ddbbbc1 --- /dev/null +++ b/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogRecordSetBuffer.html @@ -0,0 +1,322 @@ +<!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>LogRecordSetBuffer (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="LogRecordSetBuffer (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LogRecordSetBuffer.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/LogRecordSet.Writer.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.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/LogRecordSetBuffer.html" target="_top">Frames</a></li> +<li><a href="LogRecordSetBuffer.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 LogRecordSetBuffer" class="title">Interface LogRecordSetBuffer</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../org/apache/distributedlog/LogRecordSet.Writer.html" title="interface in org.apache.distributedlog">LogRecordSet.Writer</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">LogRecordSetBuffer</span></pre> +<div class="block">Write representation of a <a href="../../../org/apache/distributedlog/LogRecordSet.html" title="class in org.apache.distributedlog"><code>LogRecordSet</code></a>. + It is a buffer of log record set, used for transmission.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#abortTransmit-java.lang.Throwable-">abortTransmit</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> reason)</code> +<div class="block">Abort transmit.</div> +</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/LogRecordSetBuffer.html#completeTransmit-long-long-long-">completeTransmit</a></span>(long lssn, + long entryId, + long startSlotId)</code> +<div class="block">Complete transmit.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#getBuffer--">getBuffer</a></span>()</code> +<div class="block">Get the buffer to transmit.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#getNumBytes--">getNumBytes</a></span>()</code> +<div class="block">Return number of bytes in current record set.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogRecordSetBuffer.html#getNumRecords--">getNumRecords</a></span>()</code> +<div class="block">Return number of records in current record set.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getNumRecords--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumRecords</h4> +<pre>int getNumRecords()</pre> +<div class="block">Return number of records in current record set.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>number of records in current record set.</dd> +</dl> +</li> +</ul> +<a name="getNumBytes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumBytes</h4> +<pre>int getNumBytes()</pre> +<div class="block">Return number of bytes in current record set.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>number of bytes in current record set.</dd> +</dl> +</li> +</ul> +<a name="getBuffer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBuffer</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> getBuffer()</pre> +<div class="block">Get the buffer to transmit.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the buffer to transmit.</dd> +</dl> +</li> +</ul> +<a name="completeTransmit-long-long-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>completeTransmit</h4> +<pre>void completeTransmit(long lssn, + long entryId, + long startSlotId)</pre> +<div class="block">Complete transmit.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>lssn</code> - log segment sequence number</dd> +<dd><code>entryId</code> - entry id</dd> +<dd><code>startSlotId</code> - start slot id</dd> +</dl> +</li> +</ul> +<a name="abortTransmit-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>abortTransmit</h4> +<pre>void abortTransmit(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> reason)</pre> +<div class="block">Abort transmit.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>reason</code> - reason to abort.</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/LogRecordSetBuffer.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/LogRecordSet.Writer.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/LogRecordWithDLSN.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/LogRecordSetBuffer.html" target="_top">Frames</a></li> +<li><a href="LogRecordSetBuffer.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>