WockyPubsubNode

WockyPubsubNode

Synopsis

                    WockyPubsubNode;
                    WockyPubsubNodeClass;
const gchar *       wocky_pubsub_node_get_name          (WockyPubsubNode *self);
void                wocky_pubsub_node_delete_async      (WockyPubsubNode *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            wocky_pubsub_node_delete_finish     (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GError **error);
WockyXmppStanza *   wocky_pubsub_node_make_publish_stanza
                                                        (WockyPubsubNode *self,
                                                         WockyXmppNode **pubsub_out,
                                                         WockyXmppNode **publish_out,
                                                         WockyXmppNode **item_out);
void                wocky_pubsub_node_subscribe_async   (WockyPubsubNode *self,
                                                         const gchar *jid,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
WockyPubsubSubscription * wocky_pubsub_node_subscribe_finish
                                                        (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GError **error);
void                wocky_pubsub_node_unsubscribe_async (WockyPubsubNode *self,
                                                         const gchar *jid,
                                                         const gchar *subid,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            wocky_pubsub_node_unsubscribe_finish
                                                        (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GError **error);
void                wocky_pubsub_node_list_affiliates_async
                                                        (WockyPubsubNode *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            wocky_pubsub_node_list_affiliates_finish
                                                        (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GList **affiliates,
                                                         GError **error);
void                wocky_pubsub_node_list_subscribers_async
                                                        (WockyPubsubNode *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            wocky_pubsub_node_list_subscribers_finish
                                                        (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GList **subscribers,
                                                         GError **error);
WockyXmppStanza *   wocky_pubsub_node_make_list_affiliates_stanza
                                                        (WockyPubsubNode *self,
                                                         WockyXmppNode **pubsub_node,
                                                         WockyXmppNode **affiliations_node);
WockyXmppStanza *   wocky_pubsub_node_make_list_subscribers_stanza
                                                        (WockyPubsubNode *self,
                                                         WockyXmppNode **pubsub_node,
                                                         WockyXmppNode **subscriptions_node);
GList *             wocky_pubsub_node_parse_affiliations
                                                        (WockyPubsubNode *self,
                                                         WockyXmppNode *affiliations_node);

#define             WOCKY_TYPE_PUBSUB_AFFILIATION
#define             WOCKY_TYPE_PUBSUB_AFFILIATION_STATE
                    WockyPubsubAffiliation;
enum                WockyPubsubAffiliationState;
WockyPubsubAffiliation * wocky_pubsub_affiliation_copy  (WockyPubsubAffiliation *aff);
void                wocky_pubsub_affiliation_free       (WockyPubsubAffiliation *aff);
GList *             wocky_pubsub_affiliation_list_copy  (GList *affs);
void                wocky_pubsub_affiliation_list_free  (GList *affs);
WockyPubsubAffiliation * wocky_pubsub_affiliation_new   (WockyPubsubNode *node,
                                                         const gchar *jid,
                                                         WockyPubsubAffiliationState state);

Object Hierarchy

  GObject
   +----WockyPubsubNode

Properties

  "name"                     gchar*                : Read / Write / Construct Only
  "service"                  WockyPubsubService*   : Read / Write / Construct Only

Signals

  "deleted"                                        : Run Last
  "event-received"                                 
  "subscription-state-changed"                     : Run Last

Description

Details

WockyPubsubNode

typedef struct _WockyPubsubNode WockyPubsubNode;

WockyPubsubNodeClass

typedef struct {
  GObjectClass parent_class;
} WockyPubsubNodeClass;

wocky_pubsub_node_get_name ()

const gchar *       wocky_pubsub_node_get_name          (WockyPubsubNode *self);

self :

Returns :

wocky_pubsub_node_delete_async ()

void                wocky_pubsub_node_delete_async      (WockyPubsubNode *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

self :

cancellable :

callback :

user_data :

wocky_pubsub_node_delete_finish ()

gboolean            wocky_pubsub_node_delete_finish     (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GError **error);

self :

result :

error :

Returns :

wocky_pubsub_node_make_publish_stanza ()

WockyXmppStanza *   wocky_pubsub_node_make_publish_stanza
                                                        (WockyPubsubNode *self,
                                                         WockyXmppNode **pubsub_out,
                                                         WockyXmppNode **publish_out,
                                                         WockyXmppNode **item_out);

self :

pubsub_out :

publish_out :

item_out :

Returns :

wocky_pubsub_node_subscribe_async ()

void                wocky_pubsub_node_subscribe_async   (WockyPubsubNode *self,
                                                         const gchar *jid,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Attempts to subscribe to self.

self :

 a pubsub node

jid :

 the JID to use as the subscribed JID (usually the connection's bare or full JID); may not be NULL

cancellable :

 optional GCancellable object, NULL to ignore

callback :

 a callback to call when the request is completed

user_data :

 data to pass to callback

wocky_pubsub_node_subscribe_finish ()

WockyPubsubSubscription * wocky_pubsub_node_subscribe_finish
                                                        (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GError **error);

self :

result :

error :

Returns :

wocky_pubsub_node_unsubscribe_async ()

void                wocky_pubsub_node_unsubscribe_async (WockyPubsubNode *self,
                                                         const gchar *jid,
                                                         const gchar *subid,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Attempts to unsubscribe from self.

self :

 a pubsub node

jid :

 the JID subscribed to self (usually the connection's bare or full JID); may not be NULL

subid :

 the identifier associated with the subscription

cancellable :

 optional GCancellable object, NULL to ignore

callback :

 a callback to call when the request is completed

user_data :

 data to pass to callback

wocky_pubsub_node_unsubscribe_finish ()

gboolean            wocky_pubsub_node_unsubscribe_finish
                                                        (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GError **error);

self :

result :

error :

Returns :

wocky_pubsub_node_list_affiliates_async ()

void                wocky_pubsub_node_list_affiliates_async
                                                        (WockyPubsubNode *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Retrieves the list of entities affilied to a node you own. callback may complete the call using wocky_pubsub_node_list_affiliates_finish().

(A note on naming: this is §8.9.1 — Retrieve Affiliations List — in XEP-0060, not to be confused with §5.7 — Retrieve Affiliations. The slightly different terminology in Wocky is intended to help disambiguate!)

self :

 a pubsub node

cancellable :

 optional GCancellable object

callback :

 function to call when the affiliates have been retrieved or an error has occured

user_data :

 data to pass to callback.

wocky_pubsub_node_list_affiliates_finish ()

gboolean            wocky_pubsub_node_list_affiliates_finish
                                                        (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GList **affiliates,
                                                         GError **error);

Completes a call to wocky_pubsub_node_list_affiliates_async(). The list returned in affiliates should be freed with wocky_pubsub_affiliation_list_free() when it is no longer needed.

self :

 a pubsub node

result :

 the result passed to a callback

affiliates :

 location at which to store a list of WockyPubsubAffiliation pointers, or NULL

error :

 location at which to store an error, or NULL

Returns :

 TRUE if the list of subscribers was successfully retrieved; FALSE and sets error if an error occured.

wocky_pubsub_node_list_subscribers_async ()

void                wocky_pubsub_node_list_subscribers_async
                                                        (WockyPubsubNode *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Retrieves the list of subscriptions to a node you own. callback may complete the call using wocky_pubsub_node_list_subscribers_finish().

(A note on naming: this is §8.8.1 — Retrieve Subscriptions List — in XEP-0060, not to be confused with §5.6 — Retrieve Subscriptions. The different terminology in Wocky is intended to help disambiguate!)

self :

 a pubsub node

cancellable :

 optional GCancellable object

callback :

 function to call when the subscribers have been retrieved or an error has occured

user_data :

 data to pass to callback.

wocky_pubsub_node_list_subscribers_finish ()

gboolean            wocky_pubsub_node_list_subscribers_finish
                                                        (WockyPubsubNode *self,
                                                         GAsyncResult *result,
                                                         GList **subscribers,
                                                         GError **error);

Completes a call to wocky_pubsub_node_list_subscribers_async(). The list returned in subscribers should be freed with wocky_pubsub_subscription_list_free() when it is no longer needed.

self :

 a pubsub node

result :

 the result passed to a callback

subscribers :

 location at which to store a list of WockyPubsubSubscription pointers, or NULL

error :

 location at which to store an error, or NULL

Returns :

 TRUE if the list of subscribers was successfully retrieved; FALSE and sets error if an error occured.

wocky_pubsub_node_make_list_affiliates_stanza ()

WockyXmppStanza *   wocky_pubsub_node_make_list_affiliates_stanza
                                                        (WockyPubsubNode *self,
                                                         WockyXmppNode **pubsub_node,
                                                         WockyXmppNode **affiliations_node);

self :

pubsub_node :

affiliations_node :

Returns :

wocky_pubsub_node_make_list_subscribers_stanza ()

WockyXmppStanza *   wocky_pubsub_node_make_list_subscribers_stanza
                                                        (WockyPubsubNode *self,
                                                         WockyXmppNode **pubsub_node,
                                                         WockyXmppNode **subscriptions_node);

self :

pubsub_node :

subscriptions_node :

Returns :

wocky_pubsub_node_parse_affiliations ()

GList *             wocky_pubsub_node_parse_affiliations
                                                        (WockyPubsubNode *self,
                                                         WockyXmppNode *affiliations_node);

self :

affiliations_node :

Returns :

WOCKY_TYPE_PUBSUB_AFFILIATION

#define             WOCKY_TYPE_PUBSUB_AFFILIATION

WOCKY_TYPE_PUBSUB_AFFILIATION_STATE

#define WOCKY_TYPE_PUBSUB_AFFILIATION_STATE (wocky_pubsub_affiliation_state_get_type())

WockyPubsubAffiliation

typedef struct {
    WockyPubsubNode *node;
    gchar *jid;
    WockyPubsubAffiliationState state;
} WockyPubsubAffiliation;

enum WockyPubsubAffiliationState

typedef enum {
    WOCKY_PUBSUB_AFFILIATION_OWNER,
    WOCKY_PUBSUB_AFFILIATION_PUBLISHER,
    WOCKY_PUBSUB_AFFILIATION_PUBLISH_ONLY,
    WOCKY_PUBSUB_AFFILIATION_MEMBER,
    WOCKY_PUBSUB_AFFILIATION_NONE,
    WOCKY_PUBSUB_AFFILIATION_OUTCAST
} WockyPubsubAffiliationState;

wocky_pubsub_affiliation_copy ()

WockyPubsubAffiliation * wocky_pubsub_affiliation_copy  (WockyPubsubAffiliation *aff);

aff :

Returns :

wocky_pubsub_affiliation_free ()

void                wocky_pubsub_affiliation_free       (WockyPubsubAffiliation *aff);

aff :

wocky_pubsub_affiliation_list_copy ()

GList *             wocky_pubsub_affiliation_list_copy  (GList *affs);

affs :

Returns :

wocky_pubsub_affiliation_list_free ()

void                wocky_pubsub_affiliation_list_free  (GList *affs);

affs :

wocky_pubsub_affiliation_new ()

WockyPubsubAffiliation * wocky_pubsub_affiliation_new   (WockyPubsubNode *node,
                                                         const gchar *jid,
                                                         WockyPubsubAffiliationState state);

node :

jid :

state :

Returns :

Property Details

The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

The name of the pubsub node.

Default value: NULL

The "service" property

  "service"                  WockyPubsubService*   : Read / Write / Construct Only

the Wocky Pubsub service associated with this pubsub node.

Signal Details

The "deleted" signal

void                user_function                      (WockyPubsubNode *node,
                                                        WockyXmppStanza *stanza,
                                                        gpointer         event_node,
                                                        gpointer         delete_node,
                                                        gpointer         user_data)        : Run Last

Emitted when a notification of this node's deletion is received from the server.

node :

 a pubsub node

stanza :

 the message/event stanza in its entirety

event_node :

 the event node from stanza

delete_node :

 the delete node from stanza

user_data :

 user data set when the signal handler was connected.

The "event-received" signal

void                user_function                      (WockyPubsubNode *node,
                                                        WockyXmppStanza *event_stanza,
                                                        gpointer         event_node,
                                                        gpointer         items_node,
                                                        gpointer         items,
                                                        gpointer         user_data)

node :

 a pubsub node

event_stanza :

 the message/event stanza in its entirity

event_node :

 the event node from the stanza

items_node :

 the items node from the stanza

items :

 a list of WockyXmppNode *s for each item child of items_node

user_data :

 user data set when the signal handler was connected.

The "subscription-state-changed" signal

void                user_function                      (WockyPubsubNode         *node,
                                                        WockyXmppStanza         *stanza,
                                                        gpointer                 event_node,
                                                        gpointer                 subscription_node,
                                                        WockyPubsubSubscription *subscription,
                                                        gpointer                 user_data)              : Run Last

node :

 a pubsub node

stanza :

 the message/event stanza in its entirety

event_node :

 the event node from stanza

subscription_node :

 the subscription node from stanza

subscription :

 subscription information parsed from subscription_node

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.14