Changes between Version 26 and Version 27 of WikiStart

Timestamp:

03/28/19 16:34:27 (6 years ago)

Author:

wouter

Comment:

--

WikiStart

@@ -65 +65 @@
 This section deals with the communication protocols with the  runserver. These 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. 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:..:8080//runserver/runsession}}}.
+=== Run Session 
+This section describes the RunSession service. It is available at {{{http:..:8080//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):
@@ -84 +84 @@
 The deadline contains the deadline for the SAOP, which is how long the negotiation can last.
 
-=== Running Sessions
+== Run Tournament
+This section describes the RunTournament service. It is available at {{{http:..:8080//runserver/runtournament}}}.
+This service starts up and runs a complete tournament when it is accessed (http get or post).
+To start a tournament, the http get must include a JSON-serialized genius2.protocol.session.TournamentSettings object. Typically this looks like this (assuming you want to use AllPermutations protocol):
+{{{
+{"AllPermutationsSettings":{
+ "parties":["http://server/../party1","http://server/../party2"],
+ "profiles":["ws://server/../profile1","ws://server/../profile2","ws://server/../profile3"],
+ "reuseParties":false,
+ "partiesPerSession":2,
+ "sessionsettings":{"SAOPSettings":{"participants":[],"deadline":{"deadlinetime":{"millis":10}}}}}}
+}}}
+
+The parties is a list of party URIs, just like in the session settings 
+
+The profiles is a list of profile URIs, just like in the session settings
+
+If reuseParties is set to to false, parties are drawn from the list without return. If it is set to true, parties are drawn with return (meaning all parties can occur multiple times in each session)
+
+partiesPerSession sets the number of parties (and matching profiles) for each session. Profiles are always drawn without return (never appear twice in a session)
+
+sessionsettings contains basically all the normal run-sessionsettings. This is used as a "template" for all sessions of the tournament. You can put any use any session setting here, and each session will be run according to the protocol you select here. In the example we use the SAOP protocol which takes participants and deadline as arguments, as discussed above. The participants list this time is empty, the AllPermutationsProtocol adds the the required parties to this list. So if you provide a non-empty list here, then these parties would be present in every session in the tournament.
+
+=== View Running Sessions
 The websocket address {{{ws:..runserver/websocket/sessions}}} sends updates of the current list of running sessions. The list is sent as a JSON List of strings , each string being the session ID of the running session. Every time the list changes, a new complete list is sent to clients listening to the websocket.
 
+=== View Running Tournaments
+The websocket address {{{ws:..runserver/websocket/tournaments}}} sends updates of the current list of running tournaments. The list is sent as a JSON List of strings , each string being the tournament ID of the running tournament. Every time the list changes, a new complete list is sent to clients listening to the websocket.
+