-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update documentation Keyple/keyple-distributed-remote-java-lib/…
…main-37
- Loading branch information
Eclipse Keyple Bot
committed
Nov 28, 2023
1 parent
440a9d7
commit b505589
Showing
90 changed files
with
49,222 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,288 @@ | ||
<!DOCTYPE HTML> | ||
<!-- NewPage --> | ||
<html lang="en"> | ||
<head> | ||
<!-- Generated by javadoc --> | ||
<title>All Classes (Keyple Distributed Remote Java Lib - 2.3.1-SNAPSHOT)</title> | ||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
<link rel="stylesheet" type="text/css" href="keyple-stylesheet.css" title="Style"> | ||
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style"> | ||
<script type="text/javascript" src="script.js"></script> | ||
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script> | ||
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script> | ||
<!--[if IE]> | ||
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> | ||
<![endif]--> | ||
<script type="text/javascript" src="jquery/jquery-3.5.1.js"></script> | ||
<script type="text/javascript" src="jquery/jquery-ui.js"></script> | ||
</head> | ||
<body> | ||
<script type="text/javascript"><!-- | ||
try { | ||
if (location.href.indexOf('is-external=true') == -1) { | ||
parent.document.title="All Classes (Keyple Distributed Remote Java Lib - 2.3.1-SNAPSHOT)"; | ||
} | ||
} | ||
catch(err) { | ||
} | ||
//--> | ||
var data = {"i0":1,"i1":1,"i2":2,"i3":1,"i4":1,"i5":1,"i6":1,"i7":1,"i8":1,"i9":1,"i10":1,"i11":2,"i12":1,"i13":1,"i14":2,"i15":1,"i16":1,"i17":1,"i18":1}; | ||
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"]}; | ||
var altColor = "altColor"; | ||
var rowColor = "rowColor"; | ||
var tableTab = "tableTab"; | ||
var activeTableTab = "activeTableTab"; | ||
var pathtoroot = "./"; | ||
var useModuleDirectories = false; | ||
loadScripts(document, 'script');</script> | ||
<noscript> | ||
<div>JavaScript is disabled on your browser.</div> | ||
</noscript> | ||
<header role="banner"> | ||
<nav role="navigation"> | ||
<div class="fixedNav"> | ||
<!-- ========= START OF TOP NAVBAR ======= --> | ||
<div class="topNav"><a id="navbar.top"> | ||
<!-- --> | ||
</a> | ||
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> | ||
<a id="navbar.top.firstrow"> | ||
<!-- --> | ||
</a> | ||
<ul class="navList" title="Navigation"> | ||
<li><a href="index.html">Overview</a></li> | ||
<li><a href="org/eclipse/keyple/distributed/package-summary.html">Package</a></li> | ||
<li>Class</li> | ||
<li>Use</li> | ||
<li><a href="overview-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 class="aboutLanguage"><a target="_parent" href="https://keyple.org/"><img src="https://keyple.org/docs/api-reference/java-api/keyple-java-core/1.0.0/images/keyple.png" height="20px" style="background-color: white; padding: 3px; margin: 0 10px -7px 3px;"/></a><span style="line-height: 30px"> Keyple Distributed Remote Java Lib - 2.3.1-SNAPSHOT</span></div> | ||
</div> | ||
<div class="subNav"> | ||
<ul class="navList" id="allclasses_navbar_top"> | ||
<li><a href="allclasses.html">All Classes</a></li> | ||
</ul> | ||
<ul class="navListSearch"> | ||
<li><label for="search">SEARCH:</label> | ||
<input type="text" id="search" value="search" disabled="disabled"> | ||
<input type="reset" id="reset" value="reset" disabled="disabled"> | ||
</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> | ||
<noscript> | ||
<div>JavaScript is disabled on your browser.</div> | ||
</noscript> | ||
</div> | ||
<a id="skip.navbar.top"> | ||
<!-- --> | ||
</a></div> | ||
<!-- ========= END OF TOP NAVBAR ========= --> | ||
</div> | ||
<div class="navPadding"> </div> | ||
<script type="text/javascript"><!-- | ||
$('.navPadding').css('padding-top', $('.fixedNav').css("height")); | ||
//--> | ||
</script> | ||
</nav> | ||
</header> | ||
<main role="main"> | ||
<div class="header"> | ||
<h1 title="All&nbsp;Classes" class="title">All Classes</h1> | ||
</div> | ||
<div class="allClassesContainer"> | ||
<ul class="blockList"> | ||
<li class="blockList"> | ||
<table class="typeSummary"> | ||
<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Interface Summary</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd"> </span></span></caption> | ||
<tr> | ||
<th class="colFirst" scope="col">Class</th> | ||
<th class="colLast" scope="col">Description</th> | ||
</tr> | ||
<tr id="i0" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClient.html" title="interface in org.eclipse.keyple.distributed">RemotePluginClient</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">API of the <b>Remote Plugin Client</b> associated to a <b>Local Service Server</b> to be used in | ||
the <b>Reader Server Side</b> configuration mode.</div> | ||
</th> | ||
</tr> | ||
<tr id="i1" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClientFactory.html" title="interface in org.eclipse.keyple.distributed">RemotePluginClientFactory</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Factory of <a href="org/eclipse/keyple/distributed/RemotePluginClient.html" title="interface in org.eclipse.keyple.distributed"><code>RemotePluginClient</code></a> to provide to the Keyple main service during the | ||
registration process.</div> | ||
</th> | ||
</tr> | ||
<tr id="i2" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.html" title="class in org.eclipse.keyple.distributed">RemotePluginClientFactoryBuilder</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Builder of <a href="org/eclipse/keyple/distributed/RemotePluginClientFactory.html" title="interface in org.eclipse.keyple.distributed"><code>RemotePluginClientFactory</code></a> for Keyple <b>Plugin</b> or <b>ObservablePlugin</b> | ||
type.</div> | ||
</th> | ||
</tr> | ||
<tr id="i3" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.BuilderStep.html" title="interface in org.eclipse.keyple.distributed">RemotePluginClientFactoryBuilder.BuilderStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Last step : build a new instance.</div> | ||
</th> | ||
</tr> | ||
<tr id="i4" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.NodeStep.html" title="interface in org.eclipse.keyple.distributed">RemotePluginClientFactoryBuilder.NodeStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Step to configure the node associated with the service.</div> | ||
</th> | ||
</tr> | ||
<tr id="i5" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.ServerPushPluginEventStrategyStep.html" title="interface in org.eclipse.keyple.distributed">RemotePluginClientFactoryBuilder.ServerPushPluginEventStrategyStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Step to configure the plugin observation for sync protocol.</div> | ||
</th> | ||
</tr> | ||
<tr id="i6" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.ServerPushReaderEventStrategyStep.html" title="interface in org.eclipse.keyple.distributed">RemotePluginClientFactoryBuilder.ServerPushReaderEventStrategyStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Step to configure the reader observation for sync protocol.</div> | ||
</th> | ||
</tr> | ||
<tr id="i7" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.SyncNodePluginStep.html" title="interface in org.eclipse.keyple.distributed">RemotePluginClientFactoryBuilder.SyncNodePluginStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Step to activate the plugin observation for sync protocol.</div> | ||
</th> | ||
</tr> | ||
<tr id="i8" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.SyncNodeReaderStep.html" title="interface in org.eclipse.keyple.distributed">RemotePluginClientFactoryBuilder.SyncNodeReaderStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Step to activate the reader observation for sync protocol.</div> | ||
</th> | ||
</tr> | ||
<tr id="i9" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginServer.html" title="interface in org.eclipse.keyple.distributed">RemotePluginServer</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">API of the <b>Remote Plugin Server</b> associated to a <b>Local Service Client</b> to be used in | ||
the <b>Reader Client Side</b> configuration mode.</div> | ||
</th> | ||
</tr> | ||
<tr id="i10" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginServerFactory.html" title="interface in org.eclipse.keyple.distributed">RemotePluginServerFactory</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Factory of <a href="org/eclipse/keyple/distributed/RemotePluginServer.html" title="interface in org.eclipse.keyple.distributed"><code>RemotePluginServer</code></a> to provide to the Keyple main service during the | ||
registration process.</div> | ||
</th> | ||
</tr> | ||
<tr id="i11" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginServerFactoryBuilder.html" title="class in org.eclipse.keyple.distributed">RemotePluginServerFactoryBuilder</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Builder of <a href="org/eclipse/keyple/distributed/RemotePluginServerFactory.html" title="interface in org.eclipse.keyple.distributed"><code>RemotePluginServerFactory</code></a> for Keyple <b>ObservablePlugin</b> type.</div> | ||
</th> | ||
</tr> | ||
<tr id="i12" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginServerFactoryBuilder.BuilderStep.html" title="interface in org.eclipse.keyple.distributed">RemotePluginServerFactoryBuilder.BuilderStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Last step : builds a new instance.</div> | ||
</th> | ||
</tr> | ||
<tr id="i13" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePluginServerFactoryBuilder.NodeStep.html" title="interface in org.eclipse.keyple.distributed">RemotePluginServerFactoryBuilder.NodeStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Step to configure the node associated with the service.</div> | ||
</th> | ||
</tr> | ||
<tr id="i14" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePoolPluginClientFactoryBuilder.html" title="class in org.eclipse.keyple.distributed">RemotePoolPluginClientFactoryBuilder</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Builder of <a href="org/eclipse/keyple/distributed/RemotePluginClientFactory.html" title="interface in org.eclipse.keyple.distributed"><code>RemotePluginClientFactory</code></a> for Keyple <b>PoolPlugin</b> type.</div> | ||
</th> | ||
</tr> | ||
<tr id="i15" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePoolPluginClientFactoryBuilder.BuilderStep.html" title="interface in org.eclipse.keyple.distributed">RemotePoolPluginClientFactoryBuilder.BuilderStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Last step : build a new instance.</div> | ||
</th> | ||
</tr> | ||
<tr id="i16" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemotePoolPluginClientFactoryBuilder.NodeStep.html" title="interface in org.eclipse.keyple.distributed">RemotePoolPluginClientFactoryBuilder.NodeStep</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">Step to configure the node associated with the service.</div> | ||
</th> | ||
</tr> | ||
<tr id="i17" class="rowColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemoteReaderClient.html" title="interface in org.eclipse.keyple.distributed">RemoteReaderClient</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">API of the <b>Remote Reader Client</b> provided by the <b>Remote Plugin Client</b> to be used in | ||
the <b>Reader Server Side</b> configuration mode.</div> | ||
</th> | ||
</tr> | ||
<tr id="i18" class="altColor"> | ||
<td class="colFirst"><a href="org/eclipse/keyple/distributed/RemoteReaderServer.html" title="interface in org.eclipse.keyple.distributed">RemoteReaderServer</a></td> | ||
<th class="colLast" scope="row"> | ||
<div class="block">API of the <b>Remote Reader Server</b> provided by the <b>Remote Plugin Server</b> to be used in | ||
the <b>Reader Client Side</b> configuration mode.</div> | ||
</th> | ||
</tr> | ||
</table> | ||
</li> | ||
</ul> | ||
</div> | ||
</main> | ||
<footer role="contentinfo"> | ||
<nav role="navigation"> | ||
<!-- ======= START OF BOTTOM NAVBAR ====== --> | ||
<div class="bottomNav"><a id="navbar.bottom"> | ||
<!-- --> | ||
</a> | ||
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> | ||
<a id="navbar.bottom.firstrow"> | ||
<!-- --> | ||
</a> | ||
<ul class="navList" title="Navigation"> | ||
<li><a href="index.html">Overview</a></li> | ||
<li><a href="org/eclipse/keyple/distributed/package-summary.html">Package</a></li> | ||
<li>Class</li> | ||
<li>Use</li> | ||
<li><a href="overview-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 class="aboutLanguage">Copyright © Eclipse Foundation, Inc. All Rights Reserved.</div> | ||
</div> | ||
<div class="subNav"> | ||
<ul class="navList" id="allclasses_navbar_bottom"> | ||
<li><a href="allclasses.html">All Classes</a></li> | ||
</ul> | ||
<div> | ||
<script type="text/javascript"><!-- | ||
allClassesLink = document.getElementById("allclasses_navbar_bottom"); | ||
if(window==top) { | ||
allClassesLink.style.display = "block"; | ||
} | ||
else { | ||
allClassesLink.style.display = "none"; | ||
} | ||
//--> | ||
</script> | ||
<noscript> | ||
<div>JavaScript is disabled on your browser.</div> | ||
</noscript> | ||
</div> | ||
<a id="skip.navbar.bottom"> | ||
<!-- --> | ||
</a></div> | ||
<!-- ======== END OF BOTTOM NAVBAR ======= --> | ||
</nav> | ||
</footer> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
<!DOCTYPE HTML> | ||
<!-- NewPage --> | ||
<html lang="en"> | ||
<head> | ||
<!-- Generated by javadoc --> | ||
<title>All Classes (Keyple Distributed Remote Java Lib - 2.3.1-SNAPSHOT)</title> | ||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
<link rel="stylesheet" type="text/css" href="keyple-stylesheet.css" title="Style"> | ||
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style"> | ||
<script type="text/javascript" src="script.js"></script> | ||
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script> | ||
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script> | ||
<!--[if IE]> | ||
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> | ||
<![endif]--> | ||
<script type="text/javascript" src="jquery/jquery-3.5.1.js"></script> | ||
<script type="text/javascript" src="jquery/jquery-ui.js"></script> | ||
</head> | ||
<body> | ||
<h1 class="bar">All Classes</h1> | ||
<main role="main" class="indexContainer"> | ||
<ul> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClient.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginClient</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClientFactory.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginClientFactory</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.html" title="class in org.eclipse.keyple.distributed">RemotePluginClientFactoryBuilder</a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.BuilderStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginClientFactoryBuilder.BuilderStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.NodeStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginClientFactoryBuilder.NodeStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.ServerPushPluginEventStrategyStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginClientFactoryBuilder.ServerPushPluginEventStrategyStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.ServerPushReaderEventStrategyStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginClientFactoryBuilder.ServerPushReaderEventStrategyStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.SyncNodePluginStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginClientFactoryBuilder.SyncNodePluginStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginClientFactoryBuilder.SyncNodeReaderStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginClientFactoryBuilder.SyncNodeReaderStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginServer.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginServer</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginServerFactory.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginServerFactory</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginServerFactoryBuilder.html" title="class in org.eclipse.keyple.distributed">RemotePluginServerFactoryBuilder</a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginServerFactoryBuilder.BuilderStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginServerFactoryBuilder.BuilderStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePluginServerFactoryBuilder.NodeStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePluginServerFactoryBuilder.NodeStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePoolPluginClientFactoryBuilder.html" title="class in org.eclipse.keyple.distributed">RemotePoolPluginClientFactoryBuilder</a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePoolPluginClientFactoryBuilder.BuilderStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePoolPluginClientFactoryBuilder.BuilderStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemotePoolPluginClientFactoryBuilder.NodeStep.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemotePoolPluginClientFactoryBuilder.NodeStep</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemoteReaderClient.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemoteReaderClient</span></a></li> | ||
<li><a href="org/eclipse/keyple/distributed/RemoteReaderServer.html" title="interface in org.eclipse.keyple.distributed"><span class="interfaceName">RemoteReaderServer</span></a></li> | ||
</ul> | ||
</main> | ||
</body> | ||
</html> |
Oops, something went wrong.