InspIRCd  4.0
Public Member Functions | Public Attributes | List of all members
ServiceProvider Class Reference

#include <base.h>

Inheritance diagram for ServiceProvider:
Cullable insp::uncopiable CommandBase DataProvider Events::ModuleEventProvider ExtensionItem IOHookProvider ModeHandler Command ClientProtocol::Serializer ClientProtocol::EventProvider ClientProtocol::MessageTagEvent SimpleExtItem< std::string > SimpleExtItem< ChanData > BoolExtItem IntExtItem SimpleExtItem< T, Del > ListModeBase ParamModeBase PrefixMode SimpleChannelMode SimpleUserMode

Public Member Functions

 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 ()
 

Public Attributes

ModuleRef creator
 
const std::string name
 
const ServiceType service
 

Additional Inherited Members

- Protected Member Functions inherited from Cullable
 Cullable ()
 

Detailed Description

A structure defining something that a module can provide

Member Function Documentation

◆ DisableAutoRegister()

void ServiceProvider::DisableAutoRegister ( )

If called, this ServiceProvider won't be registered automatically

◆ GetTypeString()

const char * ServiceProvider::GetTypeString ( ) const

Retrieves a string that represents the type of this service.

◆ RegisterService()

void ServiceProvider::RegisterService ( )
virtual

Register this service in the appropriate registrar

Reimplemented in ModeHandler, ExtensionItem, and Command.

Member Data Documentation

◆ creator

ModuleRef ServiceProvider::creator

Module that is providing this service

◆ name

const std::string ServiceProvider::name

Name of the service being provided

◆ service

const ServiceType ServiceProvider::service

Type of service (must match object type)


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