[Telepathy-commits] [telepathy-spec/master] Move Type_Tube to Channel.Type.Tubes, remove the description of tubes in the introduction of Channel.Type.Stream|DBusTube, and remove property TubeType in the Channel.Interface.Tube
Alban Crequy
alban.crequy at collabora.co.uk
Wed Nov 19 06:15:01 PST 2008
20080807134447-a41c0-d40ef5a5fdc03e95e394d3a554cd8bcb7aaba282.gz
---
spec/Channel_Interface_Tube.xml | 55 --------------------------------------
spec/Channel_Type_DBusTube.xml | 30 ++++++++++++++++++++-
spec/Channel_Type_StreamTube.xml | 9 +++++-
spec/Channel_Type_Tubes.xml | 16 +++++++++++
4 files changed, 53 insertions(+), 57 deletions(-)
diff --git a/spec/Channel_Interface_Tube.xml b/spec/Channel_Interface_Tube.xml
index 18e7d33..fa6e26a 100644
--- a/spec/Channel_Interface_Tube.xml
+++ b/spec/Channel_Interface_Tube.xml
@@ -32,67 +32,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
HANDLE_TYPE_CONTACT and HANDLE_TYPE_ROOM.</p>
</tp:docstring>
- <tp:enum name="Tube_Type" type="u">
- <tp:enumvalue suffix="DBus" value="0">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>An ordered reliable transport, for transporting D-Bus
- traffic.</p>
-
- <p>For each D-Bus tube, the connection manager listens on a D-Bus
- server address, as detailed in the D-Bus specification. On this
- address, it emulates a bus upon which each tube participant appears
- as an endpoint.</p>
-
- <p>The objects and interfaces which are expected to exist on the
- emulated bus depend on the well-known name; typically, either the
- participant who initiated the tube is expected to export the same
- objects/interfaces that would be exported by a service of that name
- on a bus, or all participants are expected to export those
- objects/interfaces.</p>
-
- <p>In a multi-user context (Handle_Type_Room) the tube behaves
- like the D-Bus bus daemon, so participants can send each other
- private messages, or can send broadcast messages which are
- received by everyone in the tube (including themselves).
- Each participant has a D-Bus unique name; connection managers
- must prevent participants from sending messages with the wrong
- sender unique name, and should attempt to avoid participants
- receiving messages not intended for them.</p>
-
- <p>In a 1-1 context (Handle_Type_Contact) the tube behaves like
- a peer-to-peer D-Bus connection - arbitrary D-Bus messages with
- any sender and/or destination can be sent by each participant,
- and each participant receives all messages sent by the other
- participant.</p>
- </tp:docstring>
- </tp:enumvalue>
-
- <tp:enumvalue suffix="Stream" value="1">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>A transport for ordered, reliable data transfer, similar to
- SOCK_STREAM sockets.</p>
-
- <p>When accepting a Stream Unix tube, a new listening local socket is
- created. Each time the client connects to this socket, the
- connection manager of the initiator of the tube opens a new
- connection to its local socket. Both sides can then use this pair
- of sockets to communicate together.</p>
- </tp:docstring>
- </tp:enumvalue>
- </tp:enum>
-
<property name="Initiator" type="u" tp:type="Contact_Handle" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Initiator handle.</p>
</tp:docstring>
</property>
- <property name="TubeType" type="u" tp:type="Tube_Type" access="read">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Type of the tube.</p>
- </tp:docstring>
- </property>
-
<property name="Service" type="s" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Each tube has a service name, which is a string specifying the
diff --git a/spec/Channel_Type_DBusTube.xml b/spec/Channel_Type_DBusTube.xml
index d02779a..a2a10d8 100644
--- a/spec/Channel_Type_DBusTube.xml
+++ b/spec/Channel_Type_DBusTube.xml
@@ -21,7 +21,35 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<tp:requires interface="org.freedesktop.Telepathy.Channel"/>
<tp:requires interface="org.freedesktop.Telepathy.Channel.Interface.Tube"/>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p></p>
+ <p>A D-Bus tube is an ordered reliable transport, for transporting D-Bus
+ traffic.</p>
+
+ <p>For each D-Bus tube, the connection manager listens on a D-Bus
+ server address, as detailed in the D-Bus specification. On this
+ address, it emulates a bus upon which each tube participant appears
+ as an endpoint.</p>
+
+ <p>The objects and interfaces which are expected to exist on the
+ emulated bus depend on the well-known name; typically, either the
+ participant who initiated the tube is expected to export the same
+ objects/interfaces that would be exported by a service of that name
+ on a bus, or all participants are expected to export those
+ objects/interfaces.</p>
+
+ <p>In a multi-user context (Handle_Type_Room) the tube behaves
+ like the D-Bus bus daemon, so participants can send each other
+ private messages, or can send broadcast messages which are
+ received by everyone in the tube (including themselves).
+ Each participant has a D-Bus unique name; connection managers
+ must prevent participants from sending messages with the wrong
+ sender unique name, and should attempt to avoid participants
+ receiving messages not intended for them.</p>
+
+ <p>In a 1-1 context (Handle_Type_Contact) the tube behaves like
+ a peer-to-peer D-Bus connection - arbitrary D-Bus messages with
+ any sender and/or destination can be sent by each participant,
+ and each participant receives all messages sent by the other
+ participant.</p>
<p>When creating a channel of this type, some properties are
mandatory:</p>
diff --git a/spec/Channel_Type_StreamTube.xml b/spec/Channel_Type_StreamTube.xml
index 5cc21ae..0560277 100644
--- a/spec/Channel_Type_StreamTube.xml
+++ b/spec/Channel_Type_StreamTube.xml
@@ -21,7 +21,14 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<tp:requires interface="org.freedesktop.Telepathy.Channel"/>
<tp:requires interface="org.freedesktop.Telepathy.Channel.Interface.Tube"/>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p></p>
+ <p>A stream tube is a transport for ordered, reliable data transfer,
+ similar to SOCK_STREAM sockets.</p>
+
+ <p>When accepting a Stream Unix tube, a new listening local socket is
+ created. Each time the client connects to this socket, the
+ connection manager of the initiator of the tube opens a new
+ connection to its local socket. Both sides can then use this pair
+ of sockets to communicate together.</p>
<p>When creating a channel of this type, some properties are
mandatory:</p>
diff --git a/spec/Channel_Type_Tubes.xml b/spec/Channel_Type_Tubes.xml
index 246317a..0029f60 100644
--- a/spec/Channel_Type_Tubes.xml
+++ b/spec/Channel_Type_Tubes.xml
@@ -55,6 +55,22 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<tp:member type="u" tp:type="Tube_State" name="State"/>
</tp:struct>
+ <tp:enum name="Tube_Type" type="u">
+ <tp:enumvalue suffix="DBus" value="0">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>The tube is D-Bus tube as described by the
+ org.freedesktop.Telepathy.Channel.Type.DBusTube interface.</p>
+ </tp:docstring>
+ </tp:enumvalue>
+
+ <tp:enumvalue suffix="Stream" value="1">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>The tube is stream tube as described by the
+ org.freedesktop.Telepathy.Channel.Type.StreamTube interface.</p>
+ </tp:docstring>
+ </tp:enumvalue>
+ </tp:enum>
+
<tp:enum name="Tube_State" type="u">
<tp:enumvalue suffix="Local_Pending" value="0">
<tp:docstring>
--
1.5.6.5
More information about the Telepathy-commits
mailing list