Changes between Version 9 and Version 10 of WikiStart

Timestamp:

03/11/19 13:45:47 (6 years ago)

Author:

wouter

Comment:

--

WikiStart

@@ -33 +33 @@
 
 
+
+
 == The source code
 You can read the source code through the "Browse source" button at the top of this page. You can check out the source code through svn with
@@ -39 +41 @@
 }}}
 
+
+=Technical insides
+
+This section deals with the techniques inside the runserver 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 sessions and tournaments from a script.
+
+==Communication protocol
+
+This section describes the communication protocols with the runserver. Other implementations of a runserver should adhere to the same communication protocols to ensure compatibility with genius2. 
+
+=== RunSession 
+The main service available on the runserver is the RunSession service. It is available at http://runserver/runsession.
+This service starts up and runs a complete session when it is accessed (http get or post).
+To start a session, the http get must include a JSON-serialized genius2.protocol.session.SessionSettings object. Typically this looks like this (assuming you want to use SAOP protocol):
+{{{
+{"SAOPSettings": {
+    "participants":[
+        {"party":"http://party1","profile":"ws://profile1"},
+        {"party":"http://party2","profile":"ws://profile2"}],
+    "deadline":{"deadlinetime":{"millis":100}}
+}}
+}}}
+
+The "SAOPSettings" indicates that these settings are SAOPSettings and (see Settings.getProtocol) will be interpreted by the SAOP protocol.
+
+The participants is a list with PartyWithProfile items: a "party" field containing a http address on a partiesserver, and a "profile" field containing a websocket address on a profilesserver.
+
+The deadline contains the deadline for the SAOP, which is how long the negotiation can last.
+
+