[telepathy-spec/master] Stream.I.Media: cross-ref RetrievedServerInfo with ServerInfoRetrieved, add rationale

Simon McVittie simon.mcvittie at collabora.co.uk
Tue Dec 1 05:16:42 PST 2009


---
 spec/Call_Stream_Interface_Media.xml |   18 ++++++++++++------
 1 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/spec/Call_Stream_Interface_Media.xml b/spec/Call_Stream_Interface_Media.xml
index 83b7b3d..449c189 100644
--- a/spec/Call_Stream_Interface_Media.xml
+++ b/spec/Call_Stream_Interface_Media.xml
@@ -273,9 +273,10 @@
     <signal name="ServerInfoRetrieved"
       tp:name-for-bindings="Server_Info_Retrieved">
       <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
-        <p> Signals that the initial information about STUN and Relay servers
-            has been retrieived.
-        </p>
+        <p>Signals that the initial information about STUN and Relay servers
+          has been retrieved, i.e. the
+          <tp:member-ref>RetrievedServerInfo</tp:member-ref> property is now
+          true.</p>
       </tp:docstring>
     </signal>
 
@@ -283,9 +284,14 @@
         tp:name-for-bindings="Retrieved_Server_Info" access="read">
       <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
         <p>True if the initial information about STUN servers and Relay servers
-           has been retrieved. Change notification via the ServerInfoRetrieved
-           signal.
-        </p>
+          has been retrieved. Change notification is via the
+          <tp:member-ref>ServerInfoRetrieved</tp:member-ref> signal.</p>
+
+        <tp:rationale>
+          <p>Streaming implementations that can't cope with STUN and relay
+            servers being added later SHOULD wait for this property
+            to become true before proceeding.</p>
+        </tp:rationale>
       </tp:docstring>
     </property>
 
-- 
1.5.6.5




More information about the telepathy-commits mailing list