docs/templates/pages/proto/services.html

78 lines
2.3 KiB
HTML

{% extends "konami.html" %}
{% block title %}services{% endblock %}
{% block body %}
<h1><code>services</code></h1>
<h2 id="get"><code>services.get</code></h2>
<h3>Request:</h3>
<pre>{% highlight "cxml" %}<call ...>
<services method="get" model*="" >
<info>
<AVS2 __type="str">AVS2 version</AVS2>
</info>
</services>
</call>{% endhighlight %}</pre>
<h3>Response:</h3>
<pre>{% highlight "cxml" %}<response>
<services expire="" method="get" mode="" status="??status">
<item[] name="??service" url="??url" />
</services>
</response>{% endhighlight %}</pre>
<p>Known services are:</p>
<ul>
<li><code>ntp</code></li>
<li><code>keepalive</code></li>
<li><code>cardmng</code></li>
<li><code>facility</code></li>
<li><code>message</code></li>
<li><code>numbering</code></li>
<li><code>package</code></li>
<li><code>pcbevent</code></li>
<li><code>pcbtracker</code></li>
<li><code>pkglist</code></li>
<li><code>posevent</code></li>
<li><code>userdata</code></li>
<li><code>userid</code></li>
<li><code>eacoin</code></li>
<li><code>local</code></li>
<li><code>local2</code></li>
<li><code>lobby</code></li>
<li><code>lobby2</code></li>
<li><code>dlstatus</code></li>
<li><code>netlog</code></li>
<li><code>sidmgr</code></li>
<li><code>globby</code></li>
</ul>
<p>Most of these will usually just return the URL to the eAmuse server (or your fake one ;D). <code>ntp</code> is a
notable exception, unless you're planning on reimplementing NTP.</p>
<p><code>keepalive</code> is a url with the following query parameters:</p>
<table>
<tr>
<td><code>pa</code></td>
<td></td>
</tr>
<tr>
<td><code>ia</code></td>
<td>Router IP</td>
</tr>
<tr>
<td><code>ga</code></td>
<td>Gateway IP</td>
</tr>
<tr>
<td><code>ma</code></td>
<td>Centre IP</td>
</tr>
<tr>
<td><code>t1</code></td>
<td></td>
</tr>
<tr>
<td><code>t2</code></td>
<td></td>
</tr>
</table>
<p>All service URLs have a maximum length of 128 characters.</p>
<p><code>mode</code> is one of <code>operation</code>, <code>debug</code>, <code>test</code>, or
<code>factory</code>.
</p>
{% endblock %}