Changes between Version 19 and Version 20 of WikiStart

Timestamp:

03/11/19 13:05:55 (6 years ago)

Author:

wouter

Comment:

--

WikiStart

@@ -27 +27 @@
 
 
-= Communication protocol =
-The parties server is a component in the bigger genius2 framework. Its mains function are 
+= Technical insides =
+This section deals with the techniques inside the parties server and may be relevant when you need to communicate directly with it, e.g. when you build your own GUI or start up your own parties from a script.
 
-1. Provide a list of available parties on the server
-2. Create a running instance of a party on request
+== Communication protocol
+The parties server is a component in the bigger genius2 framework. Its mains function are discussed in the following subsections. Other implementations of a partiesserver should adhere to the same communication protocols to ensure compatibility with genius2.
 
-@1 TODO describe PartiesListSocket protocol. 
+=== Provide a list of available parties on the server
+When a client accesses the partiesserver at ws:partiesserver/websocket/available, a websocket is created. This websocket sends the parties list as a JSON list, each list element containing a GeneralPartyInfo object. 
 
-@2 
+A GeneralPartyInfo object contains the following: 
+{{{
+        URI                        uri;
+        genius2.party.Capabilities capabilities;
+        String                     description;
+}}}
+
+These fields are automatically generated from the parties contained in the jar files in the {{{partiesserver/partiesrepo}}} directory that was mentioned above.
+
+A new list is sent over the websocket every time the list changes.
+
+=== Create new running instance of a party
+The following steps are needed to create a new running instance of a party.
+
 * create an running instance of a party when a certain address on the server is requested
 * It then returns the address of a a websocket on which the party can be contacted. Usually this websocket will be on the same computer, but it might be elsewhere)