Changes between Version 336 and Version 337 of WikiStart

Timestamp:

07/30/20 15:07:56 (4 years ago)

Author:

wouter

Comment:

--

WikiStart

@@ -253 +253 @@
 * The "better" field contains a list of tuples of numbers. Presence of a tuple (A,B) in this list indicates that bids[A] >= bids[B] where bids[X] means the Xth element in the bids list, 0 being the first element. 
 
-
+== ProfileConnectionFactory
+Parties receive a ProfileReference which is an URI from which they can fetch the profile.
+In a server configuration this usually will be a websocket, in testing conditions this usually will be a file. 
+The ProfileConnectionFactory handles the burden of decyphering the URI, connecting in the right way, waiting for the response, parsing the JSON code to an object etc. The typical use is
+{{{
+        profileint = ProfileConnectionFactory.create(URI, reporter);
+}}}
+
+This returns a ProfileInterface for further use.
+
+You can now use this profileint in two ways
+1. Listen for updates: {{{profileint.addListener(yourListener) }}}. yourListener will be called every time a new profile is available
+2. Use the latest version of the profile whenever you need it, and wait for it if there is no version available yet. {{{currentProfile=profileint.getProfile()}}}.
+
+There is a limitation on the ProfileConnectionFactory that might become relevant if you handle very large profiles: the websocket handler is currently limited to profiles of at most 200kB in size. This is because websockets use fixed buffer sizes. Let us know if this is an issue, we can change this limit.
 
 == Party