Changes between Version 56 and Version 57 of WikiStart


Ignore:
Timestamp:
09/24/19 11:34:10 (5 years ago)
Author:
wouter
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart

    v56 v57  
    7878= Communication protocol
    7979
    80 TODO clarify what is MUST
     80This 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.
    8181
    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.
     82Other implementations of a runserver should adhere to the same communication protocols to ensure compatibility with GeniusWeb.
    8383
    8484=== Run Negotiation
    8585This section describes the [source:/src/main/java/geniusweb/runserver/RunNego.java RunNego] service. It is available at {{{http:..:8080//runserver/run}}}.
    8686This 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.
     87To 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.
    8888
    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.
    9089
    91 Typically the settings looks like this (session with SAOP protocol):
     90The 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
     92The format of the settings are determined by the protocol.
     93
     94Typically the session settings looks like this:
    9295{{{
    9396{"SAOPSettings": {
     
    101104The "SAOPSettings" indicates that these settings are SAOPSettings and (see Settings.getProtocol) will be interpreted by the SAOP protocol.
    102105
    103 
    104106The 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.
    105107
    106108The deadline contains the deadline for the SAOP, which is how long the negotiation can last.
    107109
    108 To run a tournament, the NegoSettings typically look like this:
     110For different protocols, the contents will differ.
     111
     112For a tournament, the NegoSettings typically look like this:
    109113{{{
    110114{"AllPermutationsSettings":{