mod_presence.cc File Reference

handles presences: send to subscribers, send offline on session end, probe for subscribed presences More...

#include "jsm.h"

Data Structures
struct	modpres_conf_struct
	hold configuration data for this module instance More...
struct	modpres_struct
	hold all data belonging to this module and a single (online) user More...
Typedefs
typedef struct modpres_conf_struct *	modpres_conf
	hold configuration data for this module instance
typedef struct modpres_conf_struct	_modpres_conf
typedef struct modpres_struct *	modpres
	hold all data belonging to this module and a single (online) user
typedef struct modpres_struct	_modpres
Functions
void	mod_presence (jsmi si)

---

Detailed Description

handles presences: send to subscribers, send offline on session end, probe for subscribed presences

This module is responsible for sending presences to all contacts that subscribed to the user's presence. It will send an unavailable presence to everybudy that got an available presence. It will send probes to the contacts to which we have subscribed presence.

This module is NOT responsible for handling subscriptions, they are handled in mod_roster.c.

We have three sets of jids for each user:

• T: trusted (roster s10ns)
• A: availables (who knows were available) - stored in modpres_struct
• I: invisibles (who were invisible to) - stored in modpres_struct

action points:

• broadcasting available presence: intersection of T and A (don't broadcast updates to them if they don't think we're available any more, either we told them that or their jidd i returned a presence error)
• broadcasting unavailable presence: union of A and I (even invisible jids need to be notified when going unavail, since invisible is still technically an available presence and may be used as such by a transport or other remote service)
• allowed to return presence to a probe when available: compliment of I in T (all trusted jids, except the ones were invisible to, may poll our presence any time)
• allowed to return presence to a probe when invisible: intersection of T and A (of the trusted jids, only the ones we've sent availability to can poll, and we return a generic available presence)
• individual avail presence: forward, add to A, remove from I
• individual unavail presence: forward and remove from A, remove from I
• individual invisible presence: add to I, remove from A
• first avail: populate A with T and broadcast

---

Typedef Documentation

typedef struct modpres_struct _modpres

typedef struct modpres_conf_struct _modpres_conf

typedef struct modpres_struct * modpres

hold all data belonging to this module and a single (online) user

This structure holds the A and I (see description of mod_presence.c) list for a user, a flag if a user is invisible, and a list of JIDs we have to send a blind carbon copy of each presence

typedef struct modpres_conf_struct * modpres_conf

hold configuration data for this module instance

This structure holds all information about the configuration of this module.

---

Function Documentation

void mod_presence

(

jsmi

si

)

init the module, register callbacks

builds a list of JabberIDs where presences should be blind carbon copied to. (Enclosing each in a <bcc/> element, which are contained in one <presence/> element in the session manager configuration.)

registers mod_presence_session() as a callback, that gets notified on new sessions and mod_presence_deliver() as a callback to deliver presence stanzas locally.

Parameters:

si	the session manager instance

References modpres_conf_struct::bcc, e_DELETE, e_DELIVER, e_DESERIALIZE, e_SESSION, j_strcmp(), jid_append(), jid_new(), js_config(), js_mapi_register(), log_debug2, LOGT_INIT, jsmi_struct::p, modpres_conf_struct::peerpres_to_xdb, pmalloco(), modpres_conf_struct::pres_to_xdb, xmlnode_free(), xmlnode_get_data(), xmlnode_get_firstchild(), xmlnode_get_localname(), xmlnode_get_nextsibling(), and xmlnode_get_type().