Documentation Index

The Elko server framework supports real-time stateful multiuser networked applications, such as multiplayer games, real-time auctions, or online messaging, all built around the Context-User-Item object model. This page is a guide to the available documentation.

Elko Tutorial	A programmer's walkthrough of the how to program server applications using Elko.
The Context-User-Item Object Model	A detailed explanation of the object model that is the key organizing abstraction for applications built using Elko.
JSON Messaging	Our conventions for using JSON to represent messages from one machine or process to another, both in traffic between client & server and in traffic among servers.
Server View of C-U-I	A description of the important objects in the Context-User-Item object model, in terms of how they are realized on the Context Server.
Client View of C-U-I	A description of the important objects in the Context-User-Item object model, in terms of how they are seen by clients.
Server Mods Reference	Mods are the main abstraction you will use to extend the Context Server's functionality to implement your application. However, in addition to programming new mods of your own, a variety of generally useful mods are already provided as part of the toolkit we distribute. This document describes these in detail.
Client Mods Reference	The various mods that come bundled with the server each introduce new message protocols that expose these mods' functionality to clients. These protocols are described here.
Server Javadoc Pages	Detailed documentation on the Java APIs for coding the server side of your application.
HTTP Transport for JSON Messaging	The protocol by which we efficiently synthesize a sessionful, symmetric, bidirectional, asynchronous message channel out of an ongoing series of transient, asymmetric, synchronous, RPC-style HTTP requests.
Director Server Protocols	A reference guide to the various protocols by which Directors provide their services to Context Servers.
Gatekeeper Server Protocols	A reference guide to the various protocols by which Gatekeepers provide their services to Directors and Context Servers.
Repository Server Protocols	A reference guide to the various protocols by which Repositories provide their services to other servers.
Presence Server Protocols	A reference guide to the various protocols by which Presence Servers provide their services to Context Servers.
Broker Server Protocols	A reference guide to the various protocols by which Brokers enable the various different kinds of servers to locate each other, and by which a Broker can manage the operation of the overall constellation of servers.
Server Configuration Property Reference	An excruciatingly detailed reference guide to all the various different Java property settings used to configure the various kinds of servers to do the things they do.