ChatApp-AL-NM/Javadoc/chatapp/Protocol/UDPEchange.html
2021-01-24 12:44:43 +01:00

411 lines
16 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (13-ea) on Sun Jan 24 12:44:02 CET 2021 -->
<title>UDPEchange</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2021-01-24">
<meta name="description" content="declaration: package: chatapp.Protocol, class: UDPEchange">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../";
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="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">chatapp.Protocol</a></div>
<h1 title="Class UDPEchange" class="title">Class UDPEchange</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">chatapp.Protocol.UDPEchange</div>
</div>
<section class="description">
<hr>
<pre>public class <span class="typeNameLabel">UDPEchange</span>
extends java.lang.Object</pre>
<div class="block"><p>
Classe representant les échanges UDP entre utilisateurs.
</p></div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li class="blockList">
<section class="constructorSummary"><a id="constructor.summary">
<!-- -->
</a>
<h2>Constructor Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">UDPEchange</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ecouteUDP(chatapp.Controller.ChatApp)">ecouteUDP</a></span>&#8203;(<a href="../Controller/ChatApp.html" title="class in chatapp.Controller">ChatApp</a>&nbsp;app)</code></th>
<td class="colLast">
<div class="block">
Methode permettant la reception de messages d'utilisateurs à l'aide du protocole UDP</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EnvoiBroadcast(java.lang.String)">EnvoiBroadcast</a></span>&#8203;(java.lang.String&nbsp;broadcastMessage)</code></th>
<td class="colLast">
<div class="block">
Méthode permettant d'envoyer un message à tout les utilisateurs à l'aide du protocole UDP</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#envoiUnicast(java.net.InetAddress,java.lang.String)">envoiUnicast</a></span>&#8203;(java.net.InetAddress&nbsp;Adress,
java.lang.String&nbsp;Message)</code></th>
<td class="colLast">
<div class="block">
Méthode permettant d'envoyer un message a utilisateur en particulier
a l'aide du protocole UDP</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>static java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnecte()">getConnecte</a></span>()</code></th>
<td class="colLast">
<div class="block">Getter : Connecte</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>static java.net.InetAddress</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentIp()">getCurrentIp</a></span>()</code></th>
<td class="colLast">
<div class="block">
Getter : Ip
<br>Permet de recuperer l'adresse de l'hote sur le reseau au format IPv4.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>static java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPseudoValide()">getPseudoValide</a></span>()</code></th>
<td class="colLast">
<div class="block">Getter : Pseudo Valide</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConnecte(java.lang.Boolean)">setConnecte</a></span>&#8203;(java.lang.Boolean&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Setter : Connecte</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPseudoValide(java.lang.Boolean)">setPseudoValide</a></span>&#8203;(java.lang.Boolean&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Setter : PseudoValise</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li class="blockList">
<section class="constructorDetails"><a id="constructor.detail">
<!-- -->
</a>
<h2>Constructor Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;()">UDPEchange</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">UDPEchange</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="getConnecte()">getConnecte</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">java.lang.Boolean</span>&nbsp;<span class="memberName">getConnecte</span>()</div>
<div class="block">Getter : Connecte</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Le boolean connecte (True s'il peut se connecter avec ce nom d'utilisateur , False sinon)</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setConnecte(java.lang.Boolean)">setConnecte</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">setConnecte</span>&#8203;(<span class="arguments">java.lang.Boolean&nbsp;value)</span></div>
<div class="block">Setter : Connecte</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - La nouvelle valeur du boolean de connexion</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPseudoValide()">getPseudoValide</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">java.lang.Boolean</span>&nbsp;<span class="memberName">getPseudoValide</span>()</div>
<div class="block">Getter : Pseudo Valide</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Le boolean PseudoValide (True s'il peut utiliser ce pseudo , False sinon)</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="setPseudoValide(java.lang.Boolean)">setPseudoValide</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">setPseudoValide</span>&#8203;(<span class="arguments">java.lang.Boolean&nbsp;value)</span></div>
<div class="block">Setter : PseudoValise</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - La nouvelle valeur du boolean concernant le pseudo valide</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getCurrentIp()">getCurrentIp</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">java.net.InetAddress</span>&nbsp;<span class="memberName">getCurrentIp</span>()</div>
<div class="block"><p>
Getter : Ip
<br>Permet de recuperer l'adresse de l'hote sur le reseau au format IPv4.
<br> Si plusieurs adresses sont disponibles (plusieurs cartes réseaux), choisit la premiere trouvée
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>L'adresse IP au format IPv4</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="EnvoiBroadcast(java.lang.String)">EnvoiBroadcast</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">EnvoiBroadcast</span>&#8203;(<span class="arguments">java.lang.String&nbsp;broadcastMessage)</span>
throws <span class="exceptions">java.io.IOException</span></div>
<div class="block"><p>
Méthode permettant d'envoyer un message à tout les utilisateurs à l'aide du protocole UDP
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>broadcastMessage</code> - Message à transmettre aux utilisateurs</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="ecouteUDP(chatapp.Controller.ChatApp)">ecouteUDP</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">ecouteUDP</span>&#8203;(<span class="arguments"><a href="../Controller/ChatApp.html" title="class in chatapp.Controller">ChatApp</a>&nbsp;app)</span></div>
<div class="block"><p>
Methode permettant la reception de messages d'utilisateurs à l'aide du protocole UDP
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>app</code> - L'application de chat de l'utilisateur qui receptionne le message</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="envoiUnicast(java.net.InetAddress,java.lang.String)">envoiUnicast</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">envoiUnicast</span>&#8203;(<span class="arguments">java.net.InetAddress&nbsp;Adress,
java.lang.String&nbsp;Message)</span>
throws <span class="exceptions">java.io.IOException</span></div>
<div class="block"><p>
Méthode permettant d'envoyer un message a utilisateur en particulier
a l'aide du protocole UDP
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>Adress</code> - L'adresse IP de l'utilisateur</dd>
<dd><code>Message</code> - Message message à transmettre a l'utilisateur</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>