InspIRCd  4.0
Public Member Functions | List of all members
ClientProtocol::EventProvider Class Reference

#include <clientprotocol.h>

Inheritance diagram for ClientProtocol::EventProvider:
Events::ModuleEventProvider ServiceProvider dynamic_reference_base::CaptureHook Cullable insp::uncopiable

Public Member Functions

 EventProvider (Module *Mod, const std::string &eventname)
 
- Public Member Functions inherited from Events::ModuleEventProvider
 ModuleEventProvider (Module *mod, const std::string &eventid)
 
const ModuleGetModule () const
 
const SubscriberListGetSubscribers () const
 
void Subscribe (ModuleEventListener *subscriber)
 
void Unsubscribe (ModuleEventListener *subscriber)
 
template<typename Class , typename... FunArgs, typename... FwdArgs>
void Call (void(Class::*function)(FunArgs...), FwdArgs &&... args) const
 
template<typename Class , typename... FunArgs, typename... FwdArgs>
ModResult FirstResult (ModResult(Class::*function)(FunArgs...), FwdArgs &&... args) const
 
- Public Member Functions inherited from ServiceProvider
 ServiceProvider (Module *Creator, const std::string &Name, ServiceType Type)
 
const char * GetTypeString () const
 
virtual void RegisterService ()
 
void DisableAutoRegister ()
 
- Public Member Functions inherited from Cullable
virtual ~Cullable ()
 
virtual Result Cull ()
 

Additional Inherited Members

- Public Types inherited from Events::ModuleEventProvider
typedef insp::flat_multiset< ModuleEventListener *, Comp, ElementCompSubscriberList
 
- Public Attributes inherited from ServiceProvider
ModuleRef creator
 
const std::string name
 
const ServiceType service
 
- Protected Member Functions inherited from Cullable
 Cullable ()
 

Detailed Description

Event provider for client protocol events. Protocol event hooks can be attached to the instances of these providers. The core has event providers for most common IRC events defined in RFC1459.

Constructor & Destructor Documentation

◆ EventProvider()

ClientProtocol::EventProvider::EventProvider ( Module Mod,
const std::string &  eventname 
)
inline

Constructor.

Parameters
ModModule that owns the event provider.
eventnameName of the event this provider is for, e.g. "JOIN", "PART", "NUMERIC". Should match command name if applicable.

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