Mercurial > pidgin
comparison libpurple/protocols/jabber/iq.h @ 26478:36c435f55252
Large documentation blocks never hurt anyone.
author | Paul Aurich <paul@darkrain42.org> |
---|---|
date | Sun, 05 Apr 2009 19:05:49 +0000 |
parents | ae41d8e827e3 |
children | 5767b7698c73 |
comparison
equal
deleted
inserted
replaced
26477:2b8c161c9d7b | 26478:36c435f55252 |
---|---|
32 | 32 |
33 #include "jabber.h" | 33 #include "jabber.h" |
34 | 34 |
35 typedef struct _JabberIq JabberIq; | 35 typedef struct _JabberIq JabberIq; |
36 | 36 |
37 /** | |
38 * A JabberIqHandler is called to process an incoming IQ stanza. | |
39 * Handlers typically process unsolicited incoming GETs or SETs for their | |
40 * registered namespace, but may be called to handle the results of a | |
41 * GET or SET that we generated if no JabberIqCallback was generated | |
42 * The handler may be called for the results of a GET or SET (RESULT or ERROR) | |
43 * that we generated | |
44 * if the generating function did not register a JabberIqCallback. | |
45 * | |
46 * @param js The JabberStream object. | |
47 * @param from The remote entity (the from attribute on the <iq/> stanza) | |
48 * @param type The IQ type. | |
49 * @param id The IQ id (the id attribute on the <iq/> stanza) | |
50 * @param child The child element of the <iq/> stanza that matches the name | |
51 * and namespace registered with jabber_iq_register_handler. | |
52 * | |
53 * @see jabber_iq_register_handler() | |
54 * @see JabberIqCallback | |
55 */ | |
37 typedef void (JabberIqHandler)(JabberStream *js, const char *from, | 56 typedef void (JabberIqHandler)(JabberStream *js, const char *from, |
38 JabberIqType type, const char *id, | 57 JabberIqType type, const char *id, |
39 xmlnode *child); | 58 xmlnode *child); |
40 | 59 |
60 /** | |
61 * A JabberIqCallback is called to process the results of a GET or SET that | |
62 * we send to a remote entity. The callback is matched based on the id | |
63 * of the incoming stanza (which matches the one on the initial stanza). | |
64 * | |
65 * @param js The JabberStream object. | |
66 * @param from The remote entity (the from attribute on the <iq/> stanza) | |
67 * @param type The IQ type. The only possible values are JABBER_IQ_RESULT | |
68 * and JABBER_IQ_ERROR. | |
69 * @param id The IQ id (the id attribute on the <iq/> stanza) | |
70 * @param packet The <iq/> stanza | |
71 * @param data The callback data passed to jabber_iq_set_callback() | |
72 * | |
73 * @see jabber_iq_set_callback() | |
74 */ | |
41 typedef void (JabberIqCallback)(JabberStream *js, const char *from, | 75 typedef void (JabberIqCallback)(JabberStream *js, const char *from, |
42 JabberIqType type, const char *id, | 76 JabberIqType type, const char *id, |
43 xmlnode *packet, gpointer data); | 77 xmlnode *packet, gpointer data); |
44 | 78 |
45 struct _JabberIq { | 79 struct _JabberIq { |