---

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:

[legend]Collaboration diagram for Module:

[legend]List of all members.

Public Member Functions
	Module ()
	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)
	Called when a user quits.
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	Module::OnPacketTransmit (char *p)
	Called before a packet is transmitted across the irc network between two irc servers.
virtual void	Module::OnPacketReceive (char *p)
	Called after a packet is received from another irc server.
virtual void	OnRehash ()
	Called on rehash.
virtual void	OnServerRaw (std::string &raw, bool inbound)
	Called when a raw command is transmitted or received.
virtual bool	OnExtendedMode (userrec *user, chanrec *chan, char modechar, int type, bool mode_on, string_list &params)
	Called whenever an extended mode is to be processed.

---

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 71 of file modules.h.

---

Constructor & Destructor Documentation

Module::Module (    )

Default constructor creates a module class. Definition at line 88 of file modules.cpp. { }

Module::~Module (    )  [virtual]

Default destructor destroys a module class. Definition at line 89 of file modules.cpp. { }

---

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 99 of file modules.cpp. { return Version(1,0,0,0); }

virtual void Module::Module::OnPacketReceive (  char *    p )  [virtual]

Called after a packet is received from another irc server. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.

virtual void Module::Module::OnPacketTransmit (  char *    p )  [virtual]

Called before a packet is transmitted across the irc network between two irc servers. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.

bool Module::OnExtendedMode (  userrec *    user, chanrec *    chan, 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 not a channel mode, chanrec* chan is null, and should not be read from or written to. Definition at line 98 of file modules.cpp. { }

void Module::OnRehash (    )  [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. Definition at line 96 of file modules.cpp. { }

void Module::OnServerRaw (  std::string &    raw, bool    inbound )  [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. Definition at line 97 of file modules.cpp. { }

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 Definition at line 90 of file modules.cpp. { }

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 Definition at line 92 of file modules.cpp. { }

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 Definition at line 93 of file modules.cpp. { }

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

Called when a user quits. The details of the exiting user are available to you in the parameter userrec *user Definition at line 91 of file modules.cpp. { }

---

The documentation for this class was generated from the following files:

• modules.h
• modules.cpp

---