Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / d34bf266db7db6621a9cba2a322de650f1980adb / . / java_docs / org / eclipse / mosaic / rti / api / FederateExecutor.html
blob: a40286585adb30413b01a655db9ecd7963721867 [file] [log] [blame]
<!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_262) on Thu Oct 29 15:52:01 GMT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FederateExecutor (Eclipse MOSAIC Parent 20.0 API)</title>
<meta name="date" content="2020-10-29">
<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="FederateExecutor (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FederateExecutor.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/mosaic/rti/api/FederateAmbassador.html" title="interface in org.eclipse.mosaic.rti.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/rti/api/FederateExecutor.html" target="_top">Frames</a></li>
<li><a href="FederateExecutor.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><a href="#nested.class.summary">Nested</a>&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">org.eclipse.mosaic.rti.api</div>
<h2 title="Interface FederateExecutor" class="title">Interface FederateExecutor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/eclipse/mosaic/rti/api/federatestarter/DockerFederateExecutor.html" title="class in org.eclipse.mosaic.rti.api.federatestarter">DockerFederateExecutor</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/federatestarter/ExecutableFederateExecutor.html" title="class in org.eclipse.mosaic.rti.api.federatestarter">ExecutableFederateExecutor</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/federatestarter/JavaFederateExecutor.html" title="class in org.eclipse.mosaic.rti.api.federatestarter">JavaFederateExecutor</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/federatestarter/NopFederateExecutor.html" title="class in org.eclipse.mosaic.rti.api.federatestarter">NopFederateExecutor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">FederateExecutor</span></pre>
<div class="block"><p>The <a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html" title="interface in org.eclipse.mosaic.rti.api"><code>FederateExecutor</code></a> is used to start the federate the ambassador
is associated with. The <a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html" title="interface in org.eclipse.mosaic.rti.api"><code>FederateExecutor</code></a> should be able to start the
federate and close it locally, as well as remotely.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Process.html?is-external=true" title="class or interface in java.lang">Process</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html#startLocalFederate-java.io.File-">startLocalFederate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;workingDir)</code>
<div class="block">Starts the federate locally in the given working dir.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html#startRemoteFederate-org.eclipse.mosaic.rti.config.CLocalHost-java.io.PrintStream-java.io.InputStream-">startRemoteFederate</a></span>(<a href="../../../../../org/eclipse/mosaic/rti/config/CLocalHost.html" title="class in org.eclipse.mosaic.rti.config">CLocalHost</a>&nbsp;host,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;sshStreamOut,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;sshStreamIn)</code>
<div class="block">Starts the federate locally in the given working dir.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html#stopLocalFederate--">stopLocalFederate</a></span>()</code>
<div class="block">Stops the previously locally started federate.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.html#stopRemoteFederate-java.io.PrintStream-">stopRemoteFederate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;sshStreamOut)</code>
<div class="block">Stops the previously remotely started federate.</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="startLocalFederate-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startLocalFederate</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Process.html?is-external=true" title="class or interface in java.lang">Process</a>&nbsp;startLocalFederate(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;workingDir)
throws <a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></pre>
<div class="block">Starts the federate locally in the given working dir.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>workingDir</code> - the working directory</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the local process of the federate</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></code> - if something went wrong during starting the federate</dd>
</dl>
</li>
</ul>
<a name="stopLocalFederate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopLocalFederate</h4>
<pre>void&nbsp;stopLocalFederate()
throws <a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></pre>
<div class="block">Stops the previously locally started federate.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></code> - if the start of the federate failed</dd>
</dl>
</li>
</ul>
<a name="startRemoteFederate-org.eclipse.mosaic.rti.config.CLocalHost-java.io.PrintStream-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startRemoteFederate</h4>
<pre>int&nbsp;startRemoteFederate(<a href="../../../../../org/eclipse/mosaic/rti/config/CLocalHost.html" title="class in org.eclipse.mosaic.rti.config">CLocalHost</a>&nbsp;host,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;sshStreamOut,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;sshStreamIn)
throws <a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></pre>
<div class="block">Starts the federate locally in the given working dir.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>host</code> - information about the remote host the federate is started on</dd>
<dd><code>sshStreamOut</code> - the ssh output stream to send commands to the host</dd>
<dd><code>sshStreamIn</code> - the ssh input stream to read the console output of the remote host shell</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the local process of the federate</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></code> - if something went wrong during starting the federate</dd>
</dl>
</li>
</ul>
<a name="stopRemoteFederate-java.io.PrintStream-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stopRemoteFederate</h4>
<pre>void&nbsp;stopRemoteFederate(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;sshStreamOut)
throws <a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></pre>
<div class="block">Stops the previously remotely started federate.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sshStreamOut</code> - the ssh output stream to send commands to the host</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api">FederateExecutor.FederateStarterException</a></code> - if something went wrong during starting the federate</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FederateExecutor.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/mosaic/rti/api/FederateAmbassador.html" title="interface in org.eclipse.mosaic.rti.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/mosaic/rti/api/FederateExecutor.FederateStarterException.html" title="class in org.eclipse.mosaic.rti.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/rti/api/FederateExecutor.html" target="_top">Frames</a></li>
<li><a href="FederateExecutor.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><a href="#nested.class.summary">Nested</a>&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; 2020 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>