http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/client/DistributedLogClientImpl.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/client/DistributedLogClientImpl.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/client/DistributedLogClientImpl.html new file mode 100644 index 0000000..b409522 --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/client/DistributedLogClientImpl.html @@ -0,0 +1,736 @@ +<!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:06 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DistributedLogClientImpl (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="DistributedLogClientImpl (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,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":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/DistributedLogClientImpl.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/client/ClientConfig.html" title="class in org.apache.distributedlog.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.html" title="class in org.apache.distributedlog.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/distributedlog/client/DistributedLogClientImpl.html" target="_top">Frames</a></li> +<li><a href="DistributedLogClientImpl.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.distributedlog.client</div> +<h2 title="Class DistributedLogClientImpl" class="title">Class DistributedLogClientImpl</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.client.DistributedLogClientImpl</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html" title="interface in org.apache.distributedlog.client.monitor">MonitorServiceClient</a>, <a href="../../../../org/apache/distributedlog/client/proxy/HostProvider.html" title="interface in org.apache.distributedlog.client.proxy">HostProvider</a>, <a href="../../../../org/apache/distributedlog/client/proxy/ProxyListener.html" title="interface in org.apache.distributedlog.client.proxy">ProxyListener</a>, <a href="../../../../org/apache/distributedlog/client/routing/RoutingService.RoutingListener.html" title="interface in org.apache.distributedlog.client.routing">RoutingService.RoutingListener</a>, <a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DistributedLogClientImpl</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> +implements <a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a>, <a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html" title="interface in org.apache.distributedlog.client.monitor">MonitorServiceClient</a>, <a href="../../../../org/apache/distributedlog/client/routing/RoutingService.RoutingListener.html" title="interface in org.apache.distributedlog.client.routing">RoutingService.RoutingListener</a>, <a href="../../../../org/apache/distributedlog/client/proxy/ProxyListener.html" title="interface in org.apache.distributedlog.client.proxy">ProxyListener</a>, <a href="../../../../org/apache/distributedlog/client/proxy/HostProvider.html" title="interface in org.apache.distributedlog.client.proxy">HostProvider</a></pre> +<div class="block">Implementation of distributedlog client.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#DistributedLogClientImpl-java.lang.String-com.twitter.finagle.thrift.ClientId-org.apache.distributedlog.client.routing.RoutingService-com.twitter.finagle.builder.ClientBuilder-org.apache.distributedlog.client.ClientConfig-com.google.common.base.Optional-com.twitter.finagle.stats.StatsReceiver-com.twitter.finagle.stats.StatsReceiver-org.apache.distributedlog.client.resolver.RegionResolver-boolean-">DistributedLogClientImpl</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> name, + com.twitter.finagle.thrift.ClientId clientId, + <a href="../../../../org/apache/distributedlog/client/routing/RoutingService.html" title="interface in org.apache.distributedlog.client.routing">RoutingService</a> routingService, + com.twitter.finagle.builder.ClientBuilder clientBuilder, + <a href="../../../../org/apache/distributedlog/client/ClientConfig.html" title="class in org.apache.distributedlog.client">ClientConfig</a> clientConfig, + com.google.common.base.Optional<<a href="../../../../org/apache/distributedlog/client/proxy/ClusterClient.html" title="class in org.apache.distributedlog.client.proxy">ClusterClient</a>> clusterClient, + com.twitter.finagle.stats.StatsReceiver statsReceiver, + com.twitter.finagle.stats.StatsReceiver streamStatsReceiver, + <a href="../../../../org/apache/distributedlog/client/resolver/RegionResolver.html" title="interface in org.apache.distributedlog.client.resolver">RegionResolver</a> regionResolver, + boolean enableRegionStats)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#check-java.lang.String-">check</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> stream)</code> +<div class="block">Check a given stream.</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/client/DistributedLogClientImpl.html#close--">close</a></span>()</code> +<div class="block">Close the client.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#create-java.lang.String-">create</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> stream)</code> +<div class="block">Create a stream with name <i>stream</i>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#delete-java.lang.String-">delete</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> stream)</code> +<div class="block">Delete a given stream <i>stream</i>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#getHosts--">getHosts</a></span>()</code> +<div class="block">Get the list of hosts for handshaking.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<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/client/DistributedLogClientImpl.html#getStreamOwnershipDistribution--">getStreamOwnershipDistribution</a></span>()</code> +<div class="block">Get current ownership distribution from current monitor service view.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#handshake--">handshake</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#heartbeat-java.lang.String-">heartbeat</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> stream)</code> +<div class="block">Send heartbeat to the stream and its readers.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#onHandshakeFailure-java.net.SocketAddress-org.apache.distributedlog.client.proxy.ProxyClient-java.lang.Throwable-">onHandshakeFailure</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a> address, + <a href="../../../../org/apache/distributedlog/client/proxy/ProxyClient.html" title="class in org.apache.distributedlog.client.proxy">ProxyClient</a> client, + <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> cause)</code> +<div class="block">Failed to handshake with a proxy.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#onHandshakeSuccess-java.net.SocketAddress-org.apache.distributedlog.client.proxy.ProxyClient-org.apache.distributedlog.thrift.service.ServerInfo-">onHandshakeSuccess</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a> address, + <a href="../../../../org/apache/distributedlog/client/proxy/ProxyClient.html" title="class in org.apache.distributedlog.client.proxy">ProxyClient</a> client, + org.apache.distributedlog.thrift.service.ServerInfo serverInfo)</code> +<div class="block">When a proxy's server info changed, it would be notified.</div> +</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/client/DistributedLogClientImpl.html#onServerJoin-java.net.SocketAddress-">onServerJoin</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a> address)</code> +<div class="block">Trigger when server joint.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#onServerLeft-java.net.SocketAddress-">onServerLeft</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a> address)</code> +<div class="block">Trigger when server left.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#release-java.lang.String-">release</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> stream)</code> +<div class="block">Release the ownership of a stream <i>stream</i>.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#setAcceptNewStream-boolean-">setAcceptNewStream</a></span>(boolean enabled)</code> +<div class="block">Enable/Disable accepting new stream on a given proxy.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogClientImpl.html#truncate-java.lang.String-org.apache.distributedlog.DLSN-">truncate</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> stream, + <a href="../../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> dlsn)</code> +<div class="block">Truncate the stream to a given <i>dlsn</i>.</div> +</td> +</tr> +<tr id="i15" 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/client/DistributedLogClientImpl.html#write-java.lang.String-java.nio.ByteBuffer-">write</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> stream, + <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> data)</code> +<div class="block">Write <i>data</i> to a given <i>stream</i>.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><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/client/DistributedLogClientImpl.html#writeBulk-java.lang.String-java.util.List-">writeBulk</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> stream, + <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="http://download.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a>> data)</code> +<div class="block">Write <i>data</i> in bulk to a given <i>stream</i>.</div> +</td> +</tr> +<tr id="i17" 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/client/DistributedLogClientImpl.html#writeRecordSet-java.lang.String-org.apache.distributedlog.LogRecordSetBuffer-">writeRecordSet</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> stream, + <a href="../../../../org/apache/distributedlog/LogRecordSetBuffer.html" title="interface in org.apache.distributedlog">LogRecordSetBuffer</a> recordSet)</code> +<div class="block">Write record set to a given <i>stream</i>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DistributedLogClientImpl-java.lang.String-com.twitter.finagle.thrift.ClientId-org.apache.distributedlog.client.routing.RoutingService-com.twitter.finagle.builder.ClientBuilder-org.apache.distributedlog.client.ClientConfig-com.google.common.base.Optional-com.twitter.finagle.stats.StatsReceiver-com.twitter.finagle.stats.StatsReceiver-org.apache.distributedlog.client.resolver.RegionResolver-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DistributedLogClientImpl</h4> +<pre>public DistributedLogClientImpl(<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> name, + com.twitter.finagle.thrift.ClientId clientId, + <a href="../../../../org/apache/distributedlog/client/routing/RoutingService.html" title="interface in org.apache.distributedlog.client.routing">RoutingService</a> routingService, + com.twitter.finagle.builder.ClientBuilder clientBuilder, + <a href="../../../../org/apache/distributedlog/client/ClientConfig.html" title="class in org.apache.distributedlog.client">ClientConfig</a> clientConfig, + com.google.common.base.Optional<<a href="../../../../org/apache/distributedlog/client/proxy/ClusterClient.html" title="class in org.apache.distributedlog.client.proxy">ClusterClient</a>> clusterClient, + com.twitter.finagle.stats.StatsReceiver statsReceiver, + com.twitter.finagle.stats.StatsReceiver streamStatsReceiver, + <a href="../../../../org/apache/distributedlog/client/resolver/RegionResolver.html" title="interface in org.apache.distributedlog.client.resolver">RegionResolver</a> regionResolver, + boolean enableRegionStats)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getHosts--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHosts</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a>> getHosts()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/proxy/HostProvider.html#getHosts--">HostProvider</a></code></span></div> +<div class="block">Get the list of hosts for handshaking.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/proxy/HostProvider.html#getHosts--">getHosts</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/proxy/HostProvider.html" title="interface in org.apache.distributedlog.client.proxy">HostProvider</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>list of hosts for handshaking.</dd> +</dl> +</li> +</ul> +<a name="onHandshakeSuccess-java.net.SocketAddress-org.apache.distributedlog.client.proxy.ProxyClient-org.apache.distributedlog.thrift.service.ServerInfo-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onHandshakeSuccess</h4> +<pre>public void onHandshakeSuccess(<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a> address, + <a href="../../../../org/apache/distributedlog/client/proxy/ProxyClient.html" title="class in org.apache.distributedlog.client.proxy">ProxyClient</a> client, + org.apache.distributedlog.thrift.service.ServerInfo serverInfo)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/proxy/ProxyListener.html#onHandshakeSuccess-java.net.SocketAddress-org.apache.distributedlog.client.proxy.ProxyClient-org.apache.distributedlog.thrift.service.ServerInfo-">ProxyListener</a></code></span></div> +<div class="block">When a proxy's server info changed, it would be notified.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/proxy/ProxyListener.html#onHandshakeSuccess-java.net.SocketAddress-org.apache.distributedlog.client.proxy.ProxyClient-org.apache.distributedlog.thrift.service.ServerInfo-">onHandshakeSuccess</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/proxy/ProxyListener.html" title="interface in org.apache.distributedlog.client.proxy">ProxyListener</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>address</code> - proxy address</dd> +<dd><code>client</code> - proxy client that executes handshaking</dd> +<dd><code>serverInfo</code> - proxy's server info</dd> +</dl> +</li> +</ul> +<a name="onHandshakeFailure-java.net.SocketAddress-org.apache.distributedlog.client.proxy.ProxyClient-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onHandshakeFailure</h4> +<pre>public void onHandshakeFailure(<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a> address, + <a href="../../../../org/apache/distributedlog/client/proxy/ProxyClient.html" title="class in org.apache.distributedlog.client.proxy">ProxyClient</a> client, + <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> cause)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/proxy/ProxyListener.html#onHandshakeFailure-java.net.SocketAddress-org.apache.distributedlog.client.proxy.ProxyClient-java.lang.Throwable-">ProxyListener</a></code></span></div> +<div class="block">Failed to handshake with a proxy.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/proxy/ProxyListener.html#onHandshakeFailure-java.net.SocketAddress-org.apache.distributedlog.client.proxy.ProxyClient-java.lang.Throwable-">onHandshakeFailure</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/proxy/ProxyListener.html" title="interface in org.apache.distributedlog.client.proxy">ProxyListener</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>address</code> - proxy address</dd> +<dd><code>client</code> - proxy client</dd> +<dd><code>cause</code> - failure reason</dd> +</dl> +</li> +</ul> +<a name="handshake--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handshake</h4> +<pre>public void handshake()</pre> +</li> +</ul> +<a name="onServerLeft-java.net.SocketAddress-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onServerLeft</h4> +<pre>public void onServerLeft(<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a> address)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/routing/RoutingService.RoutingListener.html#onServerLeft-java.net.SocketAddress-">RoutingService.RoutingListener</a></code></span></div> +<div class="block">Trigger when server left.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/routing/RoutingService.RoutingListener.html#onServerLeft-java.net.SocketAddress-">onServerLeft</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/routing/RoutingService.RoutingListener.html" title="interface in org.apache.distributedlog.client.routing">RoutingService.RoutingListener</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>address</code> - left server.</dd> +</dl> +</li> +</ul> +<a name="onServerJoin-java.net.SocketAddress-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onServerJoin</h4> +<pre>public void onServerJoin(<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a> address)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/routing/RoutingService.RoutingListener.html#onServerJoin-java.net.SocketAddress-">RoutingService.RoutingListener</a></code></span></div> +<div class="block">Trigger when server joint.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/routing/RoutingService.RoutingListener.html#onServerJoin-java.net.SocketAddress-">onServerJoin</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/routing/RoutingService.RoutingListener.html" title="interface in org.apache.distributedlog.client.routing">RoutingService.RoutingListener</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>address</code> - joint server.</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#close--">DistributedLogClient</a></code></span></div> +<div class="block">Close the client.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#close--">close</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html" title="interface in org.apache.distributedlog.client.monitor">MonitorServiceClient</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#close--">close</a></code> in interface <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></code></dd> +</dl> +</li> +</ul> +<a name="check-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>check</h4> +<pre>public com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> check(<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> stream)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#check-java.lang.String-">MonitorServiceClient</a></code></span></div> +<div class="block">Check a given stream.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#check-java.lang.String-">check</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html" title="interface in org.apache.distributedlog.client.monitor">MonitorServiceClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - stream.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>check result.</dd> +</dl> +</li> +</ul> +<a name="heartbeat-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>heartbeat</h4> +<pre>public com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> heartbeat(<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> stream)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#heartbeat-java.lang.String-">MonitorServiceClient</a></code></span></div> +<div class="block">Send heartbeat to the stream and its readers.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#heartbeat-java.lang.String-">heartbeat</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html" title="interface in org.apache.distributedlog.client.monitor">MonitorServiceClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - stream.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>check result.</dd> +</dl> +</li> +</ul> +<a name="getStreamOwnershipDistribution--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStreamOwnershipDistribution</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://download.oracle.com/javase/6/docs/api/java/net/SocketAddress.html?is-external=true"; title="class or interface in java.net">SocketAddress</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<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>>> getStreamOwnershipDistribution()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#getStreamOwnershipDistribution--">MonitorServiceClient</a></code></span></div> +<div class="block">Get current ownership distribution from current monitor service view.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#getStreamOwnershipDistribution--">getStreamOwnershipDistribution</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html" title="interface in org.apache.distributedlog.client.monitor">MonitorServiceClient</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>current ownership distribution</dd> +</dl> +</li> +</ul> +<a name="setAcceptNewStream-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAcceptNewStream</h4> +<pre>public com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> setAcceptNewStream(boolean enabled)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#setAcceptNewStream-boolean-">MonitorServiceClient</a></code></span></div> +<div class="block">Enable/Disable accepting new stream on a given proxy.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html#setAcceptNewStream-boolean-">setAcceptNewStream</a></code> in interface <code><a href="../../../../org/apache/distributedlog/client/monitor/MonitorServiceClient.html" title="interface in org.apache.distributedlog.client.monitor">MonitorServiceClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>enabled</code> - flag to enable/disable accepting new streams on a given proxy</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>void</dd> +</dl> +</li> +</ul> +<a name="write-java.lang.String-java.nio.ByteBuffer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public com.twitter.util.Future<<a href="../../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>> write(<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> stream, + <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> data)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#write-java.lang.String-java.nio.ByteBuffer-">DistributedLogClient</a></code></span></div> +<div class="block">Write <i>data</i> to a given <i>stream</i>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#write-java.lang.String-java.nio.ByteBuffer-">write</a></code> in interface <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream Name.</dd> +<dd><code>data</code> - Data to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a future representing a sequence id returned for this write.</dd> +</dl> +</li> +</ul> +<a name="writeRecordSet-java.lang.String-org.apache.distributedlog.LogRecordSetBuffer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeRecordSet</h4> +<pre>public com.twitter.util.Future<<a href="../../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>> writeRecordSet(<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> stream, + <a href="../../../../org/apache/distributedlog/LogRecordSetBuffer.html" title="interface in org.apache.distributedlog">LogRecordSetBuffer</a> recordSet)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#writeRecordSet-java.lang.String-org.apache.distributedlog.LogRecordSetBuffer-">DistributedLogClient</a></code></span></div> +<div class="block">Write record set to a given <i>stream</i>. + + <p>The record set is built from <a href="../../../../org/apache/distributedlog/LogRecordSet.Writer.html" title="interface in org.apache.distributedlog"><code>LogRecordSet.Writer</code></a></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#writeRecordSet-java.lang.String-org.apache.distributedlog.LogRecordSetBuffer-">writeRecordSet</a></code> in interface <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - stream to write to</dd> +<dd><code>recordSet</code> - record set</dd> +</dl> +</li> +</ul> +<a name="writeBulk-java.lang.String-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeBulk</h4> +<pre>public <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><com.twitter.util.Future<<a href="../../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a>>> writeBulk(<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> stream, + <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="http://download.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html?is-external=true"; title="class or interface in java.nio">ByteBuffer</a>> data)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#writeBulk-java.lang.String-java.util.List-">DistributedLogClient</a></code></span></div> +<div class="block">Write <i>data</i> in bulk to a given <i>stream</i>. + + <p>Return a list of Future dlsns, one for each submitted buffer. In the event of a partial + failure--ex. some specific buffer write fails, all subsequent writes + will also fail.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#writeBulk-java.lang.String-java.util.List-">writeBulk</a></code> in interface <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream Name.</dd> +<dd><code>data</code> - Data to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a list of futures, one for each submitted buffer.</dd> +</dl> +</li> +</ul> +<a name="truncate-java.lang.String-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>truncate</h4> +<pre>public com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a>> truncate(<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> stream, + <a href="../../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> dlsn)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#truncate-java.lang.String-org.apache.distributedlog.DLSN-">DistributedLogClient</a></code></span></div> +<div class="block">Truncate the stream to a given <i>dlsn</i>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#truncate-java.lang.String-org.apache.distributedlog.DLSN-">truncate</a></code> in interface <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream Name.</dd> +<dd><code>dlsn</code> - DLSN to truncate until.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a future representing the truncation.</dd> +</dl> +</li> +</ul> +<a name="delete-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>public com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> delete(<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> stream)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#delete-java.lang.String-">DistributedLogClient</a></code></span></div> +<div class="block">Delete a given stream <i>stream</i>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#delete-java.lang.String-">delete</a></code> in interface <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream Name to delete.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a future representing the delete operation.</dd> +</dl> +</li> +</ul> +<a name="release-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>release</h4> +<pre>public com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> release(<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> stream)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#release-java.lang.String-">DistributedLogClient</a></code></span></div> +<div class="block">Release the ownership of a stream <i>stream</i>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#release-java.lang.String-">release</a></code> in interface <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream Name to release.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a future representing the release operation.</dd> +</dl> +</li> +</ul> +<a name="create-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre>public com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> create(<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> stream)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#create-java.lang.String-">DistributedLogClient</a></code></span></div> +<div class="block">Create a stream with name <i>stream</i>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html#create-java.lang.String-">create</a></code> in interface <code><a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream Name to create.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a future representing the create operation.</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/DistributedLogClientImpl.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/client/ClientConfig.html" title="class in org.apache.distributedlog.client"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.html" title="class in org.apache.distributedlog.client"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/distributedlog/client/DistributedLogClientImpl.html" target="_top">Frames</a></li> +<li><a href="DistributedLogClientImpl.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016-2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html new file mode 100644 index 0000000..2c8a2a9 --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html @@ -0,0 +1,544 @@ +<!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:06 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DistributedLogMultiStreamWriter.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="DistributedLogMultiStreamWriter.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,"i11":10,"i12":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/DistributedLogMultiStreamWriter.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/client/DistributedLogMultiStreamWriter.html" title="class in org.apache.distributedlog.client"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" target="_top">Frames</a></li> +<li><a href="DistributedLogMultiStreamWriter.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.client</div> +<h2 title="Class DistributedLogMultiStreamWriter.Builder" class="title">Class DistributedLogMultiStreamWriter.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.client.DistributedLogMultiStreamWriter.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/client/DistributedLogMultiStreamWriter.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">DistributedLogMultiStreamWriter.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">Builder for the multi stream writer.</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/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#bufferSize-int-">bufferSize</a></span>(int bufferSize)</code> +<div class="block">Set the output buffer size.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#build--">build</a></span>()</code> +<div class="block">Build the multi stream writer.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#client-org.apache.distributedlog.service.DistributedLogClient-">client</a></span>(<a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a> client)</code> +<div class="block">Set the distributedlog client used for multi stream writer.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#clockTicker-com.google.common.base.Ticker-">clockTicker</a></span>(com.google.common.base.Ticker ticker)</code> +<div class="block">Ticker for timing.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#compressionCodec-org.apache.distributedlog.io.CompressionCodec.Type-">compressionCodec</a></span>(<a href="../../../../org/apache/distributedlog/io/CompressionCodec.Type.html" title="enum in org.apache.distributedlog.io">CompressionCodec.Type</a> codec)</code> +<div class="block">Set compression codec.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#firstSpeculativeTimeoutMs-int-">firstSpeculativeTimeoutMs</a></span>(int timeoutMs)</code> +<div class="block">Set the first speculative timeout in milliseconds.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#flushIntervalMicros-int-">flushIntervalMicros</a></span>(int flushIntervalMicros)</code> +<div class="block">Set the flush interval in microseconds.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#flushIntervalMs-int-">flushIntervalMs</a></span>(int flushIntervalMs)</code> +<div class="block">Set the flush interval in milliseconds.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#maxSpeculativeTimeoutMs-int-">maxSpeculativeTimeoutMs</a></span>(int timeoutMs)</code> +<div class="block">Set the max speculative timeout in milliseconds.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#requestTimeoutMs-long-">requestTimeoutMs</a></span>(long requestTimeoutMs)</code> +<div class="block">Set request timeout in milliseconds.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#scheduler-java.util.concurrent.ScheduledExecutorService-">scheduler</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ScheduledExecutorService</a> executorService)</code> +<div class="block">Set the scheduler to flush output buffers.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#speculativeBackoffMultiplier-float-">speculativeBackoffMultiplier</a></span>(float multiplier)</code> +<div class="block">Set the speculative timeout backoff multiplier.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#streams-java.util.List-">streams</a></span>(<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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> streams)</code> +<div class="block">Set the list of streams to write to.</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="client-org.apache.distributedlog.service.DistributedLogClient-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>client</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> client(<a href="../../../../org/apache/distributedlog/service/DistributedLogClient.html" title="interface in org.apache.distributedlog.service">DistributedLogClient</a> client)</pre> +<div class="block">Set the distributedlog client used for multi stream writer.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>client</code> - distributedlog client</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="streams-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>streams</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> streams(<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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> streams)</pre> +<div class="block">Set the list of streams to write to.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>streams</code> - list of streams to write</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="bufferSize-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bufferSize</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> bufferSize(int bufferSize)</pre> +<div class="block">Set the output buffer size. + + <p>If output buffer size is 0, the writes will be transmitted to + wire immediately.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bufferSize</code> - output buffer size</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="flushIntervalMs-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flushIntervalMs</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> flushIntervalMs(int flushIntervalMs)</pre> +<div class="block">Set the flush interval in milliseconds.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>flushIntervalMs</code> - flush interval in milliseconds.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="flushIntervalMicros-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flushIntervalMicros</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> flushIntervalMicros(int flushIntervalMicros)</pre> +<div class="block">Set the flush interval in microseconds.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>flushIntervalMicros</code> - flush interval in microseconds.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="compressionCodec-org.apache.distributedlog.io.CompressionCodec.Type-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compressionCodec</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> compressionCodec(<a href="../../../../org/apache/distributedlog/io/CompressionCodec.Type.html" title="enum in org.apache.distributedlog.io">CompressionCodec.Type</a> codec)</pre> +<div class="block">Set compression codec.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>codec</code> - compression codec.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="scheduler-java.util.concurrent.ScheduledExecutorService-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scheduler</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> scheduler(<a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ScheduledExecutorService</a> executorService)</pre> +<div class="block">Set the scheduler to flush output buffers.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>executorService</code> - executor service to flush output buffers.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="requestTimeoutMs-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requestTimeoutMs</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> requestTimeoutMs(long requestTimeoutMs)</pre> +<div class="block">Set request timeout in milliseconds.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>requestTimeoutMs</code> - request timeout in milliseconds.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="firstSpeculativeTimeoutMs-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>firstSpeculativeTimeoutMs</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> firstSpeculativeTimeoutMs(int timeoutMs)</pre> +<div class="block">Set the first speculative timeout in milliseconds. + + <p>The multi-streams writer does speculative writes on streams. + The write issues first write request to a stream, if the write request + doesn't respond within speculative timeout. it issues next write request + to a different stream. It does such speculative retries until receive + a success or request timeout (<a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#requestTimeoutMs-long-"><code>requestTimeoutMs(long)</code></a>). + + <p>This setting is to configure the first speculative timeout, in milliseconds.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>timeoutMs</code> - timeout in milliseconds</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="maxSpeculativeTimeoutMs-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>maxSpeculativeTimeoutMs</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> maxSpeculativeTimeoutMs(int timeoutMs)</pre> +<div class="block">Set the max speculative timeout in milliseconds. + + <p>The multi-streams writer does speculative writes on streams. + The write issues first write request to a stream, if the write request + doesn't respond within speculative timeout. it issues next write request + to a different stream. It does such speculative retries until receive + a success or request timeout (<a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#requestTimeoutMs-long-"><code>requestTimeoutMs(long)</code></a>). + + <p>This setting is to configure the max speculative timeout, in milliseconds.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>timeoutMs</code> - timeout in milliseconds</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="speculativeBackoffMultiplier-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>speculativeBackoffMultiplier</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> speculativeBackoffMultiplier(float multiplier)</pre> +<div class="block">Set the speculative timeout backoff multiplier. + + <p>The multi-streams writer does speculative writes on streams. + The write issues first write request to a stream, if the write request + doesn't respond within speculative timeout. it issues next write request + to a different stream. It does such speculative retries until receive + a success or request timeout (<a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html#requestTimeoutMs-long-"><code>requestTimeoutMs(long)</code></a>). + + <p>This setting is to configure the speculative timeout backoff multiplier.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>multiplier</code> - backoff multiplier</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +</dl> +</li> +</ul> +<a name="clockTicker-com.google.common.base.Ticker-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clockTicker</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter.Builder</a> clockTicker(com.google.common.base.Ticker ticker)</pre> +<div class="block">Ticker for timing.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ticker</code> - ticker</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>builder</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Ticker</code></dd> +</dl> +</li> +</ul> +<a name="build--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../org/apache/distributedlog/client/DistributedLogMultiStreamWriter.html" title="class in org.apache.distributedlog.client">DistributedLogMultiStreamWriter</a> build()</pre> +<div class="block">Build the multi stream writer.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the multi stream writer.</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/DistributedLogMultiStreamWriter.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/client/DistributedLogMultiStreamWriter.html" title="class in org.apache.distributedlog.client"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/distributedlog/client/DistributedLogMultiStreamWriter.Builder.html" target="_top">Frames</a></li> +<li><a href="DistributedLogMultiStreamWriter.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>
