client-java/site/apidocs/binlog/CisternGrpc.AsyncService.html

287 lines
11 KiB
HTML

<!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_412) on Tue Jun 04 03:40:07 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CisternGrpc.AsyncService (TiKV Java Client 3.3.4-SNAPSHOT API)</title>
<meta name="date" content="2024-06-04">
<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="CisternGrpc.AsyncService (TiKV Java Client 3.3.4-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":18,"i2":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],16:["t5","Default 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/CisternGrpc.AsyncService.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="../binlog/CisternGrpc.html" title="class in binlog"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../binlog/CisternGrpc.CisternBlockingStub.html" title="class in binlog"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?binlog/CisternGrpc.AsyncService.html" target="_top">Frames</a></li>
<li><a href="CisternGrpc.AsyncService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">binlog</div>
<h2 title="Interface CisternGrpc.AsyncService" class="title">Interface CisternGrpc.AsyncService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../binlog/CisternGrpc.CisternImplBase.html" title="class in binlog">CisternGrpc.CisternImplBase</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../binlog/CisternGrpc.html" title="class in binlog">CisternGrpc</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">CisternGrpc.AsyncService</span></pre>
<div class="block"><pre>
Interfaces exported by CisternServer.
</pre></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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/CisternGrpc.AsyncService.html#dumpBinlog-binlog.CisternOuterClass.DumpBinlogReq-io.grpc.stub.StreamObserver-">dumpBinlog</a></span>(<a href="../binlog/CisternOuterClass.DumpBinlogReq.html" title="class in binlog">CisternOuterClass.DumpBinlogReq</a>&nbsp;request,
io.grpc.stub.StreamObserver&lt;<a href="../binlog/CisternOuterClass.DumpBinlogResp.html" title="class in binlog">CisternOuterClass.DumpBinlogResp</a>&gt;&nbsp;responseObserver)</code>
<div class="block">
DumpBinlog dumps continuous binlog items in a stream from a given position</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/CisternGrpc.AsyncService.html#dumpDDLJobs-binlog.CisternOuterClass.DumpDDLJobsReq-io.grpc.stub.StreamObserver-">dumpDDLJobs</a></span>(<a href="../binlog/CisternOuterClass.DumpDDLJobsReq.html" title="class in binlog">CisternOuterClass.DumpDDLJobsReq</a>&nbsp;request,
io.grpc.stub.StreamObserver&lt;<a href="../binlog/CisternOuterClass.DumpDDLJobsResp.html" title="class in binlog">CisternOuterClass.DumpDDLJobsResp</a>&gt;&nbsp;responseObserver)</code>
<div class="block">
DumpDDLJobs dumps all history DDL jobs before a specified commitTS</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/CisternGrpc.AsyncService.html#notify-binlog.CisternOuterClass.NotifyReq-io.grpc.stub.StreamObserver-">notify</a></span>(<a href="../binlog/CisternOuterClass.NotifyReq.html" title="class in binlog">CisternOuterClass.NotifyReq</a>&nbsp;request,
io.grpc.stub.StreamObserver&lt;<a href="../binlog/CisternOuterClass.NotifyResp.html" title="class in binlog">CisternOuterClass.NotifyResp</a>&gt;&nbsp;responseObserver)</code>
<div class="block">
Notify notifies all living cisterns that a new pump is coming
the living cisterns can be queried from pd</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="dumpBinlog-binlog.CisternOuterClass.DumpBinlogReq-io.grpc.stub.StreamObserver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dumpBinlog</h4>
<pre>default&nbsp;void&nbsp;dumpBinlog(<a href="../binlog/CisternOuterClass.DumpBinlogReq.html" title="class in binlog">CisternOuterClass.DumpBinlogReq</a>&nbsp;request,
io.grpc.stub.StreamObserver&lt;<a href="../binlog/CisternOuterClass.DumpBinlogResp.html" title="class in binlog">CisternOuterClass.DumpBinlogResp</a>&gt;&nbsp;responseObserver)</pre>
<div class="block"><pre>
DumpBinlog dumps continuous binlog items in a stream from a given position
</pre></div>
</li>
</ul>
<a name="dumpDDLJobs-binlog.CisternOuterClass.DumpDDLJobsReq-io.grpc.stub.StreamObserver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dumpDDLJobs</h4>
<pre>default&nbsp;void&nbsp;dumpDDLJobs(<a href="../binlog/CisternOuterClass.DumpDDLJobsReq.html" title="class in binlog">CisternOuterClass.DumpDDLJobsReq</a>&nbsp;request,
io.grpc.stub.StreamObserver&lt;<a href="../binlog/CisternOuterClass.DumpDDLJobsResp.html" title="class in binlog">CisternOuterClass.DumpDDLJobsResp</a>&gt;&nbsp;responseObserver)</pre>
<div class="block"><pre>
DumpDDLJobs dumps all history DDL jobs before a specified commitTS
</pre></div>
</li>
</ul>
<a name="notify-binlog.CisternOuterClass.NotifyReq-io.grpc.stub.StreamObserver-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>notify</h4>
<pre>default&nbsp;void&nbsp;notify(<a href="../binlog/CisternOuterClass.NotifyReq.html" title="class in binlog">CisternOuterClass.NotifyReq</a>&nbsp;request,
io.grpc.stub.StreamObserver&lt;<a href="../binlog/CisternOuterClass.NotifyResp.html" title="class in binlog">CisternOuterClass.NotifyResp</a>&gt;&nbsp;responseObserver)</pre>
<div class="block"><pre>
Notify notifies all living cisterns that a new pump is coming
the living cisterns can be queried from pd
</pre></div>
</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/CisternGrpc.AsyncService.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="../binlog/CisternGrpc.html" title="class in binlog"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../binlog/CisternGrpc.CisternBlockingStub.html" title="class in binlog"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?binlog/CisternGrpc.AsyncService.html" target="_top">Frames</a></li>
<li><a href="CisternGrpc.AsyncService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2024 PingCAP. All rights reserved.</small></p>
</body>
</html>