Changes between Version 56 and Version 57 of WikiStart
- Timestamp:
- 09/24/19 11:34:10 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiStart
v56 v57 78 78 = Communication protocol 79 79 80 T ODO clarify what is MUST80 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. 81 81 82 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 GeniusWeb.82 Other implementations of a runserver should adhere to the same communication protocols to ensure compatibility with GeniusWeb. 83 83 84 84 === Run Negotiation 85 85 This section describes the [source:/src/main/java/geniusweb/runserver/RunNego.java RunNego] service. It is available at {{{http:..:8080//runserver/run}}}. 86 86 This service starts up and runs a complete Nego (session or tournament) when it is accessed (http get or post). 87 To start a negotiation, the http get must include a JSON-serialized [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWeb/browser/protocol/src/main/java/geniusweb/protocol/NegoSettings.java geniusweb.protocol.NegoSettings] object. All details are in the javadocs, here we discuss it only briefly.87 To start a negotiation, the http get must include a JSON-serialized [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWeb/browser/protocol/src/main/java/geniusweb/protocol/NegoSettings.java geniusweb.protocol.NegoSettings] header. 88 88 89 After session is started, popup shows the negotiation ID. The ID starts with the name of the protocol (SAOP, APP) followed by a serial number.90 89 91 Typically the settings looks like this (session with SAOP protocol): 90 The contents of NegoSettings depends on the type of session/tournament that is to be run and is determined by the protocol. All details are in the javadocs, see the [https://tracinsy.ewi.tudelft.nl/pubtrac/GeniusWeb main wiki page]. 91 92 The format of the settings are determined by the protocol. 93 94 Typically the session settings looks like this: 92 95 {{{ 93 96 {"SAOPSettings": { … … 101 104 The "SAOPSettings" indicates that these settings are SAOPSettings and (see Settings.getProtocol) will be interpreted by the SAOP protocol. 102 105 103 104 106 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. 105 107 106 108 The deadline contains the deadline for the SAOP, which is how long the negotiation can last. 107 109 108 To run a tournament, the NegoSettings typically look like this: 110 For different protocols, the contents will differ. 111 112 For a tournament, the NegoSettings typically look like this: 109 113 {{{ 110 114 {"AllPermutationsSettings":{