InspIRCd  2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations
Public Member Functions | List of all members
CommandModule< Cmd > Class Template Reference
Inheritance diagram for CommandModule< Cmd >:
Module classbase usecountbase

Public Member Functions

void init ()
Version GetVersion ()
- Public Member Functions inherited from Module
 Module ()
virtual CullResult cull ()
virtual ~Module ()
virtual void Prioritize ()
virtual void OnUserConnect (LocalUser *user)
virtual void OnUserQuit (User *user, const std::string &message, const std::string &oper_message)
virtual void OnUserDisconnect (LocalUser *user)
virtual ModResult OnChannelPreDelete (Channel *chan)
virtual void OnChannelDelete (Channel *chan)
virtual void OnUserJoin (Membership *memb, bool sync, bool created, CUList &except_list)
virtual void OnPostJoin (Membership *memb)
virtual void OnUserPart (Membership *memb, std::string &partmessage, CUList &except_list)
virtual void OnPreRehash (User *user, const std::string &parameter)
virtual void OnModuleRehash (User *user, const std::string &parameter)
virtual void OnRehash (User *user)
virtual ModResult OnSendSnotice (char &snomask, std::string &type, const std::string &message)
virtual ModResult OnUserPreJoin (User *user, Channel *chan, const char *cname, std::string &privs, const std::string &keygiven)
virtual ModResult OnUserPreKick (User *source, Membership *memb, const std::string &reason)
virtual void OnUserKick (User *source, Membership *memb, const std::string &reason, CUList &except_list)
virtual void OnOper (User *user, const std::string &opertype)
virtual void OnPostOper (User *user, const std::string &opername, const std::string &opertype)
virtual void OnInfo (User *user)
virtual void OnWhois (User *source, User *dest)
virtual ModResult OnUserPreInvite (User *source, User *dest, Channel *channel, time_t timeout)
virtual void OnUserInvite (User *source, User *dest, Channel *channel, time_t timeout)
virtual ModResult OnUserPreMessage (User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list)
virtual ModResult OnUserPreNotice (User *user, void *dest, int target_type, std::string &text, char status, CUList &exempt_list)
virtual void OnBuildNeighborList (User *source, UserChanList &include_c, std::map< User *, bool > &exceptions)
virtual ModResult OnUserPreNick (User *user, const std::string &newnick)
virtual void OnUserMessage (User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
virtual void OnUserNotice (User *user, void *dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
virtual void OnText (User *user, void *dest, int target_type, const std::string &text, char status, CUList &exempt_list)
virtual void OnMode (User *user, void *dest, int target_type, const std::vector< std::string > &text, const std::vector< TranslateType > &translate)
virtual void OnGetServerDescription (const std::string &servername, std::string &description)
virtual void OnSyncUser (User *user, Module *proto, void *opaque)
virtual void OnSyncChannel (Channel *chan, Module *proto, void *opaque)
virtual void OnSyncNetwork (Module *proto, void *opaque)
virtual void OnDecodeMetaData (Extensible *target, const std::string &extname, const std::string &extdata)
virtual void ProtoSendMode (void *opaque, TargetTypeFlags target_type, void *target, const std::vector< std::string > &modeline, const std::vector< TranslateType > &translate)
virtual void ProtoSendMetaData (void *opaque, Extensible *target, const std::string &extname, const std::string &extdata)
virtual void OnWallops (User *user, const std::string &text)
virtual void OnChangeHost (User *user, const std::string &newhost)
virtual void OnChangeName (User *user, const std::string &gecos)
virtual void OnChangeIdent (User *user, const std::string &ident)
virtual void OnAddLine (User *source, XLine *line)
virtual void OnDelLine (User *source, XLine *line)
virtual void OnExpireLine (XLine *line)
virtual void OnCleanup (int target_type, void *item)
virtual void OnUserPostNick (User *user, const std::string &oldnick)
virtual ModResult OnPreMode (User *source, User *dest, Channel *channel, const std::vector< std::string > &parameters)
virtual void On005Numeric (std::string &output)
virtual ModResult OnKill (User *source, User *dest, const std::string &reason)
virtual void OnRemoteKill (User *source, User *dest, const std::string &reason, const std::string &operreason)
virtual void OnLoadModule (Module *mod)
virtual void OnUnloadModule (Module *mod)
virtual void OnBackgroundTimer (time_t curtime)
virtual ModResult OnPreCommand (std::string &command, std::vector< std::string > &parameters, LocalUser *user, bool validated, const std::string &original_line)
virtual void OnPostCommand (const std::string &command, const std::vector< std::string > &parameters, LocalUser *user, CmdResult result, const std::string &original_line)
virtual void OnUserInit (LocalUser *user)
virtual ModResult OnCheckReady (LocalUser *user)
virtual ModResult OnUserRegister (LocalUser *user)
virtual ModResult OnCheckInvite (User *user, Channel *chan)
virtual ModResult OnRawMode (User *user, Channel *chan, const char mode, const std::string &param, bool adding, int pcnt)
virtual ModResult OnCheckKey (User *user, Channel *chan, const std::string &keygiven)
virtual ModResult OnCheckLimit (User *user, Channel *chan)
virtual ModResult OnCheckChannelBan (User *user, Channel *chan)
virtual ModResult OnCheckBan (User *user, Channel *chan, const std::string &mask)
virtual ModResult OnExtBanCheck (User *user, Channel *chan, char type)
virtual ModResult OnStats (char symbol, User *user, string_list &results)
virtual ModResult OnChangeLocalUserHost (LocalUser *user, const std::string &newhost)
virtual ModResult OnChangeLocalUserGECOS (LocalUser *user, const std::string &newhost)
virtual ModResult OnPreTopicChange (User *user, Channel *chan, const std::string &topic)
virtual void OnPostTopicChange (User *user, Channel *chan, const std::string &topic)
virtual void OnEvent (Event &event)
virtual void OnRequest (Request &request)
virtual ModResult OnPassCompare (Extensible *ex, const std::string &password, const std::string &input, const std::string &hashtype)
virtual void OnGlobalOper (User *user)
virtual void OnPostConnect (User *user)
virtual ModResult OnAddBan (User *source, Channel *channel, const std::string &banmask)
virtual ModResult OnDelBan (User *source, Channel *channel, const std::string &banmask)
virtual void OnHookIO (StreamSocket *user, ListenSocket *via)
virtual ModResult OnAcceptConnection (int fd, ListenSocket *sock, irc::sockets::sockaddrs *client, irc::sockets::sockaddrs *server)
virtual void OnStreamSocketAccept (StreamSocket *sock, irc::sockets::sockaddrs *client, irc::sockets::sockaddrs *server)
virtual int OnStreamSocketWrite (StreamSocket *sock, std::string &sendq)
virtual void OnStreamSocketClose (StreamSocket *sock)
virtual void OnStreamSocketConnect (StreamSocket *sock)
virtual int OnStreamSocketRead (StreamSocket *sock, std::string &recvq)
virtual ModResult OnSetAway (User *user, const std::string &awaymsg)
virtual ModResult OnWhoisLine (User *user, User *dest, int &numeric, std::string &text)
virtual void OnGarbageCollect ()
virtual ModResult OnSetConnectClass (LocalUser *user, ConnectClass *myclass)
virtual void OnRunTestSuite ()
virtual void OnNamesListItem (User *issuer, Membership *item, std::string &prefixes, std::string &nick)
virtual ModResult OnNumeric (User *user, unsigned int numeric, const std::string &text)
virtual void OnSendWhoLine (User *source, const std::vector< std::string > &params, User *user, std::string &line)
virtual void OnSetUserIP (LocalUser *user)
- Public Member Functions inherited from usecountbase
unsigned int GetUseCount () const
void refcount_inc () const
bool refcount_dec () const

Additional Inherited Members

- Public Attributes inherited from Module
std::string ModuleSourceFile
bool dying

Member Function Documentation

template<class Cmd >
Version CommandModule< Cmd >::GetVersion ( )

Returns the version number of a Module. The method should return a Version object with its version information assigned via Version::Version

Implements Module.

template<class Cmd >
void CommandModule< Cmd >::init ( )

Module setup

ModuleExceptionThrowing this class, or any class derived from ModuleException, causes loading of the module to abort.

Reimplemented from Module.

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