Changes between Version 219 and Version 220 of WikiStart

Timestamp:

08/13/19 17:24:08 (5 years ago)

Author:

wouter

Comment:

--

WikiStart

@@ -127 +127 @@
 The main class is Party, which defines the basic functionality required for every negotiation party. The heart of the party is that your Party implements Connectable<Inform,Action>. Connectable contains 2 main functions: connect and disconnect.  When connect is called, your party receives a Connection over which it receives Inform objects and can send Action objects. What exactly is sent and received is determined by the protocol (see the protocol section below). For example if the SAOP protocol is used, your party will receive a YourTurn message, after which it decides on its action and sends it into the Connection. See also the example party discussed below. 
 
-The Inform objects are all available inside the inform package inside the party module.
+Please check the [source:party/src/main/java/geniusweb/party/inform source code of Inform objects] for all the details.
+
+The Settings is usually the first inform that a party receives. It contains the profile, protocol, and progress information for the upcoming session.
+
 
 == Timeline
-The timeline contains a deadline and a progress object.
-The deadline indicates how much time a negotiation session can take.
-The progress indicates where currently running session is towards the deadline.
+The timeline module describes the deadline and a progress objects.
+The deadline indicates how much time a negotiation session can take and is used to specify the settings for a session or tournament. Two examples:
+
+{{{
+{"deadlinerounds":{"rounds":100,"durationms":999}}
+}}}
+
+and
+{{{
+{"deadlinetime":{"durationms":2000}}
+}}}
+
+ * durationms indicates the maximum run time in milliseconds for the party. The clock starts ticking at the moment the party receives its SessionSettings object.
+ * rounds indicates the maximum number of rounds in the session. The session will end after this number of rounds, deal or no deal.
+
+The progress indicates where currently running session is towards the deadline. Progress is contained in the settings object. Round based progress must be updated by the party after each round. 
+ 
+
+
 
 == References