Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

Module Class Reference

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...

#include <modules.h>

Inheritance diagram for Module:

Inheritance graph
[legend]
Collaboration diagram for Module:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Module (Server *Me)
 Default constructor Creates a module class.
virtual ~Module ()
 Default destructor destroys a module class.
virtual Version GetVersion ()
 Returns the version number of a Module.
virtual void OnUserConnect (userrec *user)
 Called when a user connects.
virtual void OnUserQuit (userrec *user, std::string message)
 Called when a user quits.
virtual void OnUserDisconnect (userrec *user)
 Called whenever a user's socket is closed.
virtual void OnUserJoin (userrec *user, chanrec *channel)
 Called when a user joins a channel.
virtual void OnUserPart (userrec *user, chanrec *channel)
 Called when a user parts a channel.
virtual void OnRehash (std::string parameter)
 Called on rehash.
virtual void OnServerRaw (std::string &raw, bool inbound, userrec *user)
 Called when a raw command is transmitted or received.
virtual int OnExtendedMode (userrec *user, void *target, char modechar, int type, bool mode_on, string_list &params)
 Called whenever an extended mode is to be processed.
virtual int OnUserPreJoin (userrec *user, chanrec *chan, const char *cname)
 Called whenever a user is about to join a channel, before any processing is done.
virtual int OnUserPreKick (userrec *source, userrec *user, chanrec *chan, std::string reason)
 Called whenever a user is about to be kicked.
virtual void OnUserKick (userrec *source, userrec *user, chanrec *chan, std::string reason)
 Called whenever a user is kicked.
virtual void OnOper (userrec *user, std::string opertype)
 Called whenever a user opers locally.
virtual void OnInfo (userrec *user)
 Called whenever a user types /INFO.
virtual void OnWhois (userrec *source, userrec *dest)
 Called whenever a /WHOIS is performed on a local user.
virtual int OnUserPreInvite (userrec *source, userrec *dest, chanrec *channel)
 Called whenever a user is about to invite another user into a channel, before any processing is done.
virtual void OnUserInvite (userrec *source, userrec *dest, chanrec *channel)
 Called after a user has been successfully invited to a channel.
virtual int OnUserPreMessage (userrec *user, void *dest, int target_type, std::string &text)
 Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
virtual int OnUserPreNotice (userrec *user, void *dest, int target_type, std::string &text)
 Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
virtual int OnUserPreNick (userrec *user, std::string newnick)
 Called before any nickchange, local or remote.
virtual void OnUserMessage (userrec *user, void *dest, int target_type, std::string text)
 Called after any PRIVMSG sent from a user.
virtual void OnUserNotice (userrec *user, void *dest, int target_type, std::string text)
 Called after any NOTICE sent from a user.
virtual void OnMode (userrec *user, void *dest, int target_type, std::string text)
 Called after every MODE command sent from a user The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL.
virtual void OnGetServerDescription (std::string servername, std::string &description)
 Allows modules to alter or create server descriptions Whenever a module requires a server description, for example for display in WHOIS, this function is called in all modules.
virtual void OnSyncUser (userrec *user, Module *proto, void *opaque)
 Allows modules to synchronize data which relates to users during a netburst.
virtual void OnSyncChannel (chanrec *chan, Module *proto, void *opaque)
 Allows modules to synchronize data which relates to channels during a netburst.
virtual void OnSyncChannelMetaData (chanrec *chan, Module *proto, void *opaque, std::string extname)
virtual void OnSyncUserMetaData (userrec *user, Module *proto, void *opaque, std::string extname)
virtual void OnDecodeMetaData (int target_type, void *target, std::string extname, std::string extdata)
 Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
virtual void ProtoSendMode (void *opaque, int target_type, void *target, std::string modeline)
 Implemented by modules which provide the ability to link servers.
virtual void ProtoSendMetaData (void *opaque, int target_type, void *target, std::string extname, std::string extdata)
 Implemented by modules which provide the ability to link servers.
virtual void OnWallops (userrec *user, std::string text)
 Called after every WALLOPS command.
virtual void OnChangeHost (userrec *user, std::string newhost)
 Called whenever a user's hostname is changed.
virtual void OnChangeName (userrec *user, std::string gecos)
 Called whenever a user's GECOS (realname) is changed.
virtual void OnAddGLine (long duration, userrec *source, std::string reason, std::string hostmask)
 Called whenever a gline is added by a local user.
virtual void OnAddZLine (long duration, userrec *source, std::string reason, std::string ipmask)
 Called whenever a zline is added by a local user.
virtual void OnAddKLine (long duration, userrec *source, std::string reason, std::string hostmask)
 Called whenever a kline is added by a local user.
virtual void OnAddQLine (long duration, userrec *source, std::string reason, std::string nickmask)
 Called whenever a qline is added by a local user.
virtual void OnAddELine (long duration, userrec *source, std::string reason, std::string hostmask)
 Called whenever a eline is added by a local user.
virtual void OnDelGLine (userrec *source, std::string hostmask)
 Called whenever a gline is deleted.
virtual void OnDelZLine (userrec *source, std::string ipmask)
 Called whenever a zline is deleted.
virtual void OnDelKLine (userrec *source, std::string hostmask)
 Called whenever a kline is deleted.
virtual void OnDelQLine (userrec *source, std::string nickmask)
 Called whenever a qline is deleted.
virtual void OnDelELine (userrec *source, std::string hostmask)
 Called whenever a eline is deleted.
virtual void OnCleanup (int target_type, void *item)
 Called before your module is unloaded to clean up Extensibles.
virtual void OnUserPostNick (userrec *user, std::string oldnick)
 Called after any nickchange, local or remote.
virtual int OnAccessCheck (userrec *source, userrec *dest, chanrec *channel, int access_type)
 Called before an action which requires a channel privilage check.
virtual void On005Numeric (std::string &output)
 Called when a 005 numeric is about to be output.
virtual int OnKill (userrec *source, userrec *dest, std::string reason)
 Called when a client is disconnected by KILL.
virtual void OnRemoteKill (userrec *source, userrec *dest, std::string reason)
 Called when an oper wants to disconnect a remote user via KILL.
virtual void OnLoadModule (Module *mod, std::string name)
 Called whenever a module is loaded.
virtual void OnUnloadModule (Module *mod, std::string name)
 Called whenever a module is unloaded.
virtual void OnBackgroundTimer (time_t curtime)
 Called once every five seconds for background processing.
virtual void OnSendList (userrec *user, chanrec *channel, char mode)
 Called whenever a list is needed for a listmode.
virtual int OnPreCommand (std::string command, char **parameters, int pcnt, userrec *user)
 Called whenever any command is about to be executed.
virtual bool OnCheckReady (userrec *user)
 Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true.
virtual void OnUserRegister (userrec *user)
 Called whenever a user is about to register their connection (e.g.
virtual int OnRawMode (userrec *user, chanrec *chan, char mode, std::string param, bool adding, int pcnt)
 Called whenever a mode character is processed.
virtual int OnCheckInvite (userrec *user, chanrec *chan)
 Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
virtual int OnCheckKey (userrec *user, chanrec *chan, std::string keygiven)
 Called whenever a user joins a channel, to determine if key checks should go ahead or not.
virtual int OnCheckLimit (userrec *user, chanrec *chan)
 Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
virtual int OnCheckBan (userrec *user, chanrec *chan)
 Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
virtual void OnStats (char symbol)
 Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.
virtual int OnChangeLocalUserHost (userrec *user, std::string newhost)
 Called whenever a change of a local users displayed host is attempted.
virtual int OnChangeLocalUserGECOS (userrec *user, std::string newhost)
 Called whenever a change of a local users GECOS (fullname field) is attempted.
virtual int OnLocalTopicChange (userrec *user, chanrec *chan, std::string topic)
 Called whenever a topic is changed by a local user.
virtual void OnPostLocalTopicChange (userrec *user, chanrec *chan, std::string topic)
 Called whenever a local topic has been changed.
virtual void OnEvent (Event *event)
 Called whenever an Event class is sent to all module by another module.
virtual char * OnRequest (Request *request)
 Called whenever a Request class is sent to your module by another module.
virtual int OnOperCompare (std::string password, std::string input)
 Called whenever an oper password is to be compared to what a user has input.
virtual void OnGlobalOper (userrec *user)
 Called whenever a user is given usermode +o, anywhere on the network.
virtual void OnGlobalConnect (userrec *user)
 Called whenever a user connects, anywhere on the network.
virtual int OnAddBan (userrec *source, chanrec *channel, std::string banmask)
 Called whenever a ban is added to a channel's list.
virtual int OnDelBan (userrec *source, chanrec *channel, std::string banmask)
 Called whenever a ban is removed from a channel's list.
virtual void OnRawSocketAccept (int fd, std::string ip, int localport)
 Called immediately after any connection is accepted.
virtual int OnRawSocketWrite (int fd, char *buffer, int count)
 Called immediately before any write() operation on a user's socket in the core.
virtual void OnRawSocketClose (int fd)
 Called immediately before any socket is closed.
virtual int OnRawSocketRead (int fd, char *buffer, unsigned int count, int &readresult)
 Called immediately before any read() operation on a client socket in the core.

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules.

All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.

Definition at line 254 of file modules.h.

Constructor & Destructor Documentation

Module::Module (  Server *  Me  ) 
 

Default constructor Creates a module class.

Parameters:
Me An instance of the Server class which can be saved for future use

Definition at line 228 of file modules.cpp.

00228 { }

Module::~Module (   )  [virtual]
 

Default destructor destroys a module class.

Definition at line 229 of file modules.cpp.

00229 { }

Member Function Documentation

Version Module::GetVersion (   )  [virtual]
 

Returns the version number of a Module.

The method should return a Version object with its version information assigned via Version::Version

Definition at line 240 of file modules.cpp.

References VF_VENDOR.

00240 { return Version(1,0,0,0,VF_VENDOR); }

void Module::On005Numeric (  std::string &  output  )  [virtual]
 

Called when a 005 numeric is about to be output.

The module should modify the 005 numeric if needed to indicate its features.

Parameters:
output The 005 string to be modified if neccessary.

Definition at line 250 of file modules.cpp.

00250 { };

int Module::OnAccessCheck (  userrec *  source,
userrec *  dest,
chanrec *  channel,
int  access_type
)  [virtual]
 

Called before an action which requires a channel privilage check.

This function is called before many functions which check a users status on a channel, for example before opping a user, deopping a user, kicking a user, etc. There are several values for access_type which indicate for what reason access is being checked. These are:

AC_KICK (0) - A user is being kicked
AC_DEOP (1) - a user is being deopped
AC_OP (2) - a user is being opped
AC_VOICE (3) - a user is being voiced
AC_DEVOICE (4) - a user is being devoiced
AC_HALFOP (5) - a user is being halfopped
AC_DEHALFOP (6) - a user is being dehalfopped
AC_INVITE (7) - a user is being invited
AC_GENERAL_MODE (8) - a user channel mode is being changed<br>
Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).

Parameters:
source The source of the access check
dest The destination of the access check
channel The channel which is being checked
access_type See above

Definition at line 249 of file modules.cpp.

References ACR_DEFAULT.

00249 { return ACR_DEFAULT; };

int Module::OnAddBan (  userrec *  source,
chanrec *  channel,
std::string  banmask
)  [virtual]
 

Called whenever a ban is added to a channel's list.

Return a non-zero value to 'eat' the mode change and prevent the ban from being added.

Parameters:
source The user adding the ban
channel The channel the ban is being added to
banmask The ban mask being added
Returns:
1 to block the ban, 0 to continue as normal

Definition at line 275 of file modules.cpp.

00275 { return 0; };

void Module::OnAddELine (  long  duration,
userrec *  source,
std::string  reason,
std::string  hostmask
)  [virtual]
 

Called whenever a eline is added by a local user.

This method is triggered after the line is added.

Parameters:
duration The duration of the line in seconds
source The sender of the line
reason The reason text to be displayed
hostmask The hostmask to add

Definition at line 301 of file modules.cpp.

00301 { };

void Module::OnAddGLine (  long  duration,
userrec *  source,
std::string  reason,
std::string  hostmask
)  [virtual]
 

Called whenever a gline is added by a local user.

This method is triggered after the line is added.

Parameters:
duration The duration of the line in seconds
source The sender of the line
reason The reason text to be displayed
hostmask The hostmask to add

Definition at line 297 of file modules.cpp.

00297 { };

void Module::OnAddKLine (  long  duration,
userrec *  source,
std::string  reason,
std::string  hostmask
)  [virtual]
 

Called whenever a kline is added by a local user.

This method is triggered after the line is added.

Parameters:
duration The duration of the line in seconds
source The sender of the line
reason The reason text to be displayed
hostmask The hostmask to add

Definition at line 299 of file modules.cpp.

00299 { };

void Module::OnAddQLine (  long  duration,
userrec *  source,
std::string  reason,
std::string  nickmask
)  [virtual]
 

Called whenever a qline is added by a local user.

This method is triggered after the line is added.

Parameters:
duration The duration of the line in seconds
source The sender of the line
reason The reason text to be displayed
nickmask The hostmask to add

Definition at line 300 of file modules.cpp.

00300 { };

void Module::OnAddZLine (  long  duration,
userrec *  source,
std::string  reason,
std::string  ipmask
)  [virtual]
 

Called whenever a zline is added by a local user.

This method is triggered after the line is added.

Parameters:
duration The duration of the line in seconds
source The sender of the line
reason The reason text to be displayed
ipmask The hostmask to add

Definition at line 298 of file modules.cpp.

00298 { };

void Module::OnBackgroundTimer (  time_t  curtime  )  [virtual]
 

Called once every five seconds for background processing.

This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.

Parameters:
curtime The current timer derived from time(2)

Definition at line 254 of file modules.cpp.

00254 { };

void Module::OnChangeHost (  userrec *  user,
std::string  newhost
)  [virtual]
 

Called whenever a user's hostname is changed.

This event triggers after the host has been set.

Parameters:
user The user whos host is being changed
newhost The new hostname being set

Definition at line 295 of file modules.cpp.

00295 { };

int Module::OnChangeLocalUserGECOS (  userrec *  user,
std::string  newhost
)  [virtual]
 

Called whenever a change of a local users GECOS (fullname field) is attempted.

return 1 to deny the name change, or 0 to allow it.

Parameters:
user The user whos GECOS will be changed
newhost The new GECOS
Returns:
1 to deny the GECOS change, 0 to allow

Definition at line 268 of file modules.cpp.

00268 { return 0; };

int Module::OnChangeLocalUserHost (  userrec *  user,
std::string  newhost
)  [virtual]
 

Called whenever a change of a local users displayed host is attempted.

Return 1 to deny the host change, or 0 to allow it.

Parameters:
user The user whos host will be changed
newhost The new hostname
Returns:
1 to deny the host change, 0 to allow

Definition at line 267 of file modules.cpp.

00267 { return 0; };

void Module::OnChangeName (  userrec *  user,
std::string  gecos
)  [virtual]
 

Called whenever a user's GECOS (realname) is changed.

This event triggers after the name has been set.

Parameters:
user The user who's GECOS is being changed
gecos The new GECOS being set on the user

Definition at line 296 of file modules.cpp.

00296 { };

int Module::OnCheckBan (  userrec *  user,
chanrec *  chan
)  [virtual]
 

Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.

This method will always be called for each join, wether or not the user actually matches a channel ban, and determines the outcome of an if statement around the whole section of ban checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.

Parameters:
user The user joining the channel
chan The channel being joined
Returns:
1 to explicitly allow the join, 0 to proceed as normal

Definition at line 265 of file modules.cpp.

00265 { return 0; };

int Module::OnCheckInvite (  userrec *  user,
chanrec *  chan
)  [virtual]
 

Called whenever a user joins a channel, to determine if invite checks should go ahead or not.

This method will always be called for each join, wether or not the channel is actually +i, and determines the outcome of an if statement around the whole section of invite checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.

Parameters:
user The user joining the channel
chan The channel being joined
Returns:
1 to explicitly allow the join, 0 to proceed as normal

Definition at line 262 of file modules.cpp.

00262 { return 0; };

int Module::OnCheckKey (  userrec *  user,
chanrec *  chan,
std::string  keygiven
)  [virtual]
 

Called whenever a user joins a channel, to determine if key checks should go ahead or not.

This method will always be called for each join, wether or not the channel is actually +k, and determines the outcome of an if statement around the whole section of key checking code. if the user specified no key, the keygiven string will be a valid but empty value. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.

Parameters:
user The user joining the channel
chan The channel being joined
Returns:
1 to explicitly allow the join, 0 to proceed as normal

Definition at line 263 of file modules.cpp.

00263 { return 0; };

int Module::OnCheckLimit (  userrec *  user,
chanrec *  chan
)  [virtual]
 

Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.

This method will always be called for each join, wether or not the channel is actually +l, and determines the outcome of an if statement around the whole section of channel limit checking code. return 1 to explicitly allow the join to go ahead or 0 to ignore the event.

Parameters:
user The user joining the channel
chan The channel being joined
Returns:
1 to explicitly allow the join, 0 to proceed as normal

Definition at line 264 of file modules.cpp.

00264 { return 0; };

bool Module::OnCheckReady (  userrec *  user  )  [virtual]
 

Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true.

For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.

Parameters:
user The user to check
Returns:
true to indicate readiness, false if otherwise

Definition at line 257 of file modules.cpp.

00257 { return true; };

void Module::OnCleanup (  int  target_type,
void *  item
)  [virtual]
 

Called before your module is unloaded to clean up Extensibles.

This method is called once for every user and channel on the network, so that when your module unloads it may clear up any remaining data in the form of Extensibles added using Extensible::Extend(). If the target_type variable is TYPE_USER, then void* item refers to a userrec*, otherwise it refers to a chanrec*.

Parameters:
target_type The type of item being cleaned
item A pointer to the item's class

Definition at line 307 of file modules.cpp.

00307 { };

void Module::OnDecodeMetaData (  int  target_type,
void *  target,
std::string  extname,
std::string  extdata
)  [virtual]
 

Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.

Please see src/modules/m_swhois.cpp for a working example of how to use this method call.

Parameters:
target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
target The chanrec* or userrec* that data should be added to
extname The extension name which is being sent
extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData

Definition at line 292 of file modules.cpp.

00292 { };

int Module::OnDelBan (  userrec *  source,
chanrec *  channel,
std::string  banmask
)  [virtual]
 

Called whenever a ban is removed from a channel's list.

Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.

Parameters:
source The user deleting the ban
channel The channel the ban is being deleted from
banmask The ban mask being deleted
Returns:
1 to block the unban, 0 to continue as normal

Definition at line 276 of file modules.cpp.

00276 { return 0; };

void Module::OnDelELine (  userrec *  source,
std::string  hostmask
)  [virtual]
 

Called whenever a eline is deleted.

This method is triggered after the line is deleted.

Parameters:
source The user removing the line
hostmask The hostmask to delete

Definition at line 306 of file modules.cpp.

00306 { };

void Module::OnDelGLine (  userrec *  source,
std::string  hostmask
)  [virtual]
 

Called whenever a gline is deleted.

This method is triggered after the line is deleted.

Parameters:
source The user removing the line
hostmask The hostmask to delete

Definition at line 302 of file modules.cpp.

00302 { };

void Module::OnDelKLine (  userrec *  source,
std::string  hostmask
)  [virtual]
 

Called whenever a kline is deleted.

This method is triggered after the line is deleted.

Parameters:
source The user removing the line
hostmask The hostmask to delete

Definition at line 304 of file modules.cpp.

00304 { };

void Module::OnDelQLine (  userrec *  source,
std::string  nickmask
)  [virtual]
 

Called whenever a qline is deleted.

This method is triggered after the line is deleted.

Parameters:
source The user removing the line
hostmask The hostmask to delete

Definition at line 305 of file modules.cpp.

00305 { };

void Module::OnDelZLine (  userrec *  source,
std::string  ipmask
)  [virtual]
 

Called whenever a zline is deleted.

This method is triggered after the line is deleted.

Parameters:
source The user removing the line
hostmask The hostmask to delete

Definition at line 303 of file modules.cpp.

00303 { };

void Module::OnEvent (  Event *  event  )  [virtual]
 

Called whenever an Event class is sent to all module by another module.

Please see the documentation of Event::Send() for further information. The Event sent can always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID() before doing anything to the event data, and you should *not* change the event data in any way!

Parameters:
event The Event class being received

Definition at line 270 of file modules.cpp.

00270 { return; };

int Module::OnExtendedMode (  userrec *  user,
void *  target,
char  modechar,
int  type,
bool  mode_on,
string_list &  params
)  [virtual]
 

Called whenever an extended mode is to be processed.

The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with Server::AddExtendedMode If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*. You must cast this value yourself to make use of it.

Parameters:
user The user issuing the mode
target The user or channel having the mode set on them
modechar The mode character being set
type The type of mode (user or channel) being set
mode_on True if the mode is being set, false if it is being unset
params A list of parameters for any channel mode (currently supports either 0 or 1 parameters)

Definition at line 238 of file modules.cpp.

00238 { return false; }

void Module::OnGetServerDescription (  std::string  servername,
std::string &  description
)  [virtual]
 

Allows modules to alter or create server descriptions Whenever a module requires a server description, for example for display in WHOIS, this function is called in all modules.

You may change or define the description given in std::string &description. If you do, this description will be shown in the WHOIS fields.

Parameters:
servername The servername being searched for
description Alterable server description for this server

Definition at line 286 of file modules.cpp.

00286 { };

void Module::OnGlobalConnect (  userrec *  user  )  [virtual]
 

Called whenever a user connects, anywhere on the network.

This event is informational only. You should not change any user information in this event. To do so, use the OnUserConnect method to change the state of local users.

Parameters:
user The user who is connecting

Definition at line 274 of file modules.cpp.

00274 { };

void Module::OnGlobalOper (  userrec *  user  )  [virtual]
 

Called whenever a user is given usermode +o, anywhere on the network.

You cannot override this and prevent it from happening as it is already happened and such a task must be performed by another server. You can however bounce modes by sending servermodes out to reverse mode changes.

Parameters:
user The user who is opering

Definition at line 273 of file modules.cpp.

00273 { };

void Module::OnInfo (  userrec *  user  )  [virtual]
 

Called whenever a user types /INFO.

The userrec will contain the information of the user who typed the command. Modules may use this method to output their own credits in /INFO (which is the ircd's version of an about box). It is purposefully not possible to modify any info that has already been output, or halt the list. You must write a 371 numeric to the user, containing your info in the following format:

<nick> :information here

Parameters:
user The user issuing /INFO

Definition at line 242 of file modules.cpp.

00242 { };

int Module::OnKill (  userrec *  source,
userrec *  dest,
std::string  reason
)  [virtual]
 

Called when a client is disconnected by KILL.

If a client is killed by a server, e.g. a nickname collision or protocol error, source is NULL. Return 1 from this function to prevent the kill, and 0 from this function to allow it as normal. If you prevent the kill no output will be sent to the client, it is down to your module to generate this information. NOTE: It is NOT advisable to stop kills which originate from servers or remote users. If you do so youre risking race conditions, desyncs and worse!

Parameters:
source The user sending the KILL
dest The user being killed
reason The kill reason
Returns:
1 to prevent the kill, 0 to allow

Definition at line 251 of file modules.cpp.

00251 { return 0; };

void Module::OnLoadModule (  Module *  mod,
std::string  name
)  [virtual]
 

Called whenever a module is loaded.

mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).

Parameters:
mod A pointer to the new module
name The new module's filename

Definition at line 252 of file modules.cpp.

00252 { };

int Module::OnLocalTopicChange (  userrec *  user,
chanrec *  chan,
std::string  topic
)  [virtual]
 

Called whenever a topic is changed by a local user.

Return 1 to deny the topic change, or 0 to allow it.

Parameters:
user The user changing the topic
chan The channels who's topic is being changed
topic The actual topic text
1 to block the topic change, 0 to allow

Definition at line 269 of file modules.cpp.

00269 { return 0; };

void Module::OnMode (  userrec *  user,
void *  dest,
int  target_type,
std::string  text
)  [virtual]
 

Called after every MODE command sent from a user The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL.

The text variable contains the remainder of the mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".

Parameters:
user The user sending the MODEs
dest The target of the modes (userrec* or chanrec*)
target_type The type of target (TYPE_USER or TYPE_CHANNEL)
text The actual modes and their parameters if any

Definition at line 239 of file modules.cpp.

00239 { };

void Module::OnOper (  userrec *  user,
std::string  opertype
)  [virtual]
 

Called whenever a user opers locally.

The userrec will contain the oper mode 'o' as this function is called after any modifications are made to the user's structure by the core.

Parameters:
user The user who is opering up
opertype The opers type name

Definition at line 241 of file modules.cpp.

00241 { };

int Module::OnOperCompare (  std::string  password,
std::string  input
)  [virtual]
 

Called whenever an oper password is to be compared to what a user has input.

The password field (from the config file) is in 'password' and is to be compared against 'input'. This method allows for encryption of oper passwords and much more besides. You should return a nonzero value if you want to allow the comparison or zero if you wish to do nothing.

Parameters:
password The oper's password
input The password entered
Returns:
1 to match the passwords, 0 to do nothing

Definition at line 272 of file modules.cpp.

00272 { return 0; };

void Module::OnPostLocalTopicChange (  userrec *  user,
chanrec *  chan,
std::string  topic
)  [virtual]
 

Called whenever a local topic has been changed.

To block topic changes you must use OnLocalTopicChange instead.

Parameters:
user The user changing the topic
chan The channels who's topic is being changed
topic The actual topic text

Definition at line 285 of file modules.cpp.

00285 { };

int Module::OnPreCommand (  std::string  command,
char **  parameters,
int  pcnt,
userrec *  user
)  [virtual]
 

Called whenever any command is about to be executed.

This event occurs for all registered commands, wether they are registered in the core, or another module, but it will not occur for invalid commands (e.g. ones which do not exist within the command table). By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using Server::QuitUser) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!)

Parameters:
command The command being executed
parameters An array of array of characters containing the parameters for the command
pcnt The nuimber of parameters passed to the command
user the user issuing the command
Returns:
1 to block the command, 0 to allow

Definition at line 256 of file modules.cpp.

00256 { return 0; };

int Module::OnRawMode (  userrec *  user,
chanrec *  chan,
char  mode,
std::string  param,
bool  adding,
int  pcnt
)  [virtual]
 

Called whenever a mode character is processed.

Return 1 from this function to block the mode character from being processed entirely, so that you may perform your own code instead. Note that this method allows you to override modes defined by other modes, but this is NOT RECOMMENDED!

Parameters:
user The user who is sending the mode
chan The channel the mode is being sent to
mode The mode character being set
param The parameter for the mode or an empty string
adding true of the mode is being added, false if it is being removed
pcnt The parameter count for the mode (0 or 1)
Returns:
1 to deny the mode, 0 to allow

Definition at line 261 of file modules.cpp.

00261 { return 0; };

void Module::OnRawSocketAccept (  int  fd,
std::string  ip,
int  localport
)  [virtual]
 

Called immediately after any connection is accepted.

This is intended for raw socket processing (e.g. modules which wrap the tcp connection within another library) and provides no information relating to a user record as the connection has not been assigned yet. There are no return values from this call as all modules get an opportunity if required to process the connection.

Parameters:
fd The file descriptor returned from accept()
ip The IP address of the connecting user
localport The local port number the user connected to

Definition at line 277 of file modules.cpp.

00277 { };

void Module::OnRawSocketClose (  int  fd  )  [virtual]
 

Called immediately before any socket is closed.

When this event is called, shutdown() has not yet been called on the socket.

Parameters:
fd The file descriptor of the socket prior to close()

Definition at line 279 of file modules.cpp.

00279 { };

int Module::OnRawSocketRead (  int  fd,
char *  buffer,
unsigned int  count,
int &  readresult
)  [virtual]
 

Called immediately before any read() operation on a client socket in the core.

This occurs AFTER the select() or poll() so there is always data waiting to be read when this event occurs. Your event should return 1 if it has handled the reading itself, which prevents the core just using read(). You should place any data read into buffer, up to but NOT GREATER THAN the value of count. The value of readresult must be identical to an actual result that might be returned from the read() system call, for example, number of bytes read upon success, 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value, you MUST set readresult.

Parameters:
fd The file descriptor of the socket
buffer A char* buffer being read to
count The size of the buffer
readresult The amount of characters read, or 0
Returns:
nonzero if the event was handled, in which case readresult must be valid on exit

Definition at line 280 of file modules.cpp.

00280 { return 0; };

int Module::OnRawSocketWrite (  int  fd,
char *  buffer,
int  count
)  [virtual]
 

Called immediately before any write() operation on a user's socket in the core.

Because this event is a low level event no user information is associated with it. It is intended for use by modules which may wrap connections within another API such as SSL for example. return a non-zero result if you have handled the write operation, in which case the core will not call write().

Parameters:
fd The file descriptor of the socket
buffer A char* buffer being written
Number of characters to write
Returns:
Number of characters actually written or 0 if you didn't handle the operation

Definition at line 278 of file modules.cpp.

00278 { return 0; };

void Module::OnRehash (  std::string  parameter  )  [virtual]
 

Called on rehash.

This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application. If a parameter is given, the core has done nothing. The module receiving the event can decide if this parameter has any relevence to it.

Parameters:
parameter The (optional) parameter given to REHASH from the user.

Definition at line 235 of file modules.cpp.

00235 { }

void Module::OnRemoteKill (  userrec *  source,
userrec *  dest,
std::string  reason
)  [virtual]
 

Called when an oper wants to disconnect a remote user via KILL.

Parameters:
source The user sending the KILL
dest The user being killed
reason The kill reason

Definition at line 283 of file modules.cpp.

00283 { };

char * Module::OnRequest (  Request *  request  )  [virtual]
 

Called whenever a Request class is sent to your module by another module.

Please see the documentation of Request::Send() for further information. The Request sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).

Parameters:
request The Request class being received

Definition at line 271 of file modules.cpp.

Referenced by Request::Send().

00271 { return NULL; };

void Module::OnSendList (  userrec *  user,
chanrec *  channel,
char  mode
)  [virtual]
 

Called whenever a list is needed for a listmode.

For example, when a /MODE channel +b (without any other parameters) is called, if a module was handling +b this function would be called. The function can then output any lists it wishes to. Please note that all modules will see all mode characters to provide the ability to extend each other, so please only output a list if the mode character given matches the one(s) you want to handle.

Parameters:
user The user requesting the list
channel The channel the list is for
mode The listmode which a list is being requested on

Definition at line 255 of file modules.cpp.

00255 { };

void Module::OnServerRaw (  std::string &  raw,
bool  inbound,
userrec *  user
)  [virtual]
 

Called when a raw command is transmitted or received.

This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter "raw". If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where inbound is set to true) the value of user will be the userrec of the connection sending the data. This is not possible for outbound data because the data may be being routed to multiple targets.

Parameters:
raw The raw string in RFC1459 format
inbound A flag to indicate wether the data is coming into the daemon or going out to the user
user The user record sending the text, when inbound == true.

Definition at line 236 of file modules.cpp.

00236 { }

void Module::OnStats (  char  symbol  )  [virtual]
 

Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.

Parameters:
symbol the symbol provided to /STATS

Definition at line 266 of file modules.cpp.

00266 { };

void Module::OnSyncChannel (  chanrec *  chan,
Module *  proto,
void *  opaque
)  [virtual]
 

Allows modules to synchronize data which relates to channels during a netburst.

When this function is called, it will be called from the module which implements the linking protocol. This currently is m_spanningtree.so. A pointer to this module is given in Module* proto, so that you may call its methods such as ProtoSendMode (see below). This function will be called for every user visible on your side of the burst, allowing you to for example set modes, etc. Do not use this call to synchronize data which you have stored using class Extensible -- There is a specialist function OnSyncUserMetaData and OnSyncChannelMetaData for this!

For a good example of how to use this function, please see src/modules/m_chanprotect.cpp

Parameters:
chan The channel being syncronized
proto A pointer to the module handling network protocol
opaque An opaque pointer set by the protocol module, should not be modified!

Definition at line 288 of file modules.cpp.

00288 { };

void Module::OnSyncChannelMetaData (  chanrec *  chan,
Module *  proto,
void *  opaque,
std::string  extname
)  [virtual]
 

Definition at line 290 of file modules.cpp.

00290 { };

void Module::OnSyncUser (  userrec *  user,
Module *  proto,
void *  opaque
)  [virtual]
 

Allows modules to synchronize data which relates to users during a netburst.

When this function is called, it will be called from the module which implements the linking protocol. This currently is m_spanningtree.so. A pointer to this module is given in Module* proto, so that you may call its methods such as ProtoSendMode (see below). This function will be called for every user visible on your side of the burst, allowing you to for example set modes, etc. Do not use this call to synchronize data which you have stored using class Extensible -- There is a specialist function OnSyncUserMetaData and OnSyncChannelMetaData for this!

Parameters:
user The user being syncronized
proto A pointer to the module handling network protocol
opaque An opaque pointer set by the protocol module, should not be modified!

Definition at line 287 of file modules.cpp.

00287 { };

void Module::OnSyncUserMetaData (  userrec *  user,
Module *  proto,
void *  opaque,
std::string  extname
)  [virtual]
 

Definition at line 291 of file modules.cpp.

00291 { };

void Module::OnUnloadModule (  Module *  mod,
std::string  name
)  [virtual]
 

Called whenever a module is unloaded.

mod will contain a pointer to the module, and string will contain its name, for example m_widgets.so. This function is primary for dependency checking, your module may decide to enable some extra features if it sees that you have for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly recommended that modules do *NOT* bail if they cannot satisfy dependencies, but instead operate under reduced functionality, unless the dependency is absolutely neccessary (e.g. a module that extends the features of another module).

Parameters:
mod Pointer to the module being unloaded (still valid)
name The filename of the module being unloaded

Definition at line 253 of file modules.cpp.

00253 { };

void Module::OnUserConnect (  userrec *  user  )  [virtual]
 

Called when a user connects.

The details of the connecting user are available to you in the parameter userrec *user

Parameters:
user The user who is connecting

Definition at line 230 of file modules.cpp.

00230 { }

void Module::OnUserDisconnect (  userrec *  user  )  [virtual]
 

Called whenever a user's socket is closed.

The details of the exiting user are available to you in the parameter userrec *user This event is called for all users, registered or not, as a cleanup method for modules which might assign resources to user, such as dns lookups, objects and sockets.

Parameters:
user The user who is disconnecting

Definition at line 232 of file modules.cpp.

00232 { }

void Module::OnUserInvite (  userrec *  source,
userrec *  dest,
chanrec *  channel
)  [virtual]
 

Called after a user has been successfully invited to a channel.

You cannot prevent the invite from occuring using this function, to do that, use OnUserPreInvite instead.

Parameters:
source The user who is issuing the INVITE
dest The user being invited
channel The channel the user is being invited to

Definition at line 284 of file modules.cpp.

00284 { };

void Module::OnUserJoin (  userrec *  user,
chanrec *  channel
)  [virtual]
 

Called when a user joins a channel.

The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel

Parameters:
user The user who is joining
channel The channel being joined

Definition at line 233 of file modules.cpp.

00233 { }

void Module::OnUserKick (  userrec *  source,
userrec *  user,
chanrec *  chan,
std::string  reason
)  [virtual]
 

Called whenever a user is kicked.

If this method is called, the kick is already underway and cannot be prevented, so to prevent a kick, please use Module::OnUserPreKick instead of this method.

Parameters:
source The user issuing the kick
user The user being kicked
chan The channel the user is being kicked from
reason The kick reason

Definition at line 260 of file modules.cpp.

00260 { };

void Module::OnUserMessage (  userrec *  user,
void *  dest,
int  target_type,
std::string  text
)  [virtual]
 

Called after any PRIVMSG sent from a user.

The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL.

Parameters:
user The user sending the message
dest The target of the message
target_type The type of target (TYPE_USER or TYPE_CHANNEL)
text the text being sent by the user

Definition at line 281 of file modules.cpp.

00281 { };

void Module::OnUserNotice (  userrec *  user,
void *  dest,
int  target_type,
std::string  text
)  [virtual]
 

Called after any NOTICE sent from a user.

The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec* if target_type is TYPE_CHANNEL.

Parameters:
user The user sending the message
dest The target of the message
target_type The type of target (TYPE_USER or TYPE_CHANNEL)
text the text being sent by the user

Definition at line 282 of file modules.cpp.

00282 { };

void Module::OnUserPart (  userrec *  user,
chanrec *  channel
)  [virtual]
 

Called when a user parts a channel.

The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel

Parameters:
user The user who is parting
channel The channel being parted

Definition at line 234 of file modules.cpp.

00234 { }

void Module::OnUserPostNick (  userrec *  user,
std::string  oldnick
)  [virtual]
 

Called after any nickchange, local or remote.

This can be used to track users after nickchanges have been applied. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). Because this method is called after the nickchange is taken place, no return values are possible to indicate forbidding of the nick change. Use OnUserPreNick for this.

Parameters:
user The user changing their nick
oldnick The old nickname of the user before the nickchange

Definition at line 248 of file modules.cpp.

00248 { };

int Module::OnUserPreInvite (  userrec *  source,
userrec *  dest,
chanrec *  channel
)  [virtual]
 

Called whenever a user is about to invite another user into a channel, before any processing is done.

Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.

Parameters:
source The user who is issuing the INVITE
dest The user being invited
channel The channel the user is being invited to
Returns:
1 to deny the invite, 0 to allow

Definition at line 244 of file modules.cpp.

00244 { return 0; };

int Module::OnUserPreJoin (  userrec *  user,
chanrec *  chan,
const char *  cname
)  [virtual]
 

Called whenever a user is about to join a channel, before any processing is done.

Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.

IMPORTANT NOTE!

If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of processing on the actual channel record at this point, however the channel NAME will still be passed in char* cname, so that you could for example implement a channel blacklist or whitelist, etc.

Parameters:
user The user joining the channel
cname The channel name being joined
Returns:
1 To prevent the join, 0 to allow it.

Definition at line 237 of file modules.cpp.

00237 { return 0; }

int Module::OnUserPreKick (  userrec *  source,
userrec *  user,
chanrec *  chan,
std::string  reason
)  [virtual]
 

Called whenever a user is about to be kicked.

Returning a value of 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc.

Parameters:
source The user issuing the kick
user The user being kicked
chan The channel the user is being kicked from
reason The kick reason
Returns:
1 to prevent the kick, 0 to allow it

Definition at line 259 of file modules.cpp.

00259 { return 0; };

int Module::OnUserPreMessage (  userrec *  user,
void *  dest,
int  target_type,
std::string &  text
)  [virtual]
 

Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.

Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent.

Parameters:
user The user sending the message
dest The target of the message (chanrec* or userrec*)
target_type The type of target (TYPE_USER or TYPE_CHANNEL)
text Changeable text being sent by the user
Returns:
1 to deny the NOTICE, 0 to allow it

Definition at line 245 of file modules.cpp.

00245 { return 0; };

int Module::OnUserPreNick (  userrec *  user,
std::string  newnick
)  [virtual]
 

Called before any nickchange, local or remote.

This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output.

Parameters:
user The username changing their nick
newnick Their new nickname
Returns:
1 to deny the change, 0 to allow

Definition at line 247 of file modules.cpp.

00247 { return 0; };

int Module::OnUserPreNotice (  userrec *  user,
void *  dest,
int  target_type,
std::string &  text
)  [virtual]
 

Called whenever a user is about to NOTICE A user or a channel, before any processing is done.

Returning any nonzero value from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter or redirect messages. target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user, you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details of where the message is destined to be sent. You may alter the message text as you wish before relinquishing control to the next module in the chain, and if no other modules block the text this altered form of the text will be sent out to the user and possibly to other servers.

Parameters:
user The user sending the message
dest The target of the message (chanrec* or userrec*)
target_type The type of target (TYPE_USER or TYPE_CHANNEL)
text Changeable text being sent by the user
Returns:
1 to deny the NOTICE, 0 to allow it

Definition at line 246 of file modules.cpp.

00246 { return 0; };

void Module::OnUserQuit (  userrec *  user,
std::string  message
)  [virtual]
 

Called when a user quits.

The details of the exiting user are available to you in the parameter userrec *user This event is only called when the user is fully registered when they quit. To catch raw disconnections, use the OnUserDisconnect method.

Parameters:
user The user who is quitting
message The user's quit message

Definition at line 231 of file modules.cpp.

00231 { }

void Module::OnUserRegister (  userrec *  user  )  [virtual]
 

Called whenever a user is about to register their connection (e.g.

before the user is sent the MOTD etc). Modules can use this method if they are performing a function which must be done before the actual connection is completed (e.g. ident lookups, dnsbl lookups, etc). Note that you should NOT delete the user record here by causing a disconnection! Use OnUserConnect for that instead.

Parameters:
user The user registering

Definition at line 258 of file modules.cpp.

00258 { };

void Module::OnWallops (  userrec *  user,
std::string  text
)  [virtual]
 

Called after every WALLOPS command.

Parameters:
user The user sending the WALLOPS
text The content of the WALLOPS message

Definition at line 294 of file modules.cpp.

00294 { };

void Module::OnWhois (  userrec *  source,
userrec *  dest
)  [virtual]
 

Called whenever a /WHOIS is performed on a local user.

The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.

Parameters:
source The user issuing the WHOIS command
dest The user who is being WHOISed

Definition at line 243 of file modules.cpp.

00243 { };

void Module::ProtoSendMetaData (  void *  opaque,
int  target_type,
void *  target,
std::string  extname,
std::string  extdata
)  [virtual]
 

Implemented by modules which provide the ability to link servers.

These modules will implement this method, which allows metadata (extra data added to user and channel records using class Extensible, Extensible::Extend, etc) to be sent to other servers on a netburst and decoded at the other end by the same module on a different server.

More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of how to use this function.

Parameters:
opaque An opaque pointer set by the protocol module, should not be modified!
target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
target The chanrec* or userrec* that metadata should be sent for
extname The extension name to send metadata for
extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData

Definition at line 293 of file modules.cpp.

00293 { };

void Module::ProtoSendMode (  void *  opaque,
int  target_type,
void *  target,
std::string  modeline
)  [virtual]
 

Implemented by modules which provide the ability to link servers.

These modules will implement this method, which allows transparent sending of servermodes down the network link as a broadcast, without a module calling it having to know the format of the MODE command before the actual mode string.

More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples of how to use this function.

Parameters:
opaque An opaque pointer set by the protocol module, should not be modified!
target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
target The chanrec* or userrec* that modes should be sent for
modeline The modes and parameters to be sent

Definition at line 289 of file modules.cpp.

00289 { };

The documentation for this class was generated from the following files:
Generated on Wed Dec 14 15:55:50 2005 for InspIRCd by  doxygen 1.4.4-20050815