WockyPubsubService

WockyPubsubService

Functions

Properties

gchar * jid Read / Write / Construct Only
WockySession * session Read / Write / Construct Only

Signals

Types and Values

Object Hierarchy

    GBoxed
    ╰── WockyPubsubSubscription
    GEnum
    ├── WockyPubsubServiceError
    ╰── WockyPubsubSubscriptionState
    GObject
    ╰── WockyPubsubService

Description

Functions

wocky_pubsub_service_error_quark ()

GQuark
wocky_pubsub_service_error_quark (void);

WOCKY_PUBSUB_SERVICE_ERROR

#define WOCKY_PUBSUB_SERVICE_ERROR (wocky_pubsub_service_error_quark ())

wocky_pubsub_service_new ()

WockyPubsubService *
wocky_pubsub_service_new (WockySession *session,
                          const gchar *jid);

wocky_pubsub_service_ensure_node ()

WockyPubsubNode *
wocky_pubsub_service_ensure_node (WockyPubsubService *self,
                                  const gchar *name);

Fetches or creates an object representing a node on the pubsub service. Note that this does not ensure that a node exists on the server; it merely ensures a local representation.

Parameters

self

a pubsub service

 

name

the name of a node on self

 

Returns

a new reference to an object representing a node named name on self


wocky_pubsub_service_lookup_node ()

WockyPubsubNode *
wocky_pubsub_service_lookup_node (WockyPubsubService *self,
                                  const gchar *name);

Fetches an object representing a node on a pubsub service, if the object already exists; if not, returns NULL. Note that this does not check whether a node exists on the server; it only checks for a local representation.

Parameters

self

a pubsub service

 

name

the name of a node on self

 

Returns

a borrowed reference to a node, or NULL


wocky_pubsub_service_get_default_node_configuration_async ()

void
wocky_pubsub_service_get_default_node_configuration_async
                               (WockyPubsubService *self,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

wocky_pubsub_service_get_default_node_configuration_finish ()

WockyDataForm *
wocky_pubsub_service_get_default_node_configuration_finish
                               (WockyPubsubService *self,
                                GAsyncResult *result,
                                GError **error);

wocky_pubsub_service_retrieve_subscriptions_async ()

void
wocky_pubsub_service_retrieve_subscriptions_async
                               (WockyPubsubService *self,
                                WockyPubsubNode *node,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

wocky_pubsub_service_retrieve_subscriptions_finish ()

gboolean
wocky_pubsub_service_retrieve_subscriptions_finish
                               (WockyPubsubService *self,
                                GAsyncResult *result,
                                GList **subscriptions,
                                GError **error);

wocky_pubsub_service_create_node_async ()

void
wocky_pubsub_service_create_node_async
                               (WockyPubsubService *self,
                                const gchar *name,
                                WockyDataForm *config,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

wocky_pubsub_service_create_node_finish ()

WockyPubsubNode *
wocky_pubsub_service_create_node_finish
                               (WockyPubsubService *self,
                                GAsyncResult *result,
                                GError **error);

wocky_pubsub_subscription_new ()

WockyPubsubSubscription *
wocky_pubsub_subscription_new (WockyPubsubNode *node,
                               const gchar *jid,
                               WockyPubsubSubscriptionState state,
                               const gchar *subid);

wocky_pubsub_subscription_copy ()

WockyPubsubSubscription *
wocky_pubsub_subscription_copy (WockyPubsubSubscription *sub);

wocky_pubsub_subscription_free ()

void
wocky_pubsub_subscription_free (WockyPubsubSubscription *sub);

wocky_pubsub_subscription_list_copy ()

GList *
wocky_pubsub_subscription_list_copy (GList *subs);

wocky_pubsub_subscription_list_free ()

void
wocky_pubsub_subscription_list_free (GList *subs);

Types and Values

enum WockyPubsubServiceError

WockyPubsubService specific errors.

Members

WOCKY_PUBSUB_SERVICE_ERROR_WRONG_REPLY

A wrong reply was received

 

enum WockyPubsubSubscriptionState

Describes the state of a subscription to a node. Definitions are taken from

XEP-0060 §4.2.

Members

WOCKY_PUBSUB_SUBSCRIPTION_NONE

The node MUST NOT send event notifications or payloads to the Entity.

 

WOCKY_PUBSUB_SUBSCRIPTION_PENDING

An entity has requested to subscribe to a node and the request has not yet been approved by a node owner. The node MUST NOT send event notifications or payloads to the entity while it is in this state.

 

WOCKY_PUBSUB_SUBSCRIPTION_SUBSCRIBED

An entity has subscribed but its subscription options have not yet been configured. The node MAY send event notifications or payloads to the entity while it is in this state. The service MAY timeout unconfigured subscriptions.

 

WOCKY_PUBSUB_SUBSCRIPTION_UNCONFIGURED

An entity is subscribed to a node. The node MUST send all event notifications (and, if configured, payloads) to the entity while it is in this state (subject to subscriber configuration and content filtering).

 

Property Details

The “jid” property

  “jid”                      gchar *

The jid of the pubsub service.

Flags: Read / Write / Construct Only

Default value: NULL


The “session” property

  “session”                  WockySession *

the Wocky Session associated with this pubsub service.

Flags: Read / Write / Construct Only

Signal Details

The “event-received” signal

void
user_function (WockyPubsubService *service,
               WockyPubsubNode    *node,
               WockyStanza        *event_stanza,
               gpointer            event_node,
               gpointer            items_node,
               gpointer            items,
               gpointer            user_data)

Emitted when an event is received for a node.

Parameters

service

a pubsub service

 

node

the node on service for which an event has been received wire

 

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 WockyNode *s for each item child of items_node

 

user_data

user data set when the signal handler was connected.

 

The “node-deleted” signal

void
user_function (WockyPubsubService *node,
               WockyPubsubNode    *stanza,
               WockyStanza        *event_node,
               gpointer            delete_node,
               gpointer            arg4,
               gpointer            user_data)

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

Parameters

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.

 

Flags: Run Last


The “subscription-state-changed” signal

void
user_function (WockyPubsubService      *service,
               WockyPubsubNode         *node,
               WockyStanza             *stanza,
               gpointer                 event_node,
               gpointer                 subscription_node,
               WockyPubsubSubscription *subscription,
               gpointer                 user_data)

Parameters

service

a pubsub service

 

node

a pubsub node for which the subscription state has changed

 

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.

 

Flags: Run Last