← Back to branch summary

~ubuntu-branches/ubuntu/utopic/telepathy-python/utopic

« back to all changes in this revision

Viewing changes to spec/Channel_Type_DBus_Tube.xml

  • Committer: Bazaar Package Importer
  • Author(s): Laurent Bigonville
  • Date: 2009-06-16 11:23:44 UTC
  • mfrom: (1.1.14 upstream) (8.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090616112344-sslc71m4xns7uv8i
Tags: 0.15.8-1
* New upstream release.
* debian/control:
  - Change package priority to optional
  - Bump Standards-Version to 3.8.1 (no further changes)
  - Be more verbose in package extended description

Show diffs side-by-side

added added

removed removed

Lines of Context:
spec/Channel_Type_DBus_Tube.xml
1
1
<?xml version="1.0" ?>
2
2
<node name="/Channel_Type_DBus_Tube" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
3
 
  <tp:copyright>Copyright (C) 2008 Collabora Limited</tp:copyright>
4
 
  <tp:copyright>Copyright (C) 2008 Nokia Corporation</tp:copyright>
 
3
  <tp:copyright>Copyright © 2008-2009 Collabora Limited</tp:copyright>
 
4
  <tp:copyright>Copyright © 2008-2009 Nokia Corporation</tp:copyright>
5
5
  <tp:license>
6
6
    This library is free software; you can redistribute it and/or
7
7
modify it under the terms of the GNU Lesser General Public
17
17
License along with this library; if not, write to the Free Software
18
18
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19
19
  </tp:license>
20
 
  <interface name="org.freedesktop.Telepathy.Channel.Type.DBusTube.DRAFT"
21
 
      tp:causes-havoc="experimental">
 
20
  <interface name="org.freedesktop.Telepathy.Channel.Type.DBusTube">
22
21
    <tp:requires interface="org.freedesktop.Telepathy.Channel"/>
23
 
    <tp:requires interface="org.freedesktop.Telepathy.Channel.Interface.Tube.DRAFT"/>
 
22
    <tp:requires interface="org.freedesktop.Telepathy.Channel.Interface.Tube"/>
24
23
    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
25
24
      <p>A D-Bus tube is an ordered reliable transport, for transporting D-Bus
26
25
        traffic.</p>
54
53
 
55
54
    </tp:docstring>
56
55
 
57
 
    <method name="OfferDBusTube" tp:name-for-bindings="Offer_DBus_Tube">
 
56
    <method name="Offer" tp:name-for-bindings="Offer">
58
57
      <tp:docstring>
59
58
        Offers a D-Bus tube providing the service specified.
60
59
      </tp:docstring>
 
60
      <arg direction="in" name="parameters" type="a{sv}"
 
61
        tp:type="String_Variant_Map">
 
62
        <tp:docstring>
 
63
          The dictionary of arbitrary
 
64
          <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.Interface.Tube">Parameters</tp:dbus-ref>
 
65
          to send with the tube offer.
 
66
        </tp:docstring>
 
67
      </arg>
 
68
      <arg direction="in" name="access_control" type="u" tp:type="Socket_Access_Control">
 
69
        <tp:docstring>
 
70
          The access control the connection manager applies to the D-Bus socket.
 
71
        </tp:docstring>
 
72
      </arg>
61
73
      <arg direction="out" name="address" type="s">
62
74
        <tp:docstring>
63
75
          The string describing the address of the private bus. The client
64
 
          SHOULD not attempt to connect to the address until the tube is open.
 
76
          SHOULD NOT attempt to connect to the address until the tube is open.
65
77
        </tp:docstring>
66
78
      </arg>
67
79
      <tp:possible-errors>
75
87
      </tp:possible-errors>
76
88
    </method>
77
89
 
78
 
    <method name="AcceptDBusTube" tp:name-for-bindings="Accept_DBus_Tube">
 
90
    <method name="Accept" tp:name-for-bindings="Accept">
79
91
      <tp:docstring>
80
92
        Accept a D-Bus tube that's in the "local pending" state. The
81
93
        connection manager will attempt to open the tube. The tube remains in
82
 
        the "local pending" state until the TubeStateChanged signal is
83
 
        emitted.
 
94
        the "local pending" state until the <tp:dbus-ref
 
95
          namespace="org.freedesktop.Telepathy.Channel.Interface.Tube">TubeChannelStateChanged</tp:dbus-ref>
 
96
        signal is emitted.
84
97
      </tp:docstring>
 
98
      <arg direction="in" name="access_control" type="u" tp:type="Socket_Access_Control">
 
99
        <tp:docstring>
 
100
          The access control the connection manager applies to the D-Bus socket.
 
101
        </tp:docstring>
 
102
      </arg>
85
103
      <arg direction="out" name="address" type="s">
86
104
        <tp:docstring>
87
105
          The string describing the address of the private bus. The client
88
 
          SHOULD not attempt to connect to the address until the tube is open.
 
106
          SHOULD NOT attempt to connect to the address until the tube is open.
89
107
        </tp:docstring>
90
108
      </arg>
91
109
    </method>
96
114
        participant opens or closes the tube.  This provides change
97
115
        notification for the <tp:member-ref>DBusNames</tp:member-ref> property.
98
116
      </tp:docstring>
99
 
      <arg name="added" type="a{us}" tp:type="DBus_Tube_Participants">
 
117
      <arg name="Added" type="a{us}" tp:type="DBus_Tube_Participants">
100
118
        <tp:docstring>
101
119
          Array of handles and D-Bus names of new participants.
102
120
        </tp:docstring>
103
121
      </arg>
104
 
      <arg name="removed" type="au" tp:type="Contact_Handle[]">
 
122
      <arg name="Removed" type="au" tp:type="Contact_Handle[]">
105
123
        <tp:docstring>
106
124
          Array of handles of former participants.
107
125
        </tp:docstring>
113
131
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
114
132
        <p>A string representing the service name that will be used over the
115
133
          tube. It SHOULD be a well-known D-Bus service name, of the form
116
 
          com.example.ServiceName.</p>
 
134
          <tt>com.example.ServiceName</tt>.</p>
117
135
        <p>When the tube is offered, the service name is transmitted to the
118
136
          other end.</p>
119
137
        <p>When requesting a channel with
120
 
          <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>,
 
138
          <tp:dbus-ref
 
139
            namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>,
121
140
          this property MUST be included in the request.</p>
122
141
      </tp:docstring>
123
142
    </property>
149
168
      </tp:member>
150
169
    </tp:mapping>
151
170
 
 
171
    <property name="SupportedAccessControls" type="au"
 
172
              tp:type="Socket_Access_Control[]" access="read"
 
173
              tp:name-for-bindings="Supported_Access_Controls">
 
174
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
175
        <p>A list of the access control types that are supported with this channel.
 
176
        Note that only Socket_Access_Control_Localhost and
 
177
        Socket_Access_Control_Credentials can be used with D-Bus tubes.</p>
 
178
 
 
179
        <p>When requesting a channel with
 
180
          <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>,
 
181
          this property MUST NOT be included in the request.</p>
 
182
 
 
183
      </tp:docstring>
 
184
    </property>
 
185
 
152
186
  </interface>
153
187
 
154
188
</node>