[Telepathy-commits] [telepathy-spec/master] Add interface Channel.Type.Tube

[Alban Crequy]

20080805182703-a41c0-85e899c232d10e300f654cbbc27a2feddba669a0.gz
---
 spec/Channel_Type_Tube.xml |   93 ++++++++++++++++++++++++++++++++++++++++++++
 spec/all.xml               |    1 +
 2 files changed, 94 insertions(+), 0 deletions(-)
 create mode 100644 spec/Channel_Type_Tube.xml

diff --git a/spec/Channel_Type_Tube.xml b/spec/Channel_Type_Tube.xml
new file mode 100644
index 0000000..8546a92
--- /dev/null
+++ b/spec/Channel_Type_Tube.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" ?>
+<node name="/Channel_Type_Tube" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+  <tp:copyright>Copyright (C) 2008 Collabora Limited</tp:copyright>
+  <tp:copyright>Copyright (C) 2008 Nokia Corporation</tp:copyright>
+  <tp:license>
+    This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+  </tp:license>
+  <interface name="org.freedesktop.Telepathy.Channel.Type.Tube">
+    <tp:requires interface="org.freedesktop.Telepathy.Channel"/>
+    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+      <p>A "tube" is a mechanism for arbitrary data transfer. A tube channel
+        can contain only one tube. This interface contains the properties,
+        signals and methods common to all types of tubes. One cannot create a
+        tube channel of type org.freedesktop.Telepathy.Channel.Type.Tube but
+        only channels of a specific type tube channel. Only stream and D-Bus
+        tubes exist currently. They have their own interface and their
+        interface can be used to create a tube channel.</p>
+
+      <p>The Tubes channel type may be requested for handles of type
+        HANDLE_TYPE_CONTACT and HANDLE_TYPE_ROOM.</p>
+    </tp:docstring>
+
+    <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="ServiceName" 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
+          kind of communication that takes place over it.</p>
+      </tp:docstring>
+    </property>
+
+    <property name="Parameters" type="a{sv}" access="read">
+      <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 such as usernames and
+          passwords.</p>
+      </tp:docstring>
+    </property>
+
+    <tp:enum name="Tube_Channel_State" type="u">
+      <tp:enumvalue suffix="Local_Pending" value="0">
+        <tp:docstring>
+          The tube is waiting to be accepted/closed locally.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Remote_Pending" value="1">
+        <tp:docstring>
+          The tube is waiting to be accepted/closed remotely.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Open" value="2">
+        <tp:docstring>
+          The tube is open for traffic.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Not_Offered" value="3">
+        <tp:docstring>
+          The tube is not yet offered.
+        </tp:docstring>
+      </tp:enumvalue>
+    </tp:enum>
+
+    <signal name="TubeChannelStateChanged">
+      <tp:docstring>
+        Emitted when the state of the tube channel changes.
+      </tp:docstring>
+      <arg name="state" type="u" tp:type="Tube_Channel_State">
+        <tp:docstring>
+          The new state of the tube; see the Tube_Channel_State enumeration.
+        </tp:docstring>
+      </arg>
+    </signal>
+
+  </interface>
+
+</node>
+<!-- vim:set sw=2 sts=2 et ft=xml: -->
diff --git a/spec/all.xml b/spec/all.xml
index eda2e01..f7015e6 100644
--- a/spec/all.xml
+++ b/spec/all.xml
@@ -53,6 +53,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
 <xi:include href="Channel_Type_Room_List.xml"/>
 <xi:include href="Channel_Type_Text.xml"/>
 <xi:include href="Channel_Type_Tubes.xml"/>
+<xi:include href="Channel_Type_Tube.xml"/>
 
 <xi:include href="Channel_Interface_Call_Merging.xml"/>
 <xi:include href="Channel_Interface_Call_State.xml"/>
-- 
1.5.6.5