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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2015 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
* Copyright (C) 2012 Robby <robby@chatbelgie.be>
* Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
* Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
namespace ServerProtocol
{
class BroadcastEventListener;
class LinkEventListener;
class MessageEventListener;
class SyncEventListener;
}
class ServerProtocol::BroadcastEventListener
: public Events::ModuleEventListener
{
public:
BroadcastEventListener(Module* mod)
: ModuleEventListener(mod, "event/server-broadcast")
{
}
/** Fired when a channel message is being broadcast across the network.
* @param channel The channel which is having a message sent to it.
* @param server The server which might have a message broadcast to it.
* @return Either MOD_RES_ALLOW to always send the message to the server, MOD_RES_DENY to never
* send the message to the server or MOD_RES_PASSTHRU if no module handled the event.
*/
virtual ModResult OnBroadcastMessage(Channel* channel, const Server* server) { return MOD_RES_PASSTHRU; }
};
class ServerProtocol::LinkEventListener
: public Events::ModuleEventListener
{
public:
LinkEventListener(Module* mod)
: ModuleEventListener(mod, "event/server-link")
{
}
/** Fired when a server has linked to the network.
* @param server Server that recently linked.
*/
virtual void OnServerLink(const Server* server) { }
/** Fired when a server has finished bursting.
* @param server Server that recently finished bursting.
*/
virtual void OnServerBurst(const Server* server) { }
/** Fired when a server splits
* @param server Server that split
* @param error Whether the server split because of an error.
*/
virtual void OnServerSplit(const Server* server, bool error) { }
};
class ServerProtocol::MessageEventListener
: public Events::ModuleEventListener
{
public:
MessageEventListener(Module* mod)
: ModuleEventListener(mod, "event/server-message")
{
}
/** Fired when a server message is being sent by a user.
* @param source The user who sent the message.
* @param name The name of the command which was sent.
* @param tags The tags which will be sent with the message.
*/
virtual void OnBuildUserMessage(User* source, const char* name, ClientProtocol::TagMap& tags) { }
/** Fired when a server message is being sent by a server.
* @param source The server who sent the message.
* @param name The name of the command which was sent.
* @param tags The tags which will be sent with the message.
*/
virtual void OnBuildServerMessage(Server* source, const char* name, ClientProtocol::TagMap& tags) { }
};
class ServerProtocol::SyncEventListener
: public Events::ModuleEventListener
{
public:
SyncEventListener(Module* mod)
: ModuleEventListener(mod, "event/server-sync")
{
}
/** Allows modules to synchronize user metadata during a netburst. This will
* be called for every user visible on your side of the burst.
* @param user The user being synchronized.
* @param server The target of the burst.
*/
virtual void OnSyncUser(User* user, ProtocolServer& server) { }
/** Allows modules to synchronize channel metadata during a netburst. This will
* be called for every channel visible on your side of the burst.
* @param chan The channel being synchronized.
* @param server The target of the burst.
*/
virtual void OnSyncChannel(Channel* chan, ProtocolServer& server) { }
/** Allows modules to synchronize network metadata during a netburst.
* @param server The target of the burst.
*/
virtual void OnSyncNetwork(ProtocolServer& server) { }
};
|
