1
Hook documentation - <lee -at- leeh.co.uk>
2
------------------------------------------
4
Documentation on how to actually develop code to use hooks is contained in
5
contrib/example_module.c, this document simply describes which hooks are
8
There are various hook structures available that may be passed to hooks:
9
hook_data - struct Client *client; const void *arg1;
11
hook_data_int - struct Client *client; const void *arg1; int arg2;
12
hook_data_client - struct Client *client; struct Client *target;
13
hook_data_channel - struct Client *client; struct Channel *chptr;
18
The following spy hooks are called only when the request is handled by the
19
local server. They will not be called if the command is being sent remotely
20
for another server to handle:
21
"doing_admin" - Passes hook_data:
22
hdata->client = client requesting ADMIN
24
"doing_info" - Passes hook_data:
25
hdata->client = client requesting INFO
27
"doing_links" - Passes hook_data:
28
hdata->client = client doing LINKS
29
(const char *) hdata->arg1 = optional mask
31
"doing_motd" - Passes hook_data:
32
hdata->client = client doing MOTD
34
"doing_stats" - Passes hook_data_int:
35
hdata->client = client doing STATS
36
(const char *) hdata->arg1 = optional stats l target
37
(char) hdata->arg2 = statchar being requested
39
"doing_stats_p" - Passes hook_data:
40
hdata->client = client doing STATS p
42
"doing_trace" - Passes hook_data_client:
43
hdata->client = client doing TRACE
44
hdata->target = optional target of TRACE
46
"doing_whois" - Passes hook_data_client:
47
hdata->client = local client doing WHOIS
48
hdata->target = target of WHOIS
50
"doing_whois_global" - Passes hook_data_client:
51
hdata->client = remote client doing WHOIS
52
hdata->target = target of WHOIS
57
The following burst hooks are called when we are sending a netburst to a
60
"burst_client" - Sent after we have just burst a user.
61
Passes hook_data_client:
62
hdata->client = server we are bursting to
63
hdata->target = user we have just burst
65
"burst_channel" - Sent after we have just burst a channel.
66
Passes hook_data_channel:
67
hdata->client = server we are bursting to
68
hdata->chptr = channel we have just burst
70
"burst_finished" - Sent after we have just finished bursting users/chans
71
Passes hook_data_client:
72
hdata->client = server we are bursting to
77
The following hooks are called during server connects/exits.
79
"server_eob" - Sent after a server finishes bursting to us.
80
Passes struct Client, the server that has
83
"server_introduced" - Sent after a server is introduced to the network,
85
Passes hook_data_client:
86
hdata->client = uplink server (&me if local)
87
hdata->target = server being introduced
92
The following hooks are called during various events related to clients.
94
"introduce_client" - Sent after introducing a client to the (rest of the)
96
Passes hook_data_client:
97
hdata->client = server that introduced this client
98
hdata->target = client being introduced
100
"new_local_user" - Sent just before introducing a new local user
101
to the network. IsUnknown is still true for the
102
client but everything else is set up; it is ok to
103
call exit_client() to refuse the client.
104
Passes struct Client, the client being introduced.
106
"new_remote_user" - Sent just before introducing a new remote user
107
to the rest of the network.
108
Passes struct Client, the client being introduced.
110
"umode_changed" - Sent each time a user's mode or snomask changes.
111
Passes hook_data_umode_changed:
112
client = client whose modes are changing
113
oldumodes = new user mode field
114
oldsnomask = new snomask field
117
The following are for debugging and take struct hook_io_data for arguments.
118
These can be used for a variety of purposes, but are aimed at the developer
124
$Id: hooks.txt 3414 2007-04-15 16:54:50Z jilles $
added
removed
doc/hooks.txt
