http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1bd00e9a/api/main.html ---------------------------------------------------------------------- diff --git a/api/main.html b/api/main.html deleted file mode 100644 index 5e727c9..0000000 --- a/api/main.html +++ /dev/null @@ -1,545 +0,0 @@ -<!DOCTYPE html> - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - - <title>API — DistributedLog 1.0 documentation</title> - - <link rel="stylesheet" href="../_static/override.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap-theme.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/featherlight.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/docbird.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/docbird-xs.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/jquery.rateyo.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/selection-sharer.css" type="text/css" /> - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: '../', - VERSION: '1.0', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true - }; - </script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/bootstrap-3.1.0/js/bootstrap.min.js"></script> - <script type="text/javascript" src="../_static/js/bootstrap-docbird.js"></script> - <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script> - <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> - <script type="text/javascript" src="../_static/js/featherlight.min.js"></script> - <script type="text/javascript" src="../_static/js/ifvisible.js"></script> - <script type="text/javascript" src="../_static/js/timeme.js"></script> - <script type="text/javascript" src="../_static/js/jquery.rateyo.min.js"></script> - <script type="text/javascript" src="../_static/js/js.cookie.js"></script> - <link rel="shortcut icon" href="../_static/docbird.ico"/> - <link rel="top" title="DistributedLog 1.0 documentation" href="../index.html" /> - <link rel="next" title="Core Library API" href="core.html" /> - <link rel="prev" title="Quick Start" href="../basics/quickstart.html" /> -<meta charset='utf-8'> -<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> -<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> -<meta name="apple-mobile-web-app-capable" content="yes"> - -<meta property="docbird:project" content="DistributedLog" /> - - </head> - <body> -<div class="navbar navbar-default navbar-fixed-top" role="navigation"> - <div class="container-fluid"> - <div class="row db-header"> - <div class="col-sm-3 col-md-3 col-lg-3 hidden-xs db-header-controls"> - <a href="/" alt="Back to Docbird"> - <div class="db-home-button"> - <span class="glyphicon glyphicon-home"></span> - </div> -</a> - -<form action="../search.html" method="get" class="db-searchbox-form"> - <div class="form-group"> - <input type="text" name="q" class="form-control db-searchbox-input" placeholder="Search DistributedLog" /> - </div> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> -</form> - - </div> - <div class="col-sm-7 col-md-7 col-lg-7 col-xs-12 db-header-info"> - <div class="visible-xs"> - <a href="/" alt="Back to Docbird"> - <div class="db-home-button"> - <span class="glyphicon glyphicon-home"></span> - </div> -</a> - </div> - <div class="visible-xs db-xs-menu-button"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#db-xs-menu"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> -</div> - </div> - <div class="db-header-projectname"> - <h1><a href="../index.html">DistributedLog</a></h1> - </div> - </div> - </div> - <div class="row db-xs-menu hidden-sm hidden-md hidden-lg - collapse" id="db-xs-menu"> - -<form action="../search.html" method="get" class="db-searchbox-form"> - <div class="form-group"> - <input type="text" name="q" class="form-control db-searchbox-input" placeholder="Search DistributedLog" /> - </div> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> -</form> - - <div class="db-toc" role="complementary"> - <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../download.html">Releases</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc1">0.3.51-RC1</a></li> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc0">0.3.51-RC0</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../basics/main.html">Getting Started</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../basics/introduction.html">Introduction</a></li> -<li class="toctree-l2"><a class="reference internal" href="../basics/quickstart.html">Quick Start</a></li> -</ul> -</li> -<li class="toctree-l1 current"><a class="current reference internal" href="">API</a><ul> -<li class="toctree-l2"><a class="reference internal" href="core.html">Core Library API</a></li> -<li class="toctree-l2"><a class="reference internal" href="proxy.html">Write Proxy Client API</a></li> -<li class="toctree-l2"><a class="reference internal" href="practice.html">Best Practices</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../configuration/main.html">Configuration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../configuration/core.html">Core Library Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/proxy.html">Write Proxy Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/client.html">Client Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/perlog.html">Per Stream Configuration</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../considerations/main.html">Considerations</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#partitioning">Partitioning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#processing-semantics">Processing Semantics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../architecture/main.html">Architecture</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#data-model">Data Model</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#software-stack">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../design/main.html">Detail Design</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#consistency">Consistency</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#streaming-reads">Streaming Reads</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../globalreplicatedlog/main.html">Global Replicated Log</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../implementation/main.html">Implementation</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../implementation/storage.html">Storage</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../operations/main.html">Deployment & Administration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../operations/deployment.html">Cluster Setup & Deployment</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/operations.html">DistributedLog Operations</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/performance.html">Performance Tuning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/hardware.html">Hardware</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/monitoring.html">Monitoring</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/zookeeper.html">ZooKeeper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/bookkeeper.html">BookKeeper</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../performance/main.html">Performance</a></li> -<li class="toctree-l1"><a class="reference internal" href="../references/main.html">References</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../references/configuration.html">Configuration Settings</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/metrics.html">Metrics</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/features.html">Features</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../tutorials/main.html">Tutorials</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#basic">Basic</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#messaging">Messaging</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#analytics">Analytics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../developer/main.html">Developer</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../developer/release.html">Release</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> -</ul> - - </div> - </div> - </div> -</div> -<div class="container"> - <div class="row"> - <div style="z-index: 1" class="col-xs-12 col-sm-12 col-md-12 col-lg-12"> - <style> - .overflow-container { - display: none; - } - .overflow-toggle { - text-decoration: none; - border-bottom: none; - border-radius: 4px; - border: 1px solid #eee; - padding: 1px 3px 3px; - color: #888; - font-weight: normal; - background-color: linen; - line-height: 1.85em; - cursor: pointer; - } - .overflow-toggle:hover { - color: #333; - border-color: #ccc; - background-color: beige; - } -</style> -<script> -$(function(){ - $('.overflow-toggle').on('click', function(){ - $(this).next().toggle(); - }); -}); -</script> -<div class="db-project-header-container"> - <div class="row"> - - <div class="db-project-info col-lg-12 col-md-12 col-sm-12 col-xs-12"> - <h1> - <a href="../index.html">DistributedLog</a> - - </h1> - - <div class="db-code-link"> - <a href="[email protected]:twitter/distributedlog.git/tree/master/" target="_blank">[email protected]:twitter/distributedlog.git/tree/master/</a> - </div> - - - </div> - </div> - - <div class="row db-project-links-row"> - <div class=" col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <div class="db-hashtag-container"> - - <span class="db-project-link-label">OWNERS</span> - - <em>None</em> - - - </div> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <div class="db-hashtag-container"> - - <span class="db-project-link-label">TAGS</span> - - <em><a class="db-hashtag" href="/?q=tags:%23uses_maven">#uses_maven</a></em> - - - </div> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <span class="db-project-link-label">HEALTH</span> - - <h3 style="margin-top: 0"> -<!-- <a href="/techdocs/checklist.html" class="label label-success">--> - <a href="/report/distributedlog" class=""> - 9.0 / 10 - <span style="margin-left: .25em" class="glyphicon glyphicon-ok"></span> - </a> - - </h3> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <span class="db-project-link-label">RATING</span> - <div id="rateYo"></div> - </div> - </div> - -</div> - </div> - <div class="col-xs-12 col-sm-8 col-md-8 col-lg-8"> - <div class="db-content-body"> - - <div class="section" id="api"> -<h1>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h1> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="core.html">Core Library API</a></li> -<li class="toctree-l1"><a class="reference internal" href="proxy.html">Write Proxy Client API</a></li> -<li class="toctree-l1"><a class="reference internal" href="practice.html">Best Practices</a></li> -</ul> -</div> -</div> - - - </div> - </div> - <div class="hidden-xs col-sm-3 col-md-3 col-md-offset-1 col-lg-3 db-sidebar"> - - <div class="db-toc" role="complementary"> - <ul class="current"> - <li class="toctree-l0 current"><a class="current reference internal" href="../index.html">DistributedLog</a></li> - </ul> - <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../download.html">Releases</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc1">0.3.51-RC1</a></li> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc0">0.3.51-RC0</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../basics/main.html">Getting Started</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../basics/introduction.html">Introduction</a></li> -<li class="toctree-l2"><a class="reference internal" href="../basics/quickstart.html">Quick Start</a></li> -</ul> -</li> -<li class="toctree-l1 current"><a class="current reference internal" href="">API</a><ul> -<li class="toctree-l2"><a class="reference internal" href="core.html">Core Library API</a></li> -<li class="toctree-l2"><a class="reference internal" href="proxy.html">Write Proxy Client API</a></li> -<li class="toctree-l2"><a class="reference internal" href="practice.html">Best Practices</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../configuration/main.html">Configuration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../configuration/core.html">Core Library Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/proxy.html">Write Proxy Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/client.html">Client Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/perlog.html">Per Stream Configuration</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../considerations/main.html">Considerations</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#partitioning">Partitioning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#processing-semantics">Processing Semantics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../architecture/main.html">Architecture</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#data-model">Data Model</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#software-stack">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../design/main.html">Detail Design</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#consistency">Consistency</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#streaming-reads">Streaming Reads</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../globalreplicatedlog/main.html">Global Replicated Log</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../implementation/main.html">Implementation</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../implementation/storage.html">Storage</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../operations/main.html">Deployment & Administration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../operations/deployment.html">Cluster Setup & Deployment</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/operations.html">DistributedLog Operations</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/performance.html">Performance Tuning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/hardware.html">Hardware</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/monitoring.html">Monitoring</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/zookeeper.html">ZooKeeper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/bookkeeper.html">BookKeeper</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../performance/main.html">Performance</a></li> -<li class="toctree-l1"><a class="reference internal" href="../references/main.html">References</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../references/configuration.html">Configuration Settings</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/metrics.html">Metrics</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/features.html">Features</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../tutorials/main.html">Tutorials</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#basic">Basic</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#messaging">Messaging</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#analytics">Analytics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../developer/main.html">Developer</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../developer/release.html">Release</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> -</ul> - - <span id="last"></span> - </div> - - </div> - <!-- <div id="slidebox"> --> - <!-- <button id="slidebox_close" type="button" class="close">×</button> --> - <!-- <p>Rate This Page</p> --> - <!-- <div id="rateYo"></div> --> - <!-- <p>Comment</p> - <input type="text" name="comment"></input> - <button>Submit</button> --> - <!-- </div> --> - </div> -</div> -<footer class="footer"> - <div class="container-fluid"> - <div class="row"> - <div class="col-md-10 col-md-offset-1"> - <p class="pull-right"> - <a href="#">Back to top</a> - - <br/> - -<div id="sourcelink"> - <a href="[email protected]:twitter/distributedlog.git/tree/master/docs/api/main.rst" - rel="nofollow">Source</a> - - <a href="../_sources/api/main.txt" - rel="nofollow">Raw</a> - <a href="../__docbird-build.log" - rel="nofollow">Build Log</a> - <a href="/report/stats/distributedlog:distributedlog" - rel="nofollow">Stats</a> -</div> - </p> - <p> - Built and hosted by <a href="/">DocBird</a>. - </p> - </div> - </div> - </div> -</footer> -<script type="text/javascript" src="../_static/js/docbird.js"></script> -<script type="text/javascript"> - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-30775-8']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); -</script> -<!-- <script type="text/javascript" src="//s/d41d8cd98f00b204e9800998ecf8427e/en_US-tbnx1s-1988229788/6163/97/1.4.3/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?collectorId=e62237fc"></script> ---> - -<script type="text/javascript"> - $(document).ready(function () { - // track user activity time (from https://github.com/jasonzissman/TimeMe.js) - TimeMe.setIdleDurationInSeconds(30); - TimeMe.setCurrentPageName("my-home-page"); - TimeMe.initialize(); - - // record page visit event when user leaves the page - window.onbeforeunload = function (event) { - xmlhttp=new XMLHttpRequest(); - xmlhttp.withCredentials = true; - xmlhttp.open("POST", "/event/distributedlog:distributedlog/visit", false); - xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded"); - var event_data = { - total_time_reading: TimeMe.getTimeOnCurrentPageInSeconds(), - page: window.location.href - }; - //alert("send: " + $.param(event_data)); - xmlhttp.send($.param(event_data)); - }; - - // ask user for page rating after 20 seconds - // setTimeout(function(){ - // alert("Rate this page!"); - // }, 20000); - }); -</script> -<!-- <style> -#slidebox{ - width: 250px; - height: 90px; - padding: 10px; - background-color: #fff; - border: 1px solid #ccc; - position: fixed; - bottom: 3px; - right: -280px; - z-index: 1; -} -#slidebox .close{ - margin-top: -5px; - opacity: 0.5; -} -#slidebox .close:hover{ - opacity: 0.7; -} -</style> --> -<script type="text/javascript"> -$(function() { - // $(window).scroll(function(){ - // var distanceTop = $('#last').offset().top - $(window).height(); - - // if ($(window).scrollTop() > distanceTop) - // $('#slidebox').animate({'right':'3px'},300); - // else - // $('#slidebox').stop(true).animate({'right':'-280px'},100); - // }); - - // $('#slidebox .close').bind('click',function(){ - // $(this).parent().remove(); - // }); - - $("#rateYo").rateYo({ - normalFill: "#A0A0A0", - halfStar: true, - rating: (Cookies.get('docbird.rating.distributedlog.distributedlog') || 0.0) - }).on("rateyo.set", function (e, data) { - var event_data = { - comment: '', // see todo note below - rating: data.rating, - page: window.location.href - }; - Cookies.get('docbird.rating.distributedlog.distributedlog', data.rating) - $.post('/event/distributedlog:distributedlog/rating', event_data) - // xmlhttp=new XMLHttpRequest(); - // xmlhttp.withCredentials = true; - // var event_data = { - // comment: '', // see todo note below - // rating: data.rating, - // page: window.location.href - // }; - // xmlhttp.open("GET", "/event/distributedlog/rating?" + $.param(event_data), false); - // xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded"); - // // todo: implement comment form in rating slide out, - // // and instead of hooking this event, include a submit button, - // // and read the rating with rating() method - - // // alert("send: " + $.param(event_data)); - // xmlhttp.send(); - - }); - -}); -</script> -<script src="_static/js/selection-sharer.js"></script> -<script> -$('.db-content-body').selectionSharer(); -</script> - </body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1bd00e9a/api/practice.html ---------------------------------------------------------------------- diff --git a/api/practice.html b/api/practice.html deleted file mode 100644 index 7be6918..0000000 --- a/api/practice.html +++ /dev/null @@ -1,629 +0,0 @@ -<!DOCTYPE html> - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - - <title>Best Practices — DistributedLog 1.0 documentation</title> - - <link rel="stylesheet" href="../_static/override.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap-theme.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/featherlight.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/docbird.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/docbird-xs.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/jquery.rateyo.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/selection-sharer.css" type="text/css" /> - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: '../', - VERSION: '1.0', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true - }; - </script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/bootstrap-3.1.0/js/bootstrap.min.js"></script> - <script type="text/javascript" src="../_static/js/bootstrap-docbird.js"></script> - <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script> - <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> - <script type="text/javascript" src="../_static/js/featherlight.min.js"></script> - <script type="text/javascript" src="../_static/js/ifvisible.js"></script> - <script type="text/javascript" src="../_static/js/timeme.js"></script> - <script type="text/javascript" src="../_static/js/jquery.rateyo.min.js"></script> - <script type="text/javascript" src="../_static/js/js.cookie.js"></script> - <link rel="shortcut icon" href="../_static/docbird.ico"/> - <link rel="top" title="DistributedLog 1.0 documentation" href="../index.html" /> - <link rel="up" title="API" href="main.html" /> - <link rel="next" title="Configuration" href="../configuration/main.html" /> - <link rel="prev" title="Write Proxy Client API" href="proxy.html" /> -<meta charset='utf-8'> -<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> -<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> -<meta name="apple-mobile-web-app-capable" content="yes"> - -<meta property="docbird:project" content="DistributedLog" /> - - </head> - <body> -<div class="navbar navbar-default navbar-fixed-top" role="navigation"> - <div class="container-fluid"> - <div class="row db-header"> - <div class="col-sm-3 col-md-3 col-lg-3 hidden-xs db-header-controls"> - <a href="/" alt="Back to Docbird"> - <div class="db-home-button"> - <span class="glyphicon glyphicon-home"></span> - </div> -</a> - -<form action="../search.html" method="get" class="db-searchbox-form"> - <div class="form-group"> - <input type="text" name="q" class="form-control db-searchbox-input" placeholder="Search DistributedLog" /> - </div> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> -</form> - - </div> - <div class="col-sm-7 col-md-7 col-lg-7 col-xs-12 db-header-info"> - <div class="visible-xs"> - <a href="/" alt="Back to Docbird"> - <div class="db-home-button"> - <span class="glyphicon glyphicon-home"></span> - </div> -</a> - </div> - <div class="visible-xs db-xs-menu-button"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#db-xs-menu"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> -</div> - </div> - <div class="db-header-projectname"> - <h1><a href="../index.html">DistributedLog</a></h1> - </div> - </div> - </div> - <div class="row db-xs-menu hidden-sm hidden-md hidden-lg - collapse" id="db-xs-menu"> - -<form action="../search.html" method="get" class="db-searchbox-form"> - <div class="form-group"> - <input type="text" name="q" class="form-control db-searchbox-input" placeholder="Search DistributedLog" /> - </div> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> -</form> - - <div class="db-toc" role="complementary"> - <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../download.html">Releases</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc1">0.3.51-RC1</a></li> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc0">0.3.51-RC0</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../basics/main.html">Getting Started</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../basics/introduction.html">Introduction</a></li> -<li class="toctree-l2"><a class="reference internal" href="../basics/quickstart.html">Quick Start</a></li> -</ul> -</li> -<li class="toctree-l1 current"><a class="reference internal" href="main.html">API</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="core.html">Core Library API</a></li> -<li class="toctree-l2"><a class="reference internal" href="proxy.html">Write Proxy Client API</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Best Practices</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../configuration/main.html">Configuration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../configuration/core.html">Core Library Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/proxy.html">Write Proxy Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/client.html">Client Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/perlog.html">Per Stream Configuration</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../considerations/main.html">Considerations</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#partitioning">Partitioning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#processing-semantics">Processing Semantics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../architecture/main.html">Architecture</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#data-model">Data Model</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#software-stack">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../design/main.html">Detail Design</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#consistency">Consistency</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#streaming-reads">Streaming Reads</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../globalreplicatedlog/main.html">Global Replicated Log</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../implementation/main.html">Implementation</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../implementation/storage.html">Storage</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../operations/main.html">Deployment & Administration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../operations/deployment.html">Cluster Setup & Deployment</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/operations.html">DistributedLog Operations</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/performance.html">Performance Tuning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/hardware.html">Hardware</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/monitoring.html">Monitoring</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/zookeeper.html">ZooKeeper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/bookkeeper.html">BookKeeper</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../performance/main.html">Performance</a></li> -<li class="toctree-l1"><a class="reference internal" href="../references/main.html">References</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../references/configuration.html">Configuration Settings</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/metrics.html">Metrics</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/features.html">Features</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../tutorials/main.html">Tutorials</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#basic">Basic</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#messaging">Messaging</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#analytics">Analytics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../developer/main.html">Developer</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../developer/release.html">Release</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> -</ul> - - </div> - </div> - </div> -</div> -<div class="container"> - <div class="row"> - <div style="z-index: 1" class="col-xs-12 col-sm-12 col-md-12 col-lg-12"> - <style> - .overflow-container { - display: none; - } - .overflow-toggle { - text-decoration: none; - border-bottom: none; - border-radius: 4px; - border: 1px solid #eee; - padding: 1px 3px 3px; - color: #888; - font-weight: normal; - background-color: linen; - line-height: 1.85em; - cursor: pointer; - } - .overflow-toggle:hover { - color: #333; - border-color: #ccc; - background-color: beige; - } -</style> -<script> -$(function(){ - $('.overflow-toggle').on('click', function(){ - $(this).next().toggle(); - }); -}); -</script> -<div class="db-project-header-container"> - <div class="row"> - - <div class="db-project-info col-lg-12 col-md-12 col-sm-12 col-xs-12"> - <h1> - <a href="../index.html">DistributedLog</a> - - </h1> - - <div class="db-code-link"> - <a href="[email protected]:twitter/distributedlog.git/tree/master/" target="_blank">[email protected]:twitter/distributedlog.git/tree/master/</a> - </div> - - - </div> - </div> - - <div class="row db-project-links-row"> - <div class=" col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <div class="db-hashtag-container"> - - <span class="db-project-link-label">OWNERS</span> - - <em>None</em> - - - </div> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <div class="db-hashtag-container"> - - <span class="db-project-link-label">TAGS</span> - - <em><a class="db-hashtag" href="/?q=tags:%23uses_maven">#uses_maven</a></em> - - - </div> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <span class="db-project-link-label">HEALTH</span> - - <h3 style="margin-top: 0"> -<!-- <a href="/techdocs/checklist.html" class="label label-success">--> - <a href="/report/distributedlog" class=""> - 9.0 / 10 - <span style="margin-left: .25em" class="glyphicon glyphicon-ok"></span> - </a> - - </h3> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <span class="db-project-link-label">RATING</span> - <div id="rateYo"></div> - </div> - </div> - -</div> - </div> - <div class="col-xs-12 col-sm-8 col-md-8 col-lg-8"> - <div class="db-content-body"> - - <div class="section" id="best-practices"> -<h1>Best Practices<a class="headerlink" href="#best-practices" title="Permalink to this headline">¶</a></h1> -<div class="section" id="write-records-using-fat-client-or-thin-client"> -<h2>Write records using Fat Client or Thin Client<a class="headerlink" href="#write-records-using-fat-client-or-thin-client" title="Permalink to this headline">¶</a></h2> -<p><cite>Fat Client</cite> is the writer in distributedlog core library which talks to ZooKeeper and BookKeeper directly, -while <cite>Thin Client</cite> is the write proxy client which talks to write proxy service.</p> -<p>It is strongly recommended that writing records via <cite>Write Proxy</cite> service rather than using core library directly. -Because using <cite>Thin Client</cite> has following benefits:</p> -<ul class="simple"> -<li><cite>Thin Client</cite> is purely thrift RPC based client. It doesn't talk to zookeeper and bookkeeper directly and less complicated.</li> -<li><cite>Write Proxy</cite> manages ownerships of log writers. <cite>Thin Client</cite> doesn't have to deal with ownerships of log writers.</li> -<li><cite>Thin Client</cite> is more upgrade-friendly than <cite>Fat Client</cite>.</li> -</ul> -<p>The only exception to use distributedlog core library directly is when you application requires:</p> -<ul class="simple"> -<li>Write Ordering. <cite>Write Ordering</cite> means all the writes issued by the writer should be written in a strict order -in the log. <cite>Write Proxy</cite> service could only guarantee <cite>Read Ordering</cite>. <cite>Read Ordering</cite> means the write proxies will write -the write requests in their receiving order and gurantee the data seen by all the readers in same order.</li> -<li>Ownership Management. If the application already has any kind of ownership management, like <cite>master-slave</cite>, it makes more -sense that it uses distributedlog core library directly.</li> -</ul> -</div> -<div class="section" id="how-to-position-reader-by-time"> -<h2>How to position reader by time<a class="headerlink" href="#how-to-position-reader-by-time" title="Permalink to this headline">¶</a></h2> -<p>Sometimes, application wants to read data by time, like read data from 2 hours ago. This could be done by positioning -the reader using <cite>Transaction ID</cite>, if the <cite>Transaction ID</cite> is the timestamp (All the streams produced by <cite>Write Proxy</cite> use -timestamp as <cite>Transaction ID</cite>).</p> -<div class="highlight-python"><pre>DistributedLogManager dlm = ...; - -long timestamp = System.currentTimeMillis(); -long startTxId = timestamp - TimeUnit.MILLISECONDS.convert(2, TimeUnit.HOURS); -AsyncLogReader reader = Await.result(dlm.openAsyncLogReader(startTxId)); -...</pre> -<div style='display:none;' class='raw-code'><pre>DistributedLogManager dlm = ...; - -long timestamp = System.currentTimeMillis(); -long startTxId = timestamp - TimeUnit.MILLISECONDS.convert(2, TimeUnit.HOURS); -AsyncLogReader reader = Await.result(dlm.openAsyncLogReader(startTxId)); -...</pre> -</div></div> -</div> -<div class="section" id="how-to-seal-a-stream"> -<h2>How to seal a stream<a class="headerlink" href="#how-to-seal-a-stream" title="Permalink to this headline">¶</a></h2> -<p>Typically, DistributedLog is used as endless streams. In some use cases, application wants to <cite>seal</cite> the stream. So writers -can't write more data into the log stream and readers could receive notifications about the stream has been sealed.</p> -<p>Write could seal a log stream as below:</p> -<div class="highlight-python"><pre>DistributedLogManager dlm = ...; - -LogWriter writer = dlm.startLogSegmentNonPartitioned; -// writer writes bunch of records -... - -// writer seals the stream -writer.markEndOfStream();</pre> -<div style='display:none;' class='raw-code'><pre>DistributedLogManager dlm = ...; - -LogWriter writer = dlm.startLogSegmentNonPartitioned; -// writer writes bunch of records -... - -// writer seals the stream -writer.markEndOfStream();</pre> -</div></div> -<p>Reader could detect a stream has been sealed as below:</p> -<div class="highlight-python"><pre>DistributedLogManager dlm = ...; - -LogReader reader = dlm.getInputStream(1L); -LogRecord record; -try { - while ((record = reader.readNext(false)) != null) { - // process the record - ... - } -} catch (EndOfStreamException eos) { - // the stream has been sealed - ... -}</pre> -<div style='display:none;' class='raw-code'><pre>DistributedLogManager dlm = ...; - -LogReader reader = dlm.getInputStream(1L); -LogRecord record; -try { - while ((record = reader.readNext(false)) != null) { - // process the record - ... - } -} catch (EndOfStreamException eos) { - // the stream has been sealed - ... -}</pre> -</div></div> -</div> -</div> - - - </div> - </div> - <div class="hidden-xs col-sm-3 col-md-3 col-md-offset-1 col-lg-3 db-sidebar"> - - <div class="db-toc" role="complementary"> - <ul class="current"> - <li class="toctree-l0 current"><a class="current reference internal" href="../index.html">DistributedLog</a></li> - </ul> - <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../download.html">Releases</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc1">0.3.51-RC1</a></li> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc0">0.3.51-RC0</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../basics/main.html">Getting Started</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../basics/introduction.html">Introduction</a></li> -<li class="toctree-l2"><a class="reference internal" href="../basics/quickstart.html">Quick Start</a></li> -</ul> -</li> -<li class="toctree-l1 current"><a class="reference internal" href="main.html">API</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="core.html">Core Library API</a></li> -<li class="toctree-l2"><a class="reference internal" href="proxy.html">Write Proxy Client API</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Best Practices</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../configuration/main.html">Configuration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../configuration/core.html">Core Library Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/proxy.html">Write Proxy Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/client.html">Client Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/perlog.html">Per Stream Configuration</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../considerations/main.html">Considerations</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#partitioning">Partitioning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#processing-semantics">Processing Semantics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../architecture/main.html">Architecture</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#data-model">Data Model</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#software-stack">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../design/main.html">Detail Design</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#consistency">Consistency</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#streaming-reads">Streaming Reads</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../globalreplicatedlog/main.html">Global Replicated Log</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../implementation/main.html">Implementation</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../implementation/storage.html">Storage</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../operations/main.html">Deployment & Administration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../operations/deployment.html">Cluster Setup & Deployment</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/operations.html">DistributedLog Operations</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/performance.html">Performance Tuning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/hardware.html">Hardware</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/monitoring.html">Monitoring</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/zookeeper.html">ZooKeeper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/bookkeeper.html">BookKeeper</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../performance/main.html">Performance</a></li> -<li class="toctree-l1"><a class="reference internal" href="../references/main.html">References</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../references/configuration.html">Configuration Settings</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/metrics.html">Metrics</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/features.html">Features</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../tutorials/main.html">Tutorials</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#basic">Basic</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#messaging">Messaging</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#analytics">Analytics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../developer/main.html">Developer</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../developer/release.html">Release</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> -</ul> - - <span id="last"></span> - </div> - - </div> - <!-- <div id="slidebox"> --> - <!-- <button id="slidebox_close" type="button" class="close">×</button> --> - <!-- <p>Rate This Page</p> --> - <!-- <div id="rateYo"></div> --> - <!-- <p>Comment</p> - <input type="text" name="comment"></input> - <button>Submit</button> --> - <!-- </div> --> - </div> -</div> -<footer class="footer"> - <div class="container-fluid"> - <div class="row"> - <div class="col-md-10 col-md-offset-1"> - <p class="pull-right"> - <a href="#">Back to top</a> - - <br/> - -<div id="sourcelink"> - <a href="[email protected]:twitter/distributedlog.git/tree/master/docs/api/practice.rst" - rel="nofollow">Source</a> - - <a href="../_sources/api/practice.txt" - rel="nofollow">Raw</a> - <a href="../__docbird-build.log" - rel="nofollow">Build Log</a> - <a href="/report/stats/distributedlog:distributedlog" - rel="nofollow">Stats</a> -</div> - </p> - <p> - Built and hosted by <a href="/">DocBird</a>. - </p> - </div> - </div> - </div> -</footer> -<script type="text/javascript" src="../_static/js/docbird.js"></script> -<script type="text/javascript"> - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-30775-8']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); -</script> -<!-- <script type="text/javascript" src="//s/d41d8cd98f00b204e9800998ecf8427e/en_US-tbnx1s-1988229788/6163/97/1.4.3/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?collectorId=e62237fc"></script> ---> - -<script type="text/javascript"> - $(document).ready(function () { - // track user activity time (from https://github.com/jasonzissman/TimeMe.js) - TimeMe.setIdleDurationInSeconds(30); - TimeMe.setCurrentPageName("my-home-page"); - TimeMe.initialize(); - - // record page visit event when user leaves the page - window.onbeforeunload = function (event) { - xmlhttp=new XMLHttpRequest(); - xmlhttp.withCredentials = true; - xmlhttp.open("POST", "/event/distributedlog:distributedlog/visit", false); - xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded"); - var event_data = { - total_time_reading: TimeMe.getTimeOnCurrentPageInSeconds(), - page: window.location.href - }; - //alert("send: " + $.param(event_data)); - xmlhttp.send($.param(event_data)); - }; - - // ask user for page rating after 20 seconds - // setTimeout(function(){ - // alert("Rate this page!"); - // }, 20000); - }); -</script> -<!-- <style> -#slidebox{ - width: 250px; - height: 90px; - padding: 10px; - background-color: #fff; - border: 1px solid #ccc; - position: fixed; - bottom: 3px; - right: -280px; - z-index: 1; -} -#slidebox .close{ - margin-top: -5px; - opacity: 0.5; -} -#slidebox .close:hover{ - opacity: 0.7; -} -</style> --> -<script type="text/javascript"> -$(function() { - // $(window).scroll(function(){ - // var distanceTop = $('#last').offset().top - $(window).height(); - - // if ($(window).scrollTop() > distanceTop) - // $('#slidebox').animate({'right':'3px'},300); - // else - // $('#slidebox').stop(true).animate({'right':'-280px'},100); - // }); - - // $('#slidebox .close').bind('click',function(){ - // $(this).parent().remove(); - // }); - - $("#rateYo").rateYo({ - normalFill: "#A0A0A0", - halfStar: true, - rating: (Cookies.get('docbird.rating.distributedlog.distributedlog') || 0.0) - }).on("rateyo.set", function (e, data) { - var event_data = { - comment: '', // see todo note below - rating: data.rating, - page: window.location.href - }; - Cookies.get('docbird.rating.distributedlog.distributedlog', data.rating) - $.post('/event/distributedlog:distributedlog/rating', event_data) - // xmlhttp=new XMLHttpRequest(); - // xmlhttp.withCredentials = true; - // var event_data = { - // comment: '', // see todo note below - // rating: data.rating, - // page: window.location.href - // }; - // xmlhttp.open("GET", "/event/distributedlog/rating?" + $.param(event_data), false); - // xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded"); - // // todo: implement comment form in rating slide out, - // // and instead of hooking this event, include a submit button, - // // and read the rating with rating() method - - // // alert("send: " + $.param(event_data)); - // xmlhttp.send(); - - }); - -}); -</script> -<script src="_static/js/selection-sharer.js"></script> -<script> -$('.db-content-body').selectionSharer(); -</script> - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1bd00e9a/api/proxy.html ---------------------------------------------------------------------- diff --git a/api/proxy.html b/api/proxy.html deleted file mode 100644 index 24a7f6a..0000000 --- a/api/proxy.html +++ /dev/null @@ -1,635 +0,0 @@ -<!DOCTYPE html> - - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - - <title>Write Proxy Client API — DistributedLog 1.0 documentation</title> - - <link rel="stylesheet" href="../_static/override.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/bootstrap-3.1.0/css/bootstrap-theme.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/featherlight.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/docbird.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/docbird-xs.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/jquery.rateyo.min.css" type="text/css" /> - <link rel="stylesheet" href="../_static/css/selection-sharer.css" type="text/css" /> - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: '../', - VERSION: '1.0', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true - }; - </script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> - <script type="text/javascript" src="../_static/bootstrap-3.1.0/js/bootstrap.min.js"></script> - <script type="text/javascript" src="../_static/js/bootstrap-docbird.js"></script> - <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script> - <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> - <script type="text/javascript" src="../_static/js/featherlight.min.js"></script> - <script type="text/javascript" src="../_static/js/ifvisible.js"></script> - <script type="text/javascript" src="../_static/js/timeme.js"></script> - <script type="text/javascript" src="../_static/js/jquery.rateyo.min.js"></script> - <script type="text/javascript" src="../_static/js/js.cookie.js"></script> - <link rel="shortcut icon" href="../_static/docbird.ico"/> - <link rel="top" title="DistributedLog 1.0 documentation" href="../index.html" /> - <link rel="up" title="API" href="main.html" /> - <link rel="next" title="Best Practices" href="practice.html" /> - <link rel="prev" title="Core Library API" href="core.html" /> -<meta charset='utf-8'> -<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> -<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> -<meta name="apple-mobile-web-app-capable" content="yes"> - -<meta property="docbird:project" content="DistributedLog" /> - - </head> - <body> -<div class="navbar navbar-default navbar-fixed-top" role="navigation"> - <div class="container-fluid"> - <div class="row db-header"> - <div class="col-sm-3 col-md-3 col-lg-3 hidden-xs db-header-controls"> - <a href="/" alt="Back to Docbird"> - <div class="db-home-button"> - <span class="glyphicon glyphicon-home"></span> - </div> -</a> - -<form action="../search.html" method="get" class="db-searchbox-form"> - <div class="form-group"> - <input type="text" name="q" class="form-control db-searchbox-input" placeholder="Search DistributedLog" /> - </div> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> -</form> - - </div> - <div class="col-sm-7 col-md-7 col-lg-7 col-xs-12 db-header-info"> - <div class="visible-xs"> - <a href="/" alt="Back to Docbird"> - <div class="db-home-button"> - <span class="glyphicon glyphicon-home"></span> - </div> -</a> - </div> - <div class="visible-xs db-xs-menu-button"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#db-xs-menu"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> -</div> - </div> - <div class="db-header-projectname"> - <h1><a href="../index.html">DistributedLog</a></h1> - </div> - </div> - </div> - <div class="row db-xs-menu hidden-sm hidden-md hidden-lg - collapse" id="db-xs-menu"> - -<form action="../search.html" method="get" class="db-searchbox-form"> - <div class="form-group"> - <input type="text" name="q" class="form-control db-searchbox-input" placeholder="Search DistributedLog" /> - </div> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> -</form> - - <div class="db-toc" role="complementary"> - <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../download.html">Releases</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc1">0.3.51-RC1</a></li> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc0">0.3.51-RC0</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../basics/main.html">Getting Started</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../basics/introduction.html">Introduction</a></li> -<li class="toctree-l2"><a class="reference internal" href="../basics/quickstart.html">Quick Start</a></li> -</ul> -</li> -<li class="toctree-l1 current"><a class="reference internal" href="main.html">API</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="core.html">Core Library API</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Write Proxy Client API</a></li> -<li class="toctree-l2"><a class="reference internal" href="practice.html">Best Practices</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../configuration/main.html">Configuration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../configuration/core.html">Core Library Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/proxy.html">Write Proxy Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/client.html">Client Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/perlog.html">Per Stream Configuration</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../considerations/main.html">Considerations</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#partitioning">Partitioning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#processing-semantics">Processing Semantics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../architecture/main.html">Architecture</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#data-model">Data Model</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#software-stack">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../design/main.html">Detail Design</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#consistency">Consistency</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#streaming-reads">Streaming Reads</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../globalreplicatedlog/main.html">Global Replicated Log</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../implementation/main.html">Implementation</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../implementation/storage.html">Storage</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../operations/main.html">Deployment & Administration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../operations/deployment.html">Cluster Setup & Deployment</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/operations.html">DistributedLog Operations</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/performance.html">Performance Tuning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/hardware.html">Hardware</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/monitoring.html">Monitoring</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/zookeeper.html">ZooKeeper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/bookkeeper.html">BookKeeper</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../performance/main.html">Performance</a></li> -<li class="toctree-l1"><a class="reference internal" href="../references/main.html">References</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../references/configuration.html">Configuration Settings</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/metrics.html">Metrics</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/features.html">Features</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../tutorials/main.html">Tutorials</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#basic">Basic</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#messaging">Messaging</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#analytics">Analytics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../developer/main.html">Developer</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../developer/release.html">Release</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> -</ul> - - </div> - </div> - </div> -</div> -<div class="container"> - <div class="row"> - <div style="z-index: 1" class="col-xs-12 col-sm-12 col-md-12 col-lg-12"> - <style> - .overflow-container { - display: none; - } - .overflow-toggle { - text-decoration: none; - border-bottom: none; - border-radius: 4px; - border: 1px solid #eee; - padding: 1px 3px 3px; - color: #888; - font-weight: normal; - background-color: linen; - line-height: 1.85em; - cursor: pointer; - } - .overflow-toggle:hover { - color: #333; - border-color: #ccc; - background-color: beige; - } -</style> -<script> -$(function(){ - $('.overflow-toggle').on('click', function(){ - $(this).next().toggle(); - }); -}); -</script> -<div class="db-project-header-container"> - <div class="row"> - - <div class="db-project-info col-lg-12 col-md-12 col-sm-12 col-xs-12"> - <h1> - <a href="../index.html">DistributedLog</a> - - </h1> - - <div class="db-code-link"> - <a href="[email protected]:twitter/distributedlog.git/tree/master/" target="_blank">[email protected]:twitter/distributedlog.git/tree/master/</a> - </div> - - - </div> - </div> - - <div class="row db-project-links-row"> - <div class=" col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <div class="db-hashtag-container"> - - <span class="db-project-link-label">OWNERS</span> - - <em>None</em> - - - </div> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <div class="db-hashtag-container"> - - <span class="db-project-link-label">TAGS</span> - - <em><a class="db-hashtag" href="/?q=tags:%23uses_maven">#uses_maven</a></em> - - - </div> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <span class="db-project-link-label">HEALTH</span> - - <h3 style="margin-top: 0"> -<!-- <a href="/techdocs/checklist.html" class="label label-success">--> - <a href="/report/distributedlog" class=""> - 9.0 / 10 - <span style="margin-left: .25em" class="glyphicon glyphicon-ok"></span> - </a> - - </h3> - </div> - <div class="col-sm-3 col-md-3 col-lg-3 db-project-link-column"> - <span class="db-project-link-label">RATING</span> - <div id="rateYo"></div> - </div> - </div> - -</div> - </div> - <div class="col-xs-12 col-sm-8 col-md-8 col-lg-8"> - <div class="db-content-body"> - - <div class="section" id="write-proxy-client-api"> -<h1>Write Proxy Client API<a class="headerlink" href="#write-proxy-client-api" title="Permalink to this headline">¶</a></h1> -<p><cite>Write Proxy</cite> is a 'stateless' service on managing the ownerships of writers of log streams. It is used to -accept to <cite>fan-in</cite> writes from different publishers.</p> -<div class="section" id="build-client"> -<h2>Build Client<a class="headerlink" href="#build-client" title="Permalink to this headline">¶</a></h2> -<p>The first thing of using <cite>Write Proxy</cite> service is to build the write proxy client. The endpoint of a <cite>Write Proxy</cite> service -is typically identified by <a class="reference external" href="http://twitter.github.io/finagle/guide/Names.html";>Finagle Name</a>. Name strings must be supplied when constructing a <cite>Write Proxy</cite> client.</p> -<div class="highlight-python"><pre>// 1. Create a Finagle client builder. It would be used for building connection to write proxies. -ClientBuilder clientBuilder = ClientBuilder.get() - .hostConnectionLimit(1) - .hostConnectionCoresize(1) - .tcpConnectTimeout(Duration$.MODULE$.fromMilliseconds(200)) - .connectTimeout(Duration$.MODULE$.fromMilliseconds(200)) - .requestTimeout(Duration$.MODULE$.fromSeconds(2)); - -// 2. Choose a client id to identify the client. -ClientId clientId = ClientId$.MODULE$.apply("test"); - -String finagleNameStr = "inet!127.0.0.1:8000"; - -// 3. Create the write proxy client builder -DistributedLogClientBuilder builder = DistributedLogClientBuilder.newBuilder() - .name("test-writer") - .clientId(clientId) - .clientBuilder(clientBuilder) - .statsReceiver(statsReceiver) - .finagleNameStr(finagleNameStr); - -// 4. Build the client -DistributedLogClient client = builder.build();</pre> -<div style='display:none;' class='raw-code'><pre>// 1. Create a Finagle client builder. It would be used for building connection to write proxies. -ClientBuilder clientBuilder = ClientBuilder.get() - .hostConnectionLimit(1) - .hostConnectionCoresize(1) - .tcpConnectTimeout(Duration$.MODULE$.fromMilliseconds(200)) - .connectTimeout(Duration$.MODULE$.fromMilliseconds(200)) - .requestTimeout(Duration$.MODULE$.fromSeconds(2)); - -// 2. Choose a client id to identify the client. -ClientId clientId = ClientId$.MODULE$.apply("test"); - -String finagleNameStr = "inet!127.0.0.1:8000"; - -// 3. Create the write proxy client builder -DistributedLogClientBuilder builder = DistributedLogClientBuilder.newBuilder() - .name("test-writer") - .clientId(clientId) - .clientBuilder(clientBuilder) - .statsReceiver(statsReceiver) - .finagleNameStr(finagleNameStr); - -// 4. Build the client -DistributedLogClient client = builder.build();</pre> -</div></div> -</div> -<div class="section" id="write-records"> -<h2>Write Records<a class="headerlink" href="#write-records" title="Permalink to this headline">¶</a></h2> -<p>Writing records to log streams via <cite>Write Proxy</cite> is much simpler than using the core library. The transaction id -will be automatically assigned with <cite>timestamp</cite> by write proxies. The <cite>timestamp</cite> is guaranteed to be non-decreasing, which it -could be treated as <cite>physical time</cite> within a log stream, and be used for implementing features like <cite>TTL</cite> in a strong consistent -database.</p> -<div class="highlight-python"><pre>DistributedLogClient client = ...; - -// Write a record to a stream -String streamName = "test-stream"; -byte[] data = ...; -Future<DLSN> writeFuture = client.write(streamName, ByteBuffer.wrap(data)); -Await.result(writeFuture);</pre> -<div style='display:none;' class='raw-code'><pre>DistributedLogClient client = ...; - -// Write a record to a stream -String streamName = "test-stream"; -byte[] data = ...; -Future<DLSN> writeFuture = client.write(streamName, ByteBuffer.wrap(data)); -Await.result(writeFuture);</pre> -</div></div> -</div> -<div class="section" id="truncate-streams"> -<h2>Truncate Streams<a class="headerlink" href="#truncate-streams" title="Permalink to this headline">¶</a></h2> -<p>Client could issue truncation requests (via <cite>#truncate(String, DLSN)</cite>) to write proxies to truncate a log stream up to a given -position.</p> -<div class="highlight-python"><pre>DistributedLogClient client = ...; - -// Truncate a stream to DLSN -String streamName = "test-stream"; -DLSN truncationDLSN = ...; -Future<DLSN> truncateFuture = client.truncate(streamName, truncationDLSN); -Await.result(truncateFuture);</pre> -<div style='display:none;' class='raw-code'><pre>DistributedLogClient client = ...; - -// Truncate a stream to DLSN -String streamName = "test-stream"; -DLSN truncationDLSN = ...; -Future<DLSN> truncateFuture = client.truncate(streamName, truncationDLSN); -Await.result(truncateFuture);</pre> -</div></div> -</div> -</div> - - - </div> - </div> - <div class="hidden-xs col-sm-3 col-md-3 col-md-offset-1 col-lg-3 db-sidebar"> - - <div class="db-toc" role="complementary"> - <ul class="current"> - <li class="toctree-l0 current"><a class="current reference internal" href="../index.html">DistributedLog</a></li> - </ul> - <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../download.html">Releases</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc1">0.3.51-RC1</a></li> -<li class="toctree-l2"><a class="reference internal" href="../download.html#rc0">0.3.51-RC0</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../basics/main.html">Getting Started</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../basics/introduction.html">Introduction</a></li> -<li class="toctree-l2"><a class="reference internal" href="../basics/quickstart.html">Quick Start</a></li> -</ul> -</li> -<li class="toctree-l1 current"><a class="reference internal" href="main.html">API</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="core.html">Core Library API</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Write Proxy Client API</a></li> -<li class="toctree-l2"><a class="reference internal" href="practice.html">Best Practices</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../configuration/main.html">Configuration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../configuration/core.html">Core Library Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/proxy.html">Write Proxy Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/client.html">Client Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="../configuration/perlog.html">Per Stream Configuration</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../considerations/main.html">Considerations</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#consistency-durability-and-ordering">Consistency, Durability and Ordering</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#partitioning">Partitioning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../considerations/main.html#processing-semantics">Processing Semantics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../architecture/main.html">Architecture</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#data-model">Data Model</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#software-stack">Software Stack</a></li> -<li class="toctree-l2"><a class="reference internal" href="../architecture/main.html#lifecyle-of-records">Lifecyle of records</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../design/main.html">Detail Design</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#consistency">Consistency</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#streaming-reads">Streaming Reads</a></li> -<li class="toctree-l2"><a class="reference internal" href="../design/main.html#logsegment-lifecycle">LogSegment Lifecycle</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../globalreplicatedlog/main.html">Global Replicated Log</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#region-aware-data-placement-policy">Region Aware Data Placement Policy</a></li> -<li class="toctree-l2"><a class="reference internal" href="../globalreplicatedlog/main.html#cross-region-speculative-reads">Cross Region Speculative Reads</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../implementation/main.html">Implementation</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../implementation/storage.html">Storage</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../operations/main.html">Deployment & Administration</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../operations/deployment.html">Cluster Setup & Deployment</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/operations.html">DistributedLog Operations</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/performance.html">Performance Tuning</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/hardware.html">Hardware</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/monitoring.html">Monitoring</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/zookeeper.html">ZooKeeper</a></li> -<li class="toctree-l2"><a class="reference internal" href="../operations/bookkeeper.html">BookKeeper</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../performance/main.html">Performance</a></li> -<li class="toctree-l1"><a class="reference internal" href="../references/main.html">References</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../references/configuration.html">Configuration Settings</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/metrics.html">Metrics</a></li> -<li class="toctree-l2"><a class="reference internal" href="../references/features.html">Features</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../tutorials/main.html">Tutorials</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#basic">Basic</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#messaging">Messaging</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#replicated-state-machines">Replicated State Machines</a></li> -<li class="toctree-l2"><a class="reference internal" href="../tutorials/main.html#analytics">Analytics</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../developer/main.html">Developer</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../developer/release.html">Release</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li> -</ul> - - <span id="last"></span> - </div> - - </div> - <!-- <div id="slidebox"> --> - <!-- <button id="slidebox_close" type="button" class="close">×</button> --> - <!-- <p>Rate This Page</p> --> - <!-- <div id="rateYo"></div> --> - <!-- <p>Comment</p> - <input type="text" name="comment"></input> - <button>Submit</button> --> - <!-- </div> --> - </div> -</div> -<footer class="footer"> - <div class="container-fluid"> - <div class="row"> - <div class="col-md-10 col-md-offset-1"> - <p class="pull-right"> - <a href="#">Back to top</a> - - <br/> - -<div id="sourcelink"> - <a href="[email protected]:twitter/distributedlog.git/tree/master/docs/api/proxy.rst" - rel="nofollow">Source</a> - - <a href="../_sources/api/proxy.txt" - rel="nofollow">Raw</a> - <a href="../__docbird-build.log" - rel="nofollow">Build Log</a> - <a href="/report/stats/distributedlog:distributedlog" - rel="nofollow">Stats</a> -</div> - </p> - <p> - Built and hosted by <a href="/">DocBird</a>. - </p> - </div> - </div> - </div> -</footer> -<script type="text/javascript" src="../_static/js/docbird.js"></script> -<script type="text/javascript"> - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-30775-8']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); -</script> -<!-- <script type="text/javascript" src="//s/d41d8cd98f00b204e9800998ecf8427e/en_US-tbnx1s-1988229788/6163/97/1.4.3/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?collectorId=e62237fc"></script> ---> - -<script type="text/javascript"> - $(document).ready(function () { - // track user activity time (from https://github.com/jasonzissman/TimeMe.js) - TimeMe.setIdleDurationInSeconds(30); - TimeMe.setCurrentPageName("my-home-page"); - TimeMe.initialize(); - - // record page visit event when user leaves the page - window.onbeforeunload = function (event) { - xmlhttp=new XMLHttpRequest(); - xmlhttp.withCredentials = true; - xmlhttp.open("POST", "/event/distributedlog:distributedlog/visit", false); - xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded"); - var event_data = { - total_time_reading: TimeMe.getTimeOnCurrentPageInSeconds(), - page: window.location.href - }; - //alert("send: " + $.param(event_data)); - xmlhttp.send($.param(event_data)); - }; - - // ask user for page rating after 20 seconds - // setTimeout(function(){ - // alert("Rate this page!"); - // }, 20000); - }); -</script> -<!-- <style> -#slidebox{ - width: 250px; - height: 90px; - padding: 10px; - background-color: #fff; - border: 1px solid #ccc; - position: fixed; - bottom: 3px; - right: -280px; - z-index: 1; -} -#slidebox .close{ - margin-top: -5px; - opacity: 0.5; -} -#slidebox .close:hover{ - opacity: 0.7; -} -</style> --> -<script type="text/javascript"> -$(function() { - // $(window).scroll(function(){ - // var distanceTop = $('#last').offset().top - $(window).height(); - - // if ($(window).scrollTop() > distanceTop) - // $('#slidebox').animate({'right':'3px'},300); - // else - // $('#slidebox').stop(true).animate({'right':'-280px'},100); - // }); - - // $('#slidebox .close').bind('click',function(){ - // $(this).parent().remove(); - // }); - - $("#rateYo").rateYo({ - normalFill: "#A0A0A0", - halfStar: true, - rating: (Cookies.get('docbird.rating.distributedlog.distributedlog') || 0.0) - }).on("rateyo.set", function (e, data) { - var event_data = { - comment: '', // see todo note below - rating: data.rating, - page: window.location.href - }; - Cookies.get('docbird.rating.distributedlog.distributedlog', data.rating) - $.post('/event/distributedlog:distributedlog/rating', event_data) - // xmlhttp=new XMLHttpRequest(); - // xmlhttp.withCredentials = true; - // var event_data = { - // comment: '', // see todo note below - // rating: data.rating, - // page: window.location.href - // }; - // xmlhttp.open("GET", "/event/distributedlog/rating?" + $.param(event_data), false); - // xmlhttp.setRequestHeader("Content-type", "application/x-www-form-urlencoded"); - // // todo: implement comment form in rating slide out, - // // and instead of hooking this event, include a submit button, - // // and read the rating with rating() method - - // // alert("send: " + $.param(event_data)); - // xmlhttp.send(); - - }); - -}); -</script> -<script src="_static/js/selection-sharer.js"></script> -<script> -$('.db-content-body').selectionSharer(); -</script> - </body> -</html>
