1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libircclient: irc_callbacks_t Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>irc_callbacks_t Struct Reference<br>
<small>
[<a class="el" href="group__events.html">Handling IRC events.</a>]</small>
</h1><!-- doxytag: class="irc_callbacks_t" -->Event callbacks structure.
<a href="#_details">More...</a>
<p>
<code>#include <libirc_events.h></code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#7294e75ca74ba6dc2b5c18ef8e7795a2">event_connect</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#6151296f8a888132bd25d7db67ff70a5">event_nick</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#a4a728c3926384c3781aa65a18ebeb7a">event_quit</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#8f24c0e2b05425c2308a0106dbaaffec">event_join</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#0076faaabcf638dba3f08c2048956621">event_part</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#3d7add398f78ad0a3c5d96133411d60a">event_mode</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#a92693d9acb2013f6f4b54301ee54d61">event_umode</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#8a5ab3ffc89e19d5748c58bb675436b5">event_topic</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#1a8194bfdbf2622e9384fbd1ac1a67d7">event_kick</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#87d4401073ce8dba9a43fcbcaa20d341">event_channel</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#f0fe4e42f9d675f0d844fc3c58b2dc5d">event_privmsg</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#92a5b22ba900f06fa04ea9e79462ffc6">event_notice</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#e5f3325ab13c3a36ed84435e3bcf7b61">event_invite</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#5f5d386a4df0d1334ffb96b3c406355f">event_ctcp_req</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#1e967e7534502bce5434dd4d4415bdd8">event_ctcp_rep</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#522d1cf8dc01b66efc03d31e3787e11f">event_ctcp_action</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#765b4f0a622cedf2c26c1a615414a3a4">event_unknown</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#gb6000d309e87cfb727dcad0136fcb79f">irc_eventcode_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#85951d45acff22aea37a822bb9c7aef7">event_numeric</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#g8c3ddaa55e5ded002b5054f0b926381c">irc_event_dcc_chat_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#fbaf019778a64b544093ee29da5b3c81">event_dcc_chat_req</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__events.html#g5f4b1d95f2d6619041f993ba748544cf">irc_event_dcc_send_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structirc__callbacks__t.html#2ac9d08921faee2472ed16d41799887d">event_dcc_send_req</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Event callbacks structure.
<p>
All the communication with the IRC network is based on events. Generally speaking, event is anything generated by someone else in the network, or by the IRC server itself. "Someone sends you a message", "Someone has joined the channel", "Someone has quits IRC" - all these messages are events.<p>
Every event has its own event handler, which is called when the appropriate event is received. You don't have to define all the event handlers; define only the handlers for the events you need to intercept.<p>
Most event callbacks are the types of <a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14" title="A most common event callback.">irc_event_callback_t</a>. There are also events, which generate <a class="el" href="group__events.html#gb6000d309e87cfb727dcad0136fcb79f" title="A numeric event callback.">irc_eventcode_callback_t</a>, <a class="el" href="group__events.html#g8c3ddaa55e5ded002b5054f0b926381c" title="A remote DCC CHAT request callback.">irc_event_dcc_chat_t</a> and <a class="el" href="group__events.html#g5f4b1d95f2d6619041f993ba748544cf" title="A remote DCC CHAT request callback.">irc_event_dcc_send_t</a> callbacks. <hr><h2>Field Documentation</h2>
<a class="anchor" name="7294e75ca74ba6dc2b5c18ef8e7795a2"></a><!-- doxytag: member="irc_callbacks_t::event_connect" ref="7294e75ca74ba6dc2b5c18ef8e7795a2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#7294e75ca74ba6dc2b5c18ef8e7795a2">irc_callbacks_t::event_connect</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "on_connect" event is triggered when the client successfully connects to the server, and could send commands to the server. No extra params supplied; <em>params</em> is 0.
</div>
</div><p>
<a class="anchor" name="6151296f8a888132bd25d7db67ff70a5"></a><!-- doxytag: member="irc_callbacks_t::event_nick" ref="6151296f8a888132bd25d7db67ff70a5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#6151296f8a888132bd25d7db67ff70a5">irc_callbacks_t::event_nick</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "nick" event is triggered when the client receives a NICK message, meaning that someone (including you) on a channel with the client has changed their nickname.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who changes the nick. Note that it can be you! </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the new nick. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a4a728c3926384c3781aa65a18ebeb7a"></a><!-- doxytag: member="irc_callbacks_t::event_quit" ref="a4a728c3926384c3781aa65a18ebeb7a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#a4a728c3926384c3781aa65a18ebeb7a">irc_callbacks_t::event_quit</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "quit" event is triggered upon receipt of a QUIT message, which means that someone on a channel with the client has disconnected.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who is disconnected </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>optional, contains the reason message (user-specified). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8f24c0e2b05425c2308a0106dbaaffec"></a><!-- doxytag: member="irc_callbacks_t::event_join" ref="8f24c0e2b05425c2308a0106dbaaffec" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#8f24c0e2b05425c2308a0106dbaaffec">irc_callbacks_t::event_join</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "join" event is triggered upon receipt of a JOIN message, which means that someone has entered a channel that the client is on.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who joins the channel. By comparing it with your own nickname, you can check whether your JOIN command succeed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the channel name. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0076faaabcf638dba3f08c2048956621"></a><!-- doxytag: member="irc_callbacks_t::event_part" ref="0076faaabcf638dba3f08c2048956621" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#0076faaabcf638dba3f08c2048956621">irc_callbacks_t::event_part</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "part" event is triggered upon receipt of a PART message, which means that someone has left a channel that the client is on.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who leaves the channel. By comparing it with your own nickname, you can check whether your PART command succeed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the channel name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[1]</em> </td><td>optional, contains the reason message (user-defined). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3d7add398f78ad0a3c5d96133411d60a"></a><!-- doxytag: member="irc_callbacks_t::event_mode" ref="3d7add398f78ad0a3c5d96133411d60a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#3d7add398f78ad0a3c5d96133411d60a">irc_callbacks_t::event_mode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "mode" event is triggered upon receipt of a channel MODE message, which means that someone on a channel with the client has changed the channel's parameters.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who changed the channel mode. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the channel name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[1]</em> </td><td>mandatory, contains the changed channel mode, like '+t', '-i' and so on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[2]</em> </td><td>optional, contains the mode argument (for example, a key for +k mode, or user who got the channel operator status for +o mode) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a92693d9acb2013f6f4b54301ee54d61"></a><!-- doxytag: member="irc_callbacks_t::event_umode" ref="a92693d9acb2013f6f4b54301ee54d61" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#a92693d9acb2013f6f4b54301ee54d61">irc_callbacks_t::event_umode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "umode" event is triggered upon receipt of a user MODE message, which means that your user mode has been changed.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who changed the channel mode. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the user changed mode, like '+t', '-i' and so on. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8a5ab3ffc89e19d5748c58bb675436b5"></a><!-- doxytag: member="irc_callbacks_t::event_topic" ref="8a5ab3ffc89e19d5748c58bb675436b5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#8a5ab3ffc89e19d5748c58bb675436b5">irc_callbacks_t::event_topic</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "topic" event is triggered upon receipt of a TOPIC message, which means that someone on a channel with the client has changed the channel's topic.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who changes the channel topic. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the channel name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[1]</em> </td><td>optional, contains the new topic. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1a8194bfdbf2622e9384fbd1ac1a67d7"></a><!-- doxytag: member="irc_callbacks_t::event_kick" ref="1a8194bfdbf2622e9384fbd1ac1a67d7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#1a8194bfdbf2622e9384fbd1ac1a67d7">irc_callbacks_t::event_kick</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "kick" event is triggered upon receipt of a KICK message, which means that someone on a channel with the client (or possibly the client itself!) has been forcibly ejected.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who kicked the poor. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the channel name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>optional, contains the nick of kicked person. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[1]</em> </td><td>optional, contains the kick text </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="87d4401073ce8dba9a43fcbcaa20d341"></a><!-- doxytag: member="irc_callbacks_t::event_channel" ref="87d4401073ce8dba9a43fcbcaa20d341" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#87d4401073ce8dba9a43fcbcaa20d341">irc_callbacks_t::event_channel</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "channel" event is triggered upon receipt of a PRIVMSG message to an entire channel, which means that someone on a channel with the client has said something aloud. Your own messages don't trigger PRIVMSG event.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who generates the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the channel name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[1]</em> </td><td>optional, contains the message text </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f0fe4e42f9d675f0d844fc3c58b2dc5d"></a><!-- doxytag: member="irc_callbacks_t::event_privmsg" ref="f0fe4e42f9d675f0d844fc3c58b2dc5d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#f0fe4e42f9d675f0d844fc3c58b2dc5d">irc_callbacks_t::event_privmsg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "privmsg" event is triggered upon receipt of a PRIVMSG message which is addressed to one or more clients, which means that someone is sending the client a private message.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who generates the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains your nick. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[1]</em> </td><td>optional, contains the message text </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="92a5b22ba900f06fa04ea9e79462ffc6"></a><!-- doxytag: member="irc_callbacks_t::event_notice" ref="92a5b22ba900f06fa04ea9e79462ffc6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#92a5b22ba900f06fa04ea9e79462ffc6">irc_callbacks_t::event_notice</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "notice" event is triggered upon receipt of a NOTICE message which means that someone has sent the client a public or private notice. According to RFC 1459, the only difference between NOTICE and PRIVMSG is that you should NEVER automatically reply to NOTICE messages. Unfortunately, this rule is frequently violated by IRC servers itself - for example, NICKSERV messages require reply, and are NOTICEs.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who generates the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains the channel name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[1]</em> </td><td>optional, contains the message text </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e5f3325ab13c3a36ed84435e3bcf7b61"></a><!-- doxytag: member="irc_callbacks_t::event_invite" ref="e5f3325ab13c3a36ed84435e3bcf7b61" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#e5f3325ab13c3a36ed84435e3bcf7b61">irc_callbacks_t::event_invite</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "invite" event is triggered upon receipt of an INVITE message, which means that someone is permitting the client's entry into a +i channel.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who INVITEs you. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, contains your nick. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[1]</em> </td><td>mandatory, contains the channel name you're invited into.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__ircmd__ch.html#g77e2b2c46c8883a7986180f36ca17247" title="Invites a user to invite-only channel.">irc_cmd_invite</a> irc_cmd_chanmode_invite </dd></dl>
</div>
</div><p>
<a class="anchor" name="5f5d386a4df0d1334ffb96b3c406355f"></a><!-- doxytag: member="irc_callbacks_t::event_ctcp_req" ref="5f5d386a4df0d1334ffb96b3c406355f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#5f5d386a4df0d1334ffb96b3c406355f">irc_callbacks_t::event_ctcp_req</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "ctcp" event is triggered when the client receives the CTCP request. By default, the built-in CTCP request handler is used. The build-in handler automatically replies on most CTCP messages, so you will rarely need to override it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who generates the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, the complete CTCP message, including its arguments.</td></tr>
</table>
</dl>
Mirc generates PING, FINGER, VERSION, TIME and ACTION messages, check the source code of <code>libirc_event_ctcp_internal</code> function to see how to write your own CTCP request handler. Also you may find useful this question in FAQ: <a class="el" href="pagefaq.html#faq4">What is CTCP, and why do I need my own handler?</a>
</div>
</div><p>
<a class="anchor" name="1e967e7534502bce5434dd4d4415bdd8"></a><!-- doxytag: member="irc_callbacks_t::event_ctcp_rep" ref="1e967e7534502bce5434dd4d4415bdd8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#1e967e7534502bce5434dd4d4415bdd8">irc_callbacks_t::event_ctcp_rep</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "ctcp" event is triggered when the client receives the CTCP reply.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who generates the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, the CTCP message itself with its arguments. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="522d1cf8dc01b66efc03d31e3787e11f"></a><!-- doxytag: member="irc_callbacks_t::event_ctcp_action" ref="522d1cf8dc01b66efc03d31e3787e11f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#522d1cf8dc01b66efc03d31e3787e11f">irc_callbacks_t::event_ctcp_action</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "action" event is triggered when the client receives the CTCP ACTION message. These messages usually looks like:<br>
<div class="fragment"><pre class="fragment"> [23:32:55] * Tim gonna sleep.
</pre></div><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>the person, who generates the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params[0]</em> </td><td>mandatory, the ACTION message. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="765b4f0a622cedf2c26c1a615414a3a4"></a><!-- doxytag: member="irc_callbacks_t::event_unknown" ref="765b4f0a622cedf2c26c1a615414a3a4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gc472d3e37df8f172fed3d75e649fac14">irc_event_callback_t</a> <a class="el" href="structirc__callbacks__t.html#765b4f0a622cedf2c26c1a615414a3a4">irc_callbacks_t::event_unknown</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "unknown" event is triggered upon receipt of any number of unclassifiable miscellaneous messages, which aren't handled by the library.
</div>
</div><p>
<a class="anchor" name="85951d45acff22aea37a822bb9c7aef7"></a><!-- doxytag: member="irc_callbacks_t::event_numeric" ref="85951d45acff22aea37a822bb9c7aef7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#gb6000d309e87cfb727dcad0136fcb79f">irc_eventcode_callback_t</a> <a class="el" href="structirc__callbacks__t.html#85951d45acff22aea37a822bb9c7aef7">irc_callbacks_t::event_numeric</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "numeric" event is triggered upon receipt of any numeric response from the server. There is a lot of such responses, see the full list here: <a class="el" href="group__rfcnumbers.html">Numeric reply codes from RFC1459</a>.<p>
See the params in <a class="el" href="group__events.html#gb6000d309e87cfb727dcad0136fcb79f" title="A numeric event callback.">irc_eventcode_callback_t</a> specification.
</div>
</div><p>
<a class="anchor" name="fbaf019778a64b544093ee29da5b3c81"></a><!-- doxytag: member="irc_callbacks_t::event_dcc_chat_req" ref="fbaf019778a64b544093ee29da5b3c81" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#g8c3ddaa55e5ded002b5054f0b926381c">irc_event_dcc_chat_t</a> <a class="el" href="structirc__callbacks__t.html#fbaf019778a64b544093ee29da5b3c81">irc_callbacks_t::event_dcc_chat_req</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "dcc chat" event is triggered when someone requests a DCC CHAT from you.<p>
See the params in <a class="el" href="group__events.html#g8c3ddaa55e5ded002b5054f0b926381c" title="A remote DCC CHAT request callback.">irc_event_dcc_chat_t</a> specification.
</div>
</div><p>
<a class="anchor" name="2ac9d08921faee2472ed16d41799887d"></a><!-- doxytag: member="irc_callbacks_t::event_dcc_send_req" ref="2ac9d08921faee2472ed16d41799887d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__events.html#g5f4b1d95f2d6619041f993ba748544cf">irc_event_dcc_send_t</a> <a class="el" href="structirc__callbacks__t.html#2ac9d08921faee2472ed16d41799887d">irc_callbacks_t::event_dcc_send_req</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The "dcc chat" event is triggered when someone wants to send a file to you via DCC SEND request.<p>
See the params in <a class="el" href="group__events.html#g5f4b1d95f2d6619041f993ba748544cf" title="A remote DCC CHAT request callback.">irc_event_dcc_send_t</a> specification.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="libirc__events_8h.html">libirc_events.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 3 15:01:07 2009 for libircclient by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
