flavien
/
Projet_JAVA_P2P_STRI2A
3
2
Fork 0
Code Issues 11 Pull Requests Releases 13 Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
1.1
1.1.1
1.2
1.3
1.4
1.5
1.5.1
1.6
1.7
1.7.1
1.7.2
1.7.3
1.7.4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'db1c7ac6b2'
${ noResults }
Projet_JAVA_P2P_STRI2A/doc/javadoc/protocolP2P/RatioResponse.html

549 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (1.8.0_181) on Mon Apr 13 15:38:51 CEST 2020 -->
<title>RatioResponse</title>
<meta name="date" content="2020-04-13">
<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="RatioResponse";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All 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/RatioResponse.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><a href="../protocolP2P/RatioRequest.html" title="class in protocolP2P"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../protocolP2P/Register.html" title="class in protocolP2P"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?protocolP2P/RatioResponse.html" target="_top">Frames</a></li>
<li><a href="RatioResponse.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">protocolP2P</div>
<h2 title="Class RatioResponse" class="title">Class RatioResponse</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../protocolP2P/Payload.html" title="class in protocolP2P">protocolP2P.Payload</a></li>
<li>
<ul class="inheritance">
<li>protocolP2P.RatioResponse</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">RatioResponse</span>
extends <a href="../protocolP2P/Payload.html" title="class in protocolP2P">Payload</a></pre>
<div class="block">Representation of payload for ratio response.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>1.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Louis Royer, Flavien Haas, JS Auge</dd>
</dl>
</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="../tools/HostItem.html" title="class in tools">HostItem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#hostItem">hostItem</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#HOSTNAME_START_POSITION">HOSTNAME_START_POSITION</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#PORT_START_POSITION">PORT_START_POSITION</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#TOTAL_DOWN_START_POSITION">TOTAL_DOWN_START_POSITION</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#TOTAL_UP_START_POSITION">TOTAL_UP_START_POSITION</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#totalDown">totalDown</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#totalUp">totalUp</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.protocolP2P.Payload">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;protocolP2P.<a href="../protocolP2P/Payload.html" title="class in protocolP2P">Payload</a></h3>
<code><a href="../protocolP2P/Payload.html#PAYLOAD_SIZE_POSITION">PAYLOAD_SIZE_POSITION</a>, <a href="../protocolP2P/Payload.html#PAYLOAD_START_POSITION">PAYLOAD_START_POSITION</a>, <a href="../protocolP2P/Payload.html#requestResponseCode">requestResponseCode</a></code></li>
</ul>
</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>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#RatioResponse-byte:A-">RatioResponse</a></span>(byte[]&nbsp;packet)</code>
<div class="block">Constructor (typically used by client/server) with a byte[] parameter containing the Packet received.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#RatioResponse-tools.HostItem-long-long-">RatioResponse</a></span>(<a href="../tools/HostItem.html" title="class in tools">HostItem</a>&nbsp;hostItem,
long&nbsp;totalUp,
long&nbsp;totalDown)</code>
<div class="block">Constructor with hostItem (typically used by tracker)</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="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><a href="../tools/HostItem.html" title="class in tools">HostItem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#getHostItem--">getHostItem</a></span>()</code>
<div class="block">HostItem getter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#getTotalDown--">getTotalDown</a></span>()</code>
<div class="block">totalDown getter.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#getTotalUp--">getTotalUp</a></span>()</code>
<div class="block">totalUp getter.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../protocolP2P/RatioResponse.html#toPacket--">toPacket</a></span>()</code>
<div class="block">Returns a byte[] containing Packet with padding.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.protocolP2P.Payload">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;protocolP2P.<a href="../protocolP2P/Payload.html" title="class in protocolP2P">Payload</a></h3>
<code><a href="../protocolP2P/Payload.html#getPayloadSize-byte:A-">getPayloadSize</a>, <a href="../protocolP2P/Payload.html#getRequestResponseCode--">getRequestResponseCode</a>, <a href="../protocolP2P/Payload.html#setPayloadSize-int-byte:A-">setPayloadSize</a></code></li>
</ul>
<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="hostItem">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hostItem</h4>
<pre>private&nbsp;<a href="../tools/HostItem.html" title="class in tools">HostItem</a> hostItem</pre>
</li>
</ul>
<a name="totalUp">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>totalUp</h4>
<pre>private&nbsp;long totalUp</pre>
</li>
</ul>
<a name="totalDown">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>totalDown</h4>
<pre>private&nbsp;long totalDown</pre>
</li>
</ul>
<a name="TOTAL_UP_START_POSITION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TOTAL_UP_START_POSITION</h4>
<pre>private static final&nbsp;int TOTAL_UP_START_POSITION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#protocolP2P.RatioResponse.TOTAL_UP_START_POSITION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TOTAL_DOWN_START_POSITION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TOTAL_DOWN_START_POSITION</h4>
<pre>private static final&nbsp;int TOTAL_DOWN_START_POSITION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#protocolP2P.RatioResponse.TOTAL_DOWN_START_POSITION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PORT_START_POSITION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PORT_START_POSITION</h4>
<pre>private static final&nbsp;int PORT_START_POSITION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#protocolP2P.RatioResponse.PORT_START_POSITION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="HOSTNAME_START_POSITION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HOSTNAME_START_POSITION</h4>
<pre>private static final&nbsp;int HOSTNAME_START_POSITION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#protocolP2P.RatioResponse.HOSTNAME_START_POSITION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RatioResponse-tools.HostItem-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RatioResponse</h4>
<pre>public&nbsp;RatioResponse(<a href="../tools/HostItem.html" title="class in tools">HostItem</a>&nbsp;hostItem,
long&nbsp;totalUp,
long&nbsp;totalDown)
throws <a href="../localException/InternalError.html" title="class in localException">InternalError</a></pre>
<div class="block">Constructor with hostItem (typically used by tracker)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hostItem</code> - Host to get ratio of.</dd>
<dd><code>totalUp</code> - total bytes uploaded</dd>
<dd><code>totalDown</code> - total bytes downloaded</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../localException/InternalError.html" title="class in localException">InternalError</a></code></dd>
</dl>
</li>
</ul>
<a name="RatioResponse-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RatioResponse</h4>
<pre>protected&nbsp;RatioResponse(byte[]&nbsp;packet)
throws <a href="../localException/SizeError.html" title="class in localException">SizeError</a>,
<a href="../localException/ProtocolError.html" title="class in localException">ProtocolError</a>,
<a href="../localException/InternalError.html" title="class in localException">InternalError</a>,
<a href="../localException/TransmissionError.html" title="class in localException">TransmissionError</a></pre>
<div class="block">Constructor (typically used by client/server) with a byte[] parameter containing the Packet received.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packet</code> - the full Packet received</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../localException/SizeError.html" title="class in localException">SizeError</a></code></dd>
<dd><code><a href="../localException/InternalError.html" title="class in localException">InternalError</a></code></dd>
<dd><code><a href="../localException/ProtocolError.html" title="class in localException">ProtocolError</a></code></dd>
<dd><code><a href="../localException/TransmissionError.html" title="class in localException">TransmissionError</a></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="toPacket--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPacket</h4>
<pre>protected&nbsp;byte[]&nbsp;toPacket()
throws <a href="../localException/InternalError.html" title="class in localException">InternalError</a></pre>
<div class="block">Returns a byte[] containing Packet with padding.
This Packet is still incomplete and should not be send directly.
ProtocolP2PPacket will use this method to generate the complete Packet.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../protocolP2P/Payload.html#toPacket--">toPacket</a></code>&nbsp;in class&nbsp;<code><a href="../protocolP2P/Payload.html" title="class in protocolP2P">Payload</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Packet with padding</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../localException/InternalError.html" title="class in localException">InternalError</a></code></dd>
</dl>
</li>
</ul>
<a name="getHostItem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHostItem</h4>
<pre>public&nbsp;<a href="../tools/HostItem.html" title="class in tools">HostItem</a>&nbsp;getHostItem()</pre>
<div class="block">HostItem getter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>hostItem</dd>
</dl>
</li>
</ul>
<a name="getTotalUp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalUp</h4>
<pre>public&nbsp;long&nbsp;getTotalUp()</pre>
<div class="block">totalUp getter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>totalUp</dd>
</dl>
</li>
</ul>
<a name="getTotalDown--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTotalDown</h4>
<pre>public&nbsp;long&nbsp;getTotalDown()</pre>
<div class="block">totalDown getter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>totalDown</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/RatioResponse.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><a href="../protocolP2P/RatioRequest.html" title="class in protocolP2P"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../protocolP2P/Register.html" title="class in protocolP2P"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?protocolP2P/RatioResponse.html" target="_top">Frames</a></li>
<li><a href="RatioResponse.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>
Reference in New Issue View Git Blame Copy Permalink