The InspIRCd Project
Home | Developers | Wiki | Forums | Bug Tracker | SVN | Download
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ModuleTaxonomy Class Reference

Inheritance diagram for ModuleTaxonomy:

Inheritance graph
[legend]
Collaboration diagram for ModuleTaxonomy:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleTaxonomy (InspIRCd *Me)
void ProtoSendMetaData (void *opaque, TargetTypeFlags target_type, void *target, const std::string &extname, const std::string &extdata)
 Implemented by modules which provide the ability to link servers.
virtual ~ModuleTaxonomy ()
virtual Version GetVersion ()
 Returns the version number of a Module.

Private Attributes

CommandTaxonomy * newcommand
bool claimed

Detailed Description

Definition at line 55 of file m_taxonomy.cpp.

Constructor & Destructor Documentation

ModuleTaxonomy::ModuleTaxonomy (  InspIRCd *  Me  )  [inline]
 

Definition at line 60 of file m_taxonomy.cpp.

References InspIRCd::AddCommand(), ModuleManager::Attach(), claimed, I_ProtoSendMetaData, InspIRCd::Modules, newcommand, and Module::ServerInstance.

virtual ModuleTaxonomy::~ModuleTaxonomy (   )  [inline, virtual]
 

Definition at line 83 of file m_taxonomy.cpp.

Member Function Documentation

virtual Version ModuleTaxonomy::GetVersion (   )  [inline, virtual]
 

Returns the version number of a Module.

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

Reimplemented from Module.

Definition at line 87 of file m_taxonomy.cpp.

References API_VERSION, and VF_VENDOR.

void ModuleTaxonomy::ProtoSendMetaData (  void *  opaque,
TargetTypeFlags  target_type,
void *  target,
const std::string &  extname,
const std::string &  extdata
)  [inline, 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 Channel* or User* 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

Reimplemented from Module.

Definition at line 72 of file m_taxonomy.cpp.

References claimed, User::nick, TYPE_USER, and User::WriteServ().

Member Data Documentation

bool ModuleTaxonomy::claimed [private]
 

Definition at line 58 of file m_taxonomy.cpp.

Referenced by ModuleTaxonomy(), and ProtoSendMetaData().

CommandTaxonomy* ModuleTaxonomy::newcommand [private]
 

Definition at line 57 of file m_taxonomy.cpp.

Referenced by ModuleTaxonomy().

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