Changes between Version 53 and Version 54 of WikiStart

Timestamp:

11/11/19 12:12:34 (5 years ago)

Author:

wouter

Comment:

--

WikiStart

@@ -112 +112 @@
 /free is just a plain (non-websocket) connection that immediately returns an integer number with the number of available slots for running new party instances at this moment.
 
+=== Communicating with the party through the websocket
+As mentioned, the /run command returns a websocket address through which communication with the running party instance takes place.
+
+The connection thus created allows Inform JSON objects to be sent to the party, and Action JSON objects to be sent by the party. The protocol determines the meaning and order of these.
+
+If the party throws an exception, this exception should cause the socket to close (as a party can only do Actions). A close reason can only have a 123 character explanation which generally is too short for stacktraces. It is recommended therefore that such explanation is a reasonably human readable abstract of the full cause. The full stacktrace can be shown/logged in full detail on the partyserver.  
+
 == Detecting termination of a party
 The partiesserver does not have a separate communication protocol to hear when parties have been terminated. Instead, the PartySocket (that the partiesserver provides for communication between the party and the server) is sniffed for characteristic termination events. The following events are considered indicative for termination: