![]() |
![]() |
![]() |
Dee Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
#include <dee.h> DeePeer; DeePeerClass; DeePeerPrivate; #define DEE_PEER_DBUS_IFACE void dee_peer_connect (DeePeer *self
); const gboolean dee_peer_is_swarm_leader (DeePeer *self
); const gchar* dee_peer_get_swarm_leader (DeePeer *self
); const gchar * dee_peer_get_swarm_name (DeePeer *self
);
"bye" : Run Last "connected" : Run Last "peer-found" : Run Last "peer-lost" : Run Last "ping" : Run Last "pong" : Run Last
DeePeer allows you to build objects that can 'find eachother' on D-Bus without the need for an central registration service. Think of it like peer-to-peer for your application. The DBus session bus will also implicitly elect a swarm leader - namely the one owning the swarm name on the bus, but it's up to the consumer of this API to determine whether swarm leadership has any concrete responsibilities associated.
Peers find eachother through a well-known "swarm-name", which loosely translates to a DBus name, such as: org.myapp.MyPeers. Choose a namespaced name that would not normally be used outside of your program.
For example:
{ DeePeer *peer; peer = g_object_new (DBUS_TYPE_PEER, "swarm-name", "org.myapp.MyPeers", NULL); g_signal_connect (peer, "peer-found", G_CALLBACK (on_peer_found), NULL); g_signal_connect (peer, "peer-lost", G_CALLBACK (on_peer_lost), NULL); /* Publish this peer and start monitoring for other peers */ dee_peer_connect (peer); }
Commonly the callbacks for these signals will create (or tear down) a proxy for the relevant peer. With DBus-GLib it might look like:
void on_peer_found (DeePeer *peer, const gchar *name) { DBusGProxy *proxy; /* We have found a peer, so let's connect to it with a well-known * interface. */ proxy = dbus_g_proxy_new_for_name_owner (connection, name, "/org/myapp/MyPeerIface", "org.myapp.MyPeerIface", NULL); }
typedef struct _DeePeer DeePeer;
All fields in the DeePeer structure are private and should never be accessed directly
typedef struct { /*< signals >*/ void (*connected) (DeePeer *peer, const gchar *peer_name); void (*peer_found) (DeePeer *peer, const gchar *name); void (*peer_lost) (DeePeer *peer, const gchar *name); /*< vtable >*/ } DeePeerClass;
void dee_peer_connect (DeePeer *self
);
Will cause self
to connect to the swarm and begin monitoring peers.
|
a DeePeer |
const gchar* dee_peer_get_swarm_leader (DeePeer *self
);
Gets the unique DBus address of the current swarm leader.
This function can only be used after dee_peer_connect()
has been called.
"swarm-leader"
property"swarm-leader" gchar* : Read
Unique DBus address of the swarm leader.
Default value: NULL
"swarm-name"
property"swarm-name" gchar* : Read / Write / Construct
Well-known name to find other peers with.
Default value: NULL
"bye"
signalvoid user_function (DeePeer *deepeer, gchar *arg1, gchar *arg2, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |
"connected"
signalvoid user_function (DeePeer *self, gchar *unique_name, gpointer user_data) : Run Last
Connect to this signal to be notified when the peer connects to DBus. Sub-classes should connect to this signal so they register themselves on the bus at the same time.
|
the DeePeer on which the signal is emitted |
|
the unique name of the connection |
|
user data set when the signal handler was connected. |
"peer-found"
signalvoid user_function (DeePeer *self, gchar *name, gpointer user_data) : Run Last
Connect to this signal to be notified of existing and new peers that are in your swarm.
|
the DeePeer on which the signal is emitted |
|
the DBus name of the object found |
|
user data set when the signal handler was connected. |
"peer-lost"
signalvoid user_function (DeePeer *self, gchar *name, gpointer user_data) : Run Last
Connect to this signal to be notified when peers disconnect from the swarm
|
the DeePeer on which the signal is emitted |
|
the DBus name of the object that disconnected |
|
user data set when the signal handler was connected. |
"ping"
signalvoid user_function (DeePeer *arg0, gchar *arg1, gpointer user_data) : Run Last
Private signal leaked because of how dbus-glib work with signals
|
user data set when the signal handler was connected. |