Add PeerFinder README doc

This commit is contained in:
Vinnie Falco
2013-11-10 15:51:13 -08:00
parent d4d6acdf68
commit 67b8f95b1e
3 changed files with 36 additions and 0 deletions

View File

@@ -2101,6 +2101,7 @@
<None Include="..\..\src\ripple\json\impl\version" />
<None Include="..\..\README.md" />
<None Include="..\..\SConstruct" />
<None Include="..\..\src\ripple\peerfinder\README.md" />
<None Include="..\QtCreator\rippled.pro" />
</ItemGroup>
<ItemGroup>

View File

@@ -2404,6 +2404,9 @@
<None Include="..\..\LICENSE">
<Filter>%28Notes%29</Filter>
</None>
<None Include="..\..\src\ripple\peerfinder\README.md">
<Filter>[1] Ripple\peerfinder</Filter>
</None>
</ItemGroup>
<ItemGroup>
<Text Include="..\..\doc\todo\NIKB_TODO.txt">

View File

@@ -0,0 +1,32 @@
# PeerFinder
The PeerFinder module has these responsibilities:
- Maintain a set of addresses suitable for bootstrapping into the overlay.
- Send and receive protocol messages for peer address discovery.
- Provide network addresses to other peers that need them.
- Maintain connections to the configured set of fixed peers.
- Track and manage peer connection slots.
## Description
## Terms
<table>
<tr>
<td>Bootstrap</td>
<td>The process by which a Ripple peer obtains the initial set of
connections into the Ripple payment network overlay.
</td></tr>
</tr>
<tr>
<td>Overlay</td>
<td>The connected graph of Ripple peers, overlaid on the public Internet.
</td>
</tr>
<tr>
<td>Peer</td>
<td>A network server running the **rippled** daemon.
</td>
</tr>
</table>