added more documentation

This commit is contained in:
Arvid Norberg 2008-01-10 22:44:53 +00:00
parent 471d81394d
commit f6b82e438a
2 changed files with 36 additions and 0 deletions

View File

@ -2214,6 +2214,10 @@ struct peer_info
on_parole = 0x200,
seed = 0x400,
optimistic_unchoke = 0x800,
writing = 0x1000,
reading = 0x2000,
waiting_write_quota = 0x4000,
waiting_read_quota = 0x8000,
rc4_encrypted = 0x100000,
plaintext_encrypted = 0x200000
};
@ -2343,6 +2347,22 @@ us in return an earn an upload/unchoke slot. If it
doesn't within some period of time, it will be choked
and another peer will be optimistically unchoked.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">writing</span></tt></td>
<td>The peer is currently waiting for a write operation
on the socket to complete.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">reading</span></tt></td>
<td>The peer is currently waiting for a read operation
on the socket to complete.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">waiting_write_quota</span></tt></td>
<td>The peer is currently waiting for the bandwidth-
manager to hand out more write quota to this peer.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">waiting_read_quota</span></tt></td>
<td>The peer is currently waiting for the bandwidth-
manager to hand out more read quota to this peer.</td>
</tr>
</tbody>
</table>
<p><tt class="docutils literal"><span class="pre">source</span></tt> is a combination of flags describing from which sources this peer

View File

@ -2203,6 +2203,10 @@ It contains the following fields::
on_parole = 0x200,
seed = 0x400,
optimistic_unchoke = 0x800,
writing = 0x1000,
reading = 0x2000,
waiting_write_quota = 0x4000,
waiting_read_quota = 0x8000,
rc4_encrypted = 0x100000,
plaintext_encrypted = 0x200000
};
@ -2316,6 +2320,18 @@ any combination of the enums above. The following table describes each flag:
| | doesn't within some period of time, it will be choked |
| | and another peer will be optimistically unchoked. |
+-------------------------+-------------------------------------------------------+
| ``writing`` | The peer is currently waiting for a write operation |
| | on the socket to complete. |
+-------------------------+-------------------------------------------------------+
| ``reading`` | The peer is currently waiting for a read operation |
| | on the socket to complete. |
+-------------------------+-------------------------------------------------------+
| ``waiting_write_quota`` | The peer is currently waiting for the bandwidth- |
| | manager to hand out more write quota to this peer. |
+-------------------------+-------------------------------------------------------+
| ``waiting_read_quota`` | The peer is currently waiting for the bandwidth- |
| | manager to hand out more read quota to this peer. |
+-------------------------+-------------------------------------------------------+
__ extension_protocol.html