WockyPepService

WockyPepService — Object to represent a single PEP service

Functions

Properties

gchar * node Read / Write / Construct Only
gboolean subscribe Read / Write / Construct Only

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── WockyPepService

Includes

#include <wocky/wocky-pep-service.h>

Description

Object to aid with looking up PEP nodes and listening for changes.

Functions

wocky_pep_service_new ()

WockyPepService *
wocky_pep_service_new (const gchar *node,
                       gboolean subscribe);

A convenience function to create a new WockyPepService object.

Parameters

node

the namespace of the PEP node

 

subscribe

TRUE if Wocky is to subscribe to the notifications of the node, otherwise FALSE

 

Returns

a new WockyPepService


wocky_pep_service_start ()

void
wocky_pep_service_start (WockyPepService *self,
                         WockySession *session);

Start listening to the PEP node node and signal changes by using “changed”.

Parameters

self

a WockyPepService object

 

session

a WockySession object

 

wocky_pep_service_get_async ()

void
wocky_pep_service_get_async (WockyPepService *self,
                             WockyBareContact *contact,
                             GCancellable *cancellable,
                             GAsyncReadyCallback callback,
                             gpointer user_data);

Starts an asynchronous operation to get the PEP node, “node”.

When the operation is complete, callback will be called and the function should call wocky_pep_service_get_finish().

Parameters

self

a WockyPepService object

 

contact

a WockyBareContact object

 

cancellable

an optional GCancellable object, or NULL

 

callback

a function to call when the node is retrieved

 

user_data

user data for callback

 

wocky_pep_service_get_finish ()

WockyStanza *
wocky_pep_service_get_finish (WockyPepService *self,
                              GAsyncResult *result,
                              WockyNode **item,
                              GError **error);

Finishes an asynchronous operation to get the PEP node, “node”. For more details, see wocky_pep_service_get_async().

Parameters

self

a WockyPepService object

 

result

a GAsyncResult

 

item

on success, the first <item> element in the result, or NULL if self has no published items.

[out][allow-none]

error

a location to store a GError if an error occurs

 

Returns

the WockyStanza retrieved from getting the PEP node.


wocky_pep_service_make_publish_stanza ()

WockyStanza *
wocky_pep_service_make_publish_stanza (WockyPepService *self,
                                       WockyNode **item);

Generates a new IQ type='set' PEP publish stanza.

Parameters

self

a WockyPepService

 

item

a location to store the item WockyNode, or NULL

 

Returns

a new WockyStanza PEP publish stanza; free with g_object_unref()

Types and Values

struct WockyPepServiceClass

struct WockyPepServiceClass {
};

The class of a WockyPepService.


struct WockyPepService

struct WockyPepService;

Object to aid with looking up PEP nodes and listening for changes.

Property Details

The “node” property

  “node”                     gchar *

Namespace of the PEP node.

Flags: Read / Write / Construct Only

Default value: NULL


The “subscribe” property

  “subscribe”                gboolean

TRUE if Wocky is to subscribe to the notifications of the node.

Flags: Read / Write / Construct Only

Default value: FALSE

Signal Details

The “changed” signal

void
user_function (WockyPepService  *self,
               WockyBareContact *contact,
               WockyStanza      *stanza,
               gpointer          item,
               gpointer          user_data)

Emitted when the node value changes.

Parameters

self

a WockyPepService object

 

contact

the WockyBareContact who changed the node

 

stanza

the WockyStanza

 

item

the first—and typically only—<item> element in stanza , or NULL if there is none.

 

user_data

user data set when the signal handler was connected.

 

Flags: Has Details