Documented new I2PControl API features.

This commit is contained in:
dev
2011-07-15 12:42:44 +00:00
parent ea12b45c65
commit 3386d4766b

View File

@ -61,7 +61,35 @@ Response:
<li>Result &ndash; [double] Returns the average value for the reuested rateStat and period.</li>
</ul>
</ul>
<ul>NetworkInfo &ndash; Fetches or sets various network related information. Ports, addresses etc.
<ul>RouterInfo &ndash; Fetches basic information about hte I2P router. Uptime, version etc.
<ul>Request
<li>*i2p.router.status &ndash; [n/a]</li>
<li>*i2p.router.uptime &ndash; [n/a]</li>
<li>*i2p.router.version &ndash; [n/a]</li>
<li>*i2p.router.net.status &ndash; [n/a]</li>
</ul>
<ul>Response
<li>**i2p.router.status &ndash; [String] What the status of the router is.</li>
<li>**i2p.router.uptime &ndash; [String] What the uptime of the router is.</li>
<li>**i2p.router.version &ndash; [String] What version of I2P the router is running.</li>
<li>**i2p.router.net.status &ndash; [String] What the current netowrk status is.</li>
</ul>
</ul>
<ul>RouterRunner &ndash; Manages I2P router restart/shutdown.
<ul>Request
<li>*Restart &ndash; [n/a] Restarts the router.</li>
<li>*RestartGraceful &ndash; [n/a] Restarts the router gracefully (waits for participating tunnels to expire).</li>
<li>*Shutdown &ndash; [n/a] Shuts down the router.</li>
<li>*ShutdownGraceful &ndash; [n/a] Shuts down the router gracefully (waits for participating tunnels to expire).</li>
</ul>
<ul>Response
<li>**Restart &ndash; [null] If requested, verifies that a restart has been initiated.</li>
<li>**RestartGraceful &ndash; [null] If requested, verifies that a graceful restart has been initiated.</li>
<li>**Shutdown &ndash; [null] If requested, verifies that a shutdown has been initiated</li>
<li>**ShutdownGraceful &ndash; [null] If requested, verifies that a graceful shutdown has been initiated</li>
</ul>
</ul>
<ul>NetworkSetting &ndash; Fetches or sets various network related settings. Ports, addresses etc.
<ul>Request
<li>*i2p.router.net.ntcp.port &ndash; [String] What port is used for the TCP transport. If null is submitted, current setting will be returned.</li>
<li>*i2p.router.net.ntcp.hostname &ndash; [String] What hostname is used for the TCP transport. If null is submitted, current setting will be returned.</li>