ParlorNet
Turn-based game server for any computer, old or new
Clients | Protocols | Browsers | Telnet programs | Docs | Source

Protocol declarations

Each server extension tells the core which protocol it serves, and the core lists what is connected. The web site's Protocols page, the welcome page's Other ways in, and any other frontend that wants to say "this server speaks these protocols" read that list instead of keeping a table of their own. The requests are in protocol.md; this note records the design.

What is declared

A protocol is declared by its key, the port players connect to, a name and a one-line description:

KeyDeclared byNameDescription
HTTPweb extensionHTTP and HTML 3.2HTML 3.2 pages for any browser with tables and forms
PARLOR/1the core itselfParlorNet protocol (PARLOR/1)ParlorNet's own protocol, for programs written for it
TELNETtelnet extensionTelnet with ANSI escape codesFull-screen menus and boards for terminal programs
IOSIOS extensionInternet Othello Server (IOS)Reversi for clients of the Internet Othello Server
FIBSFIBS extensionFirst Internet Backgammon Server (FIBS)Backgammon for vintage FIBS clients
OUTLANDOutland extensionOutlandBackgammon for the Outland Gateway on classic Macs

GGS is the key for a GGS extension when there is one. Each extension holds its own triple as PROTOCOL in its module; the port comes from its arguments (--public-port, else --port), so a container port published under another number is declared as the number players use.

The key is the protocol's name across ParlorNet: the docs site's protocols reference has an entry for each key at protocols.html#KEY, and the server's Protocols page, the docs site's client tables and setup pages all link there. In the anchor, any character of the key but letters, digits and - is written - (PARLOR/1 is #PARLOR-1), so the fragment is plain for old browsers (webstyle.protocol_anchor).

On the wire

Lifetime

A declaration belongs to the connection that made it and ends when that connection closes. "Connected" therefore means what it says: an extension that stops, or loses the core, drops off the list at once, and nothing has to expire it. Extensions open core connections per player (the web per request), so a declaration cannot ride on those: each extension keeps one connection of its own for it (adapters/declare.py). It sends its declaration again every 5 minutes, which keeps the connection under the core's idle limit (15 minutes) without any change to that limit, and connects again after the core restarts. That connection counts against the extension's share of the extension channel like any other.

Two connections may declare the same key and port (two copies of an extension): it is listed once. The same key on two ports is listed twice.

Compatibility

Nothing changes for an extension that does not declare: it works as before and is not listed. A core older than these requests answers PRO with ERR UNKNOWN; the extension's declaring task then stops, and its own pages work without the list (the web's Protocols page says the server has not listed its protocols). Clients on the public port that never send PRL see no difference.

Where it is shown

This doc on GitHub


 These pages cover every ParlorNet server. | Source code | ParlorNet is free software.