Activity sharing

Telepathy

Telepathy is a system describing a generic interface for multi-user chat (MUC), instant messaging (IM) and voice/video applications. It is the underlying infrastructure used by Sugar.

The generic telepathy interface specification can be found at http://telepathy.freedesktop.org/

PresenceService

The Presence Service is a part of Sugar that tracks other Buddies and Activities on the network. It is designed to have a D-Bus interface that is to be used by applications. To make life easier, though, there is a class that takes care of talking to the D-Bus presence service (sugar.presence.PresenceService). In fact, you'll probably only have to use that.

The presence service uses two telepathy Connection Managers:

• Gabble, that provides server-based Jabber/XMPP functionality. It talks to a Jabber server (e.g. olpc.collabora.co.uk) and sets up different chat rooms through which activities talk to each other.

• Salut, a link-local Connection Manager using reliable multicast over the local network

The Presence Service will use Gabble when it has Internet access (a valid IPv4 address) and has connected to a Jabber server, otherwise Salut (but not both at the same time).

Tubes

Tubes offer a mechanism to provide data sharing over XMPP. There are currently two types of tubes:

• D-Bus Tubes

provide a D-Bus bus service that is shared between the participants in a shared activity, providing signals to all participants, and methods called on a particular participant.

• Stream Tubes

provide a socket-like connection set up via XMPP, for data streaming like HTTP, between two participants.

Using tubes in Sugar activities

To use a tube the following actions are necessary:

1. Create a Connection Manager object (Gabble)
2. Get a Connection object (to the Collabora server)
3. Get a Tubes channel
4. Create or join a Tube

Step 1 and 2 get taken care of by Sugar, and step 3 and 4 will probably be in the future as well. However, currently it is a little bit of work to perform these. Once an activity is shared, a tubes channel should be created in case there is none (presence service doesn't set this up yet). The initiator of the activity should then call Tubes.OfferTube to offer a Tube with a specific service name. When a buddy joins an activity, he will try to figure out which Tubes are available by calling Tubes.ListTubes() on the tubes channel (which he doesn't have to create anymore). Both OfferTube and ListTubes result in a callback when the Tube becomes really available. Only then a working Tube is handed to the (shared) activity and it is possible to export objects on that bus and subscribe to signals etc.

Sharing an object through the tube

The class you want to share should inherit from dbus.service.Object. Once you have the tube:

   dbus.service.Object.__init__(self, self._tube, self._object_path)

Calling a function on a remote object

Once you know the tube and the unique busname:

   self._tube.get_object(busname, self._object_path).MyFunction(123)

Subscribing to a signal

   self._tube.add_signal_receiver(self._receive_my_sig, 'MySignal', \ 
       IFACE, path=self._object_path, sender_keyword='sender') 

Who's who?

Buddies/nodes within an activity are currently identified with different handles by different components. The following handles can be distinguished:

• Dbus name. If you have a Dbus related function with the “sender” argument specified, this is what you'll get. To buddy object:

   sugar.presence.PresenceService.get_buddy(buddy's publiic key)

• Telepathy handle. To buddy object:

   sugar.presence.PresenceService.get_buddy_by_telepathy_handle(tp_conn, tp_conn_path, handle)