AISE
/
SEP-Board
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
SEP-Board/Dokumentation/Interation 2/JavaDoc/new_build/client/controller/ClientController.html

510 lines
20 KiB
HTML
Raw Permalink Normal View History

Initial commit for Software Engineerung & Programming Course Signed-off-by: Tuan-Dat Tran <tuan-dat.tran@tudattr.dev>
2024-04-14 02:30:44 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_111) on Mon Jun 19 14:04:41 CEST 2017 -->
<title>ClientController</title>
<meta name="date" content="2017-06-19">
<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="ClientController";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientController.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?new_build/client/controller/ClientController.html" target="_top">Frames</a></li>
<li><a href="ClientController.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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">new_build.client.controller</div>
<h2 title="Class ClientController" class="title">Class ClientController</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>new_build.client.controller.ClientController</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ClientController</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../new_build/models/network_organisation/Connection.html" title="class in new_build.models.network_organisation">Connection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#connection">connection</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#keepRunning">keepRunning</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.util.HashMap&lt;<a href="../../../new_build/models/network_organisation/Group.html" title="class in new_build.models.network_organisation">Group</a>,<a href="../../../new_build/models/network_organisation/GroupInformation.html" title="class in new_build.models.network_organisation">GroupInformation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#knownTeamMap">knownTeamMap</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../new_build/models/network_organisation/UserLogin.html" title="class in new_build.models.network_organisation">UserLogin</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#loggedInUser">loggedInUser</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../new_build/models/client_interfaces/ClientView.html" title="interface in new_build.models.client_interfaces">ClientView</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#view">view</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#ClientController-java.lang.String-int-">ClientController</a></span>(java.lang.String&nbsp;targetIp,
int&nbsp;portToListenTo)</code>
<div class="block">delivers targetIp and portToListenTo to the constructor
builds a new array, LinkedList, connection, ioLoop and socket
starts the ioLoop and sends the client the information that the client started successfully.</div>
</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#close--">close</a></span>()</code>
<div class="block">this method is for closing the process</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../new_build/models/network_organisation/Group.html" title="class in new_build.models.network_organisation">Group</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#getGroupByName-java.lang.String-">getGroupByName</a></span>(java.lang.String&nbsp;groupName)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../new_build/models/network_organisation/UserLogin.html" title="class in new_build.models.network_organisation">UserLogin</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#getSendingUser--">getSendingUser</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#keepRunning--">keepRunning</a></span>()</code>
<div class="block">for (endless) loop (the code has to keep running..)</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#listenToMessages--">listenToMessages</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#main-java.lang.String:A-">main</a></span>(java.lang.String[]&nbsp;args)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#processMessage-new_build.models.common.messages.Message-">processMessage</a></span>(<a href="../../../new_build/models/common/messages/Message.html" title="class in new_build.models.common.messages">Message</a>&nbsp;message)</code>
<div class="block">if the message is in an expected class, the message will be displayed</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#sendMessage-new_build.models.common.messages.Message-">sendMessage</a></span>(<a href="../../../new_build/models/common/messages/Message.html" title="class in new_build.models.common.messages">Message</a>&nbsp;m)</code>
<div class="block">message will forwarded to the class ioLoop and handled there.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../new_build/client/controller/ClientController.html#shutDown-int-">shutDown</a></span>(int&nbsp;status)</code>
<div class="block">will exit the process (shut down the process: the keepRunning method will be quit)</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="connection">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connection</h4>
<pre>private&nbsp;<a href="../../../new_build/models/network_organisation/Connection.html" title="class in new_build.models.network_organisation">Connection</a> connection</pre>
</li>
</ul>
<a name="view">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>view</h4>
<pre>private&nbsp;<a href="../../../new_build/models/client_interfaces/ClientView.html" title="interface in new_build.models.client_interfaces">ClientView</a> view</pre>
</li>
</ul>
<a name="keepRunning">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepRunning</h4>
<pre>private volatile&nbsp;boolean keepRunning</pre>
</li>
</ul>
<a name="loggedInUser">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loggedInUser</h4>
<pre>private volatile&nbsp;<a href="../../../new_build/models/network_organisation/UserLogin.html" title="class in new_build.models.network_organisation">UserLogin</a> loggedInUser</pre>
</li>
</ul>
<a name="knownTeamMap">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>knownTeamMap</h4>
<pre>private volatile&nbsp;java.util.HashMap&lt;<a href="../../../new_build/models/network_organisation/Group.html" title="class in new_build.models.network_organisation">Group</a>,<a href="../../../new_build/models/network_organisation/GroupInformation.html" title="class in new_build.models.network_organisation">GroupInformation</a>&gt; knownTeamMap</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ClientController-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClientController</h4>
<pre>private&nbsp;ClientController(java.lang.String&nbsp;targetIp,
int&nbsp;portToListenTo)</pre>
<div class="block">delivers targetIp and portToListenTo to the constructor
builds a new array, LinkedList, connection, ioLoop and socket
starts the ioLoop and sends the client the information that the client started successfully.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetIp</code> - </dd>
<dd><code>portToListenTo</code> - </dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="keepRunning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepRunning</h4>
<pre>public&nbsp;boolean&nbsp;keepRunning()</pre>
<div class="block">for (endless) loop (the code has to keep running..)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getGroupByName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupByName</h4>
<pre>public&nbsp;<a href="../../../new_build/models/network_organisation/Group.html" title="class in new_build.models.network_organisation">Group</a>&nbsp;getGroupByName(java.lang.String&nbsp;groupName)</pre>
</li>
</ul>
<a name="getSendingUser--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSendingUser</h4>
<pre>public&nbsp;<a href="../../../new_build/models/network_organisation/UserLogin.html" title="class in new_build.models.network_organisation">UserLogin</a>&nbsp;getSendingUser()</pre>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block">this method is for closing the process</div>
</li>
</ul>
<a name="shutDown-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutDown</h4>
<pre>public&nbsp;void&nbsp;shutDown(int&nbsp;status)</pre>
<div class="block">will exit the process (shut down the process: the keepRunning method will be quit)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>status</code> - </dd>
</dl>
</li>
</ul>
<a name="processMessage-new_build.models.common.messages.Message-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processMessage</h4>
<pre>public&nbsp;void&nbsp;processMessage(<a href="../../../new_build/models/common/messages/Message.html" title="class in new_build.models.common.messages">Message</a>&nbsp;message)</pre>
<div class="block">if the message is in an expected class, the message will be displayed</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - </dd>
</dl>
</li>
</ul>
<a name="sendMessage-new_build.models.common.messages.Message-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre>public&nbsp;void&nbsp;sendMessage(<a href="../../../new_build/models/common/messages/Message.html" title="class in new_build.models.common.messages">Message</a>&nbsp;m)</pre>
<div class="block">message will forwarded to the class ioLoop and handled there.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>m</code> - </dd>
</dl>
</li>
</ul>
<a name="listenToMessages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listenToMessages</h4>
<pre>private&nbsp;void&nbsp;listenToMessages()</pre>
</li>
</ul>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)</pre>
</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/ClientController.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?new_build/client/controller/ClientController.html" target="_top">Frames</a></li>
<li><a href="ClientController.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>