[Telepathy-commits] [telepathy-spec/master] Tube Parameters: change the example to use 'smb'

Alban Crequy alban.crequy at collabora.co.uk
Tue Nov 18 09:54:20 PST 2008


---
 spec/Channel_Interface_Tube.xml |   10 +++++++---
 1 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/spec/Channel_Interface_Tube.xml b/spec/Channel_Interface_Tube.xml
index cd61b1d..6c61728 100644
--- a/spec/Channel_Interface_Tube.xml
+++ b/spec/Channel_Interface_Tube.xml
@@ -44,7 +44,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
               access="readwrite" tp:name-for-bindings="Parameters">
       <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
         <p>Each tube has a dictionary of arbitrary parameters. Parameters are
-          commonly used for bootstrap information. The allowable keys,
+          commonly used for bootstrap legacy protocols where you can't
+          negotiate parameters in-band. The allowable keys,
           types and values are defined by the service. Connection managers
           must support the value being a string (D-Bus type 's'), array of bytes
           (D-Bus type 'ay'), unsigned integer (D-Bus type 'u'), integer (D-Bus
@@ -52,8 +53,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
         <p>When the tube is offered, the parameters are transmitted with the
           offer and appear as a property of the incoming tube for other
           participants.</p>
-        <p>Example of valid parameters:
-          <code>{'game name': 'go', 'board size': 19}</code></p>
+        <p>Example of valid parameters for 'smb' Server Message Block over
+          TCP/IP (from <a href="http://www.dns-sd.org/ServiceTypes.html">DNS
+          SRV (RFC 2782) Service Types
+          http://www.dns-sd.org/ServiceTypes.html</a>):
+          <code>{'u': 'username', 'p': 'password', 'path': 'path'}</code></p>
         <p>When requesting a channel with 
           <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>,
           this property MAY be included in the request. If it is not included in
-- 
1.5.6.5




More information about the Telepathy-commits mailing list