Mercurial > pidgin

comparison doc/jabber-signals.dox @ 27909:3a52cc5eb30a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Document the jabber-receiving-xmlnode signal, fix a typo and make the list and detail orders match up.
author Etan Reisner <pidgin@unreliablesource.net>
date Thu, 13 Aug 2009 22:56:45 +0000
parents 76a689608a83
children
comparison
equal deleted inserted replaced
27901:c93ed4d7cabe 27909:3a52cc5eb30a
6 @signal jabber-receiving-presence 6 @signal jabber-receiving-presence
7 @signal jabber-watched-iq 7 @signal jabber-watched-iq
8 @signal jabber-register-namespace-watcher 8 @signal jabber-register-namespace-watcher
9 @signal jabber-unregister-namespace-watcher 9 @signal jabber-unregister-namespace-watcher
10 @signal jabber-sending-xmlnode 10 @signal jabber-sending-xmlnode
11 @signal jabber-receiving-xmlnode
11 @endsignals 12 @endsignals
12 13
13 <hr> 14 <hr>
14 15
15 @signaldef jabber-receiving-iq 16 @signaldef jabber-receiving-iq
69 process it. FALSE otherwise. 70 process it. FALSE otherwise.
70 @endsignaldef 71 @endsignaldef
71 72
72 @signaldef jabber-watched-iq 73 @signaldef jabber-watched-iq
73 @signalproto 74 @signalproto
74 gboolean (*watched_iq)(PurpleConnection *pc, const char *type, const char *id, 75 gboolean (*watched_iq)(PurpleConnection *gc, const char *type, const char *id,
75 const char *from, xmlnode *child); 76 const char *from, xmlnode *child);
76 @endsignalproto 77 @endsignalproto
77 @signaldesc 78 @signaldesc
78 Emitted when an IQ with a watched (child, namespace) pair is received. See 79 Emitted when an IQ with a watched (child, namespace) pair is received. See
79 jabber-register-namespace-watcher and jabber-unregister-namespace-watcher. 80 jabber-register-namespace-watcher and jabber-unregister-namespace-watcher.
83 @param from The originator of the stanza. MAY BE NULL if the stanza 84 @param from The originator of the stanza. MAY BE NULL if the stanza
84 originated from the user's server. 85 originated from the user's server.
85 @param child The child node with namespace. 86 @param child The child node with namespace.
86 @return TRUE if the plugin processed this stanza and *nobody else* should 87 @return TRUE if the plugin processed this stanza and *nobody else* should
87 process it. FALSE otherwise. 88 process it. FALSE otherwise.
88 @endsignaldef
89
90 @signaldef jabber-sending-xmlnode
91 @signalproto
92 void (sending_xmlnode)(PurpleConnection *gc, xmlnode **stanza);
93 @endsignalproto
94 @signaldesc
95 Emit this signal (@c purple_signal_emit) to send a stanza. It is preferred
96 to use this instead of prpl_info->send_raw.
97 @param gc The connectoin on which to send the stanza.
98 @param stanza The stanza to send. If stanza is not NULL after being sent,
99 the emitter should free it.
100 @endsignaldef 89 @endsignaldef
101 90
102 @signaldef jabber-register-namespace-watcher 91 @signaldef jabber-register-namespace-watcher
103 @signalproto 92 @signalproto
104 void (register_namespace_watcher)(const char *node, const char *namespace); 93 void (register_namespace_watcher)(const char *node, const char *namespace);
119 emitted via the jabber-watched-iq signal when received. 108 emitted via the jabber-watched-iq signal when received.
120 @param node The IQ child name to no longer watch. 109 @param node The IQ child name to no longer watch.
121 @param namespace The IQ child namespace to no longer watch. 110 @param namespace The IQ child namespace to no longer watch.
122 @endsignaldef 111 @endsignaldef
123 112
113 @signaldef jabber-sending-xmlnode
114 @signalproto
115 void (sending_xmlnode)(PurpleConnection *gc, xmlnode **stanza);
116 @endsignalproto
117 @signaldesc
118 Emit this signal (@c purple_signal_emit) to send a stanza. It is preferred
119 to use this instead of prpl_info->send_raw.
120 @param gc The connection on which to send the stanza.
121 @param stanza The stanza to send. If stanza is not NULL after being sent,
122 the emitter should free it.
123 @endsignaldef
124
125 @signaldef jabber-receiving-xmlnode
126 @signalproto
127 void (receiving_xmlnode)(PurpleConnection *gc, xmlnode **stanza);
128 @endsignalproto
129 @signaldesc
130 Emitted when an XMPP stanza is received. Allows a plugin to process any
131 stanza.
132 @param gc The connection on which the stanza was received.
133 @param stanza The received stanza. Set stanza to NULL (and free it) to
134 stop processing the stanza.
135 @endsignaldef
136
124 */ 137 */
125 // vim: syntax=c.doxygen tw=75 et 138 // vim: syntax=c.doxygen tw=75 et