annotate doc/jabber-signals.dox @ 27806:76a689608a83

Document the jabber signals, since I promised a while ago I would.
author Paul Aurich <paul@darkrain42.org>
date Mon, 03 Aug 2009 06:33:17 +0000
parents
children 3a52cc5eb30a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27806
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
1 /** @page jabber-signals Jabber Signals
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
2
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
3 @signals
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
4 @signal jabber-receiving-iq
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
5 @signal jabber-receiving-message
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
6 @signal jabber-receiving-presence
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
7 @signal jabber-watched-iq
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
8 @signal jabber-register-namespace-watcher
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
9 @signal jabber-unregister-namespace-watcher
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
10 @signal jabber-sending-xmlnode
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
11 @endsignals
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
12
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
13 <hr>
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
14
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
15 @signaldef jabber-receiving-iq
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
16 @signalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
17 gboolean (*iq_received)(PurpleConnection *gc, const char *type, const char *id,
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
18 const char *from, xmlnode *iq);
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
19 @endsignalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
20 @signaldesc
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
21 Emitted when an XMPP IQ stanza is received. Allows a plugin to process IQ
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
22 stanzas.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
23 @param gc The connection on which the stanza is received
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
24 @param type The IQ type ('get', 'set', 'result', or 'error')
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
25 @param id The ID attribute from the stanza. MUST NOT be NULL.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
26 @param from The originator of the stanza. MAY BE NULL if the stanza
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
27 originated from the user's server.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
28 @param iq The full stanza received.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
29 @return TRUE if the plugin processed this stanza and *nobody else* should
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
30 process it. FALSE otherwise.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
31 @endsignaldef
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
32
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
33 @signaldef jabber-receiving-message
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
34 @signalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
35 gboolean (*message_received)(PurpleConnection *gc, const char *type,
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
36 const char *id, const char *from, const char *to,
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
37 xmlnode *message);
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
38 @endsignalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
39 @signaldesc
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
40 Emitted when an XMPP message stanza is received. Allows a plugin to
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
41 process message stanzas.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
42 @param gc The connection on which the stanza is received
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
43 @param type The message type (see rfc3921 or rfc3921bis)
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
44 @param id The ID attribute from the stanza. MAY BE NULL.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
45 @param from The originator of the stanza. MAY BE NULL if the stanza
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
46 originated from the user's server.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
47 @param to The destination of the stanza. This is probably either the
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
48 full JID of the receiver or the receiver's bare JID.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
49 @param message The full stanza received.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
50 @return TRUE if the plugin processed this stanza and *nobody else* should
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
51 process it. FALSE otherwise.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
52 @endsignaldef
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
53
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
54 @signaldef jabber-receiving-presence
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
55 @signalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
56 gboolean (*presence_received)(PurpleConnection *gc, const char *type,
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
57 const char *from, xmlnode *presence);
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
58 @endsignalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
59 @signaldesc
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
60 Emitted when an XMPP presence stanza is received. Allows a plugin to process
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
61 presence stanzas.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
62 @param gc The connection on which the stanza is received
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
63 @param type The presence type (see rfc3921 or rfc3921bis). NULL indicates
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
64 this is an "available" (i.e. online) presence.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
65 @param from The originator of the stanza. MAY BE NULL if the stanza
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
66 originated from the user's server.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
67 @param presence The full stanza received.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
68 @return TRUE if the plugin processed this stanza and *nobody else* should
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
69 process it. FALSE otherwise.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
70 @endsignaldef
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
71
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
72 @signaldef jabber-watched-iq
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
73 @signalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
74 gboolean (*watched_iq)(PurpleConnection *pc, const char *type, const char *id,
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
75 const char *from, xmlnode *child);
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
76 @endsignalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
77 @signaldesc
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
78 Emitted when an IQ with a watched (child, namespace) pair is received. See
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
79 jabber-register-namespace-watcher and jabber-unregister-namespace-watcher.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
80 @param gc The connection on which the stanza is received
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
81 @param type The IQ type ('get', 'set', 'result', or 'error')
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
82 @param id The ID attribute from the stanza. MUST NOT be NULL.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
83 @param from The originator of the stanza. MAY BE NULL if the stanza
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
84 originated from the user's server.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
85 @param child The child node with namespace.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
86 @return TRUE if the plugin processed this stanza and *nobody else* should
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
87 process it. FALSE otherwise.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
88 @endsignaldef
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
89
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
90 @signaldef jabber-sending-xmlnode
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
91 @signalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
92 void (sending_xmlnode)(PurpleConnection *gc, xmlnode **stanza);
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
93 @endsignalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
94 @signaldesc
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
95 Emit this signal (@c purple_signal_emit) to send a stanza. It is preferred
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
96 to use this instead of prpl_info->send_raw.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
97 @param gc The connectoin on which to send the stanza.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
98 @param stanza The stanza to send. If stanza is not NULL after being sent,
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
99 the emitter should free it.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
100 @endsignaldef
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
101
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
102 @signaldef jabber-register-namespace-watcher
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
103 @signalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
104 void (register_namespace_watcher)(const char *node, const char *namespace);
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
105 @endsignalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
106 @signaldesc
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
107 Emit this signal to register your desire to have specific IQ stanzas to be
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
108 emitted via the jabber-watched-iq signal when received.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
109 @param node The IQ child name to longer watch.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
110 @param namespace The IQ child namespace to longer watch.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
111 @endsignaldef
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
112
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
113 @signaldef jabber-unregister-namespace-watcher
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
114 @signalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
115 void (unregister_namespace_watcher)(const char *node, const char *namespace);
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
116 @endsignalproto
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
117 @signaldesc
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
118 Emit this signal to unregister your desire to have specific IQ stanzas to be
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
119 emitted via the jabber-watched-iq signal when received.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
120 @param node The IQ child name to no longer watch.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
121 @param namespace The IQ child namespace to no longer watch.
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
122 @endsignaldef
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
123
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
124 */
76a689608a83 Document the jabber signals, since I promised a while ago I would.
Paul Aurich <paul@darkrain42.org>
parents:
diff changeset
125 // vim: syntax=c.doxygen tw=75 et