From 83b767595192e0838acb3163d0d23d57a0f1ec3e Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Fri, 9 Jan 2009 16:15:56 +0000 Subject: Add extension for new-style DBus tubes Signed-off-by: Sjoerd Simons svn path=/trunk/; revision=2197 --- extensions/Channel_Type_DBus_Tube.xml | 183 ++++++++++++++++++++++++++++++++++ extensions/Makefile.am | 1 + extensions/generic-types.xml | 8 ++ extensions/misc.xml | 1 + 4 files changed, 193 insertions(+) create mode 100644 extensions/Channel_Type_DBus_Tube.xml (limited to 'extensions') diff --git a/extensions/Channel_Type_DBus_Tube.xml b/extensions/Channel_Type_DBus_Tube.xml new file mode 100644 index 00000000..a3b98d7e --- /dev/null +++ b/extensions/Channel_Type_DBus_Tube.xml @@ -0,0 +1,183 @@ + + + Copyright (C) 2008 Collabora Limited + Copyright (C) 2008 Nokia Corporation + + 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. + + + + + +

A D-Bus tube is an ordered reliable transport, for transporting D-Bus + traffic.

+ +

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.

+ +

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.

+ +

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.

+ +

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.

+ + + + + + Offers a D-Bus tube providing the service specified. + + + + + + The contact associated with this channel doesn't have tubes + capabilities. + + + + + The connection manager doesn't support D-Bus tubes. + + + + + + + + Accept a D-Bus tube that's in the "local pending" state. The + connection manager will attempt to open the tube. The tube remains in + the "local pending" state until the TubeStateChanged signal is + emitted. + + + + The string describing the address of the private bus. The client + SHOULD not attempt to connect to the address until the tube is open. + + + + + + The given tube ID is invalid or does not refer to a D-Bus + tube. + + + + + + + + Return a string describing the address of the private bus. + + + + The bus address. + + + + + + The tube is not a D-Bus tube. + + + + + This tube is not in the "open" state. + + + + + + + + For a multi-user (i.e. Handle_Type_Room) D-Bus tube, obtain a mapping + between contact handles and their unique bus names on this tube. + + + + An array of structures, each containing a contact handle and a D-Bus + bus name. + + + + + + The tube is not a multi-user D-Bus tube. + + + + + This tube is not in the "open" state. + + + + + + + + Emitted on a multi-user (i.e. Handle_Type_Room) D-Bus tube when a + participant opens or closes the tube. + + + + Array of handles and D-Bus names of new participants. + + + + + Array of handles of former participants. + + + + + + +

A string representing the service name that will be used over the + tube. It SHOULD be a well-known D-Bus service name, of the form + com.example.ServiceName.

+

When the tube is offered, the service name is transmitted to the + other end.

+

When requesting a channel with + Connection.Interface.Requests.CreateChannel, + this property MUST be included in the request.

+ + + + + + + diff --git a/extensions/Makefile.am b/extensions/Makefile.am index 974fe0b6..408445fb 100644 --- a/extensions/Makefile.am +++ b/extensions/Makefile.am @@ -15,6 +15,7 @@ EXTRA_DIST = \ Tube_Handler.xml \ Channel_Type_File_Transfer.xml \ Channel_Interface_Tube.xml \ + Channel_Type_DBus_Tube.xml \ Channel_Type_Stream_Tube.xml noinst_LTLIBRARIES = libemp-extensions.la diff --git a/extensions/generic-types.xml b/extensions/generic-types.xml index 227fde14..fe27d36c 100644 --- a/extensions/generic-types.xml +++ b/extensions/generic-types.xml @@ -53,6 +53,14 @@ with dbus-glib) + + A struct (handle, unique name) representing a participant + in a D-Bus tube, as returned by GetDBusNames on the Tubes channel + type, and as seen in the DBusNamesChanged signal. + + + + An ASCII string representing a D-Bus method, signal or property name - a non-empty string of ASCII letters, digits and diff --git a/extensions/misc.xml b/extensions/misc.xml index 84dd57fc..fc96eff8 100644 --- a/extensions/misc.xml +++ b/extensions/misc.xml @@ -9,6 +9,7 @@ + -- cgit v1.2.3