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

InspIRCd Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AccountData
AChannel_MChannel mode +M - unidentified users cannot message channel
AChannel_RChannel mode +R - unidentified users cannot join
AliasAn alias definition
AssociateChanUsed to associate an SQL query with a channel
AssociateUserUsed to associate an SQL query with a user
AuditoriumMode
AUser_RUser mode +R - unidentified users cannot message
BanCacheHit
BanCacheManager
BanExceptionHandles +e channel mode
BanItemA subclass of HostItem designed to hold channel bans (+b)
BannedFileList
BanRedirect
BanRedirectEntry
BlockCapsHandles the +P channel mode
BlockColorHandles the +c channel mode
BlockedMessageHolds a blocked message's details
BoolSetBoolSet is a utility class designed to hold eight bools in a bitmask
BotModeHandles user mode +B
BufferedSocketBufferedSocket is an extendable socket class which modules can use for TCP socket support
BufferedSocketAttachCertRequestUsed to represent a request to attach a cert to an BufferedSocket
BufferedSocketHookRequestUsed to hook a transport provider to an BufferedSocket
BufferedSocketHSCompleteRequestUsed to check if a handshake is complete on an BufferedSocket yet
BufferedSocketNameRequest
BufferedSocketUnhookRequestUsed to unhook a transport provider from an BufferedSocket
CachedQueryCached item stored in the query cache
CacheRefreshTimerCreate a timer which recurs every second, we inherit from Timer
CacheTimer
caller< HandlerType >
caller0< ReturnType >
caller1< ReturnType, Param1 >
caller2< ReturnType, Param1, Param2 >
caller3< ReturnType, Param1, Param2, Param3 >
caller4< ReturnType, Param1, Param2, Param3, Param4 >
caller5< ReturnType, Param1, Param2, Param3, Param4, Param5 >
caller6< ReturnType, Param1, Param2, Param3, Param4, Param5, Param6 >
caller7< ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7 >
caller8< ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8 >
callerid_data
cap_validation
CapData
CBanHolds a CBAN item
CBanFactoryAn XLineFactory specialized to generate cban pointers
CensorChannelHandles channel mode +G
CensorUserHandles usermode +G
CGIhostHolds a CGI site's details
CGIResolverResolver for CGI:IRC hostnames encoded in ident/GECOS
ChanFilterHandles channel mode +g
ChanFounderAbstraction of FounderProtectBase for channel mode +q
ChannelHolds all relevent information for a channel
Channel_MChannel mode +M - only allow privmsg and notice to channel from registered users
Channel_rChannel mode +r - mark a channel as identified
Channel_RChannel mode +R - registered users only
ChannelLogStream
ChannelManager
ChannelStripColorHandles channel mode +S
ChanProtectAbstraction of FounderProtectBase for channel mode +a
char_traits
classbaseThe base class for all inspircd classes
CloakUserHandles user mode +x
cmd_fingerprintHandle /FINGERPRINT
cmd_rconnectHandle /RCONNECT
cmd_reloadCommand handler class for the RELOAD command
cmd_rsquitHandle /RCONNECT
cmd_shun
cmd_sslinfoHandle /SSLINFO
cmd_validation
CommandA structure that defines a command
CommandAccept
CommandAdminHandle /ADMIN
CommandAlltime
CommandAuthenticate
CommandAwayHandle /AWAY
CommandCAPHandle /CAP
CommandCBanHandle /CBAN
CommandCheckHandle /CHECK
CommandChghostHandle /CHGHOST
CommandChgidentHandle /CHGIDENT
CommandChgnameHandle /CHGNAME
CommandClearcacheHandle /ADMIN
CommandClonesHandle /CHECK
CommandCloseHandle /CLOSE
CommandCommandsHandle /COMMANDS
CommandConnectHandle /CONNECT
CommandCycleHandle /CYCLE
CommandDalinfoHandle /DALINFO
CommandDccallow
CommandDevoiceHandle /DEVOICE
CommandDieHandle /DIE
CommandElineHandle /ELINE
CommandFilter
CommandFpartHandle /FPART
CommandGlineHandle /GLINE
CommandGloadmoduleHandle /GLOADMODULE
CommandGlobopsHandle /GLOBOPS
CommandGreloadmoduleHandle /GRELOADMODULE
CommandGunloadmoduleHandle /GUNLOADMODULE
CommandHelpopHandles /HELPOP
CommandInfoHandle /INFO
CommandInviteHandle /INVITE
CommandIsonHandle /ISON
CommandJoinHandle /JOIN
CommandJumpserverHandle /SAPART
CommandKickHandle /KICK
CommandKillHandle /KILL
CommandKlineHandle /KLINE
CommandKnockHandles the /KNOCK command
CommandLinksHandle /LINKS
CommandListHandle /LIST
CommandLoadmoduleHandle /LOADMODULE
CommandLockservAdds numerics 988 <nick> <servername> :Closed for new connections 989 <nick> <servername> :Open for new connections
CommandLusersHandle /LUSERS
CommandMapHandle /MAP
CommandMkpasswd
CommandModeHandle /MODE
CommandModulesHandle /MODULES
CommandMotdHandle /MOTD
CommandNamesHandle /NAMES
CommandNickHandle /NICK
CommandNicklockHandle /NICKLOCK
CommandNickunlockHandle /NICKUNLOCK
CommandNoticeHandle /NOTICE
CommandOperHandle /OPER
CommandOpermotdHandle /OPERMOTD
CommandParserThis class handles command management and parsing
CommandPartHandle /PART
CommandPassHandle /PASS
CommandPingHandle /PING
CommandPongHandle /PONG
CommandPrivmsgHandle /PRIVMSG
CommandQlineHandle /QLINE
CommandQuitHandle /QUIT
CommandRandquoteHandle /RANDQUOTE
CommandRehashHandle /REHASH
CommandReloadmoduleHandle /RELOADMODULE
CommandRemoveHandle /REMOVE
CommandRestartHandle /RESTART
CommandRLineHandle /RLINE Syntax is same as other lines: RLINE regex_goes_here 1d :reason
CommandRulesHandle /RULES
CommandSajoinHandle /SAJOIN
CommandSamodeHandle /SAMODE
CommandSanickHandle /SANICK
CommandSapartHandle /SAPART
CommandSaquitHandle /SAQUIT
CommandServerHandle /SERVER
CommandSethostHandle /SETHOST
CommandSetidentHandle /SETIDENT
CommandSetidleHandle /SETIDLE
CommandSetname
CommandSilence
CommandSquitHandle /SQUIT
CommandStartTLS
CommandStatsHandle /STATS
CommandSvsholdHandle /SVSHold
CommandSVSSilence
CommandSVSWatch
CommandSwhoisHandle /SWHOIS
CommandTaxonomyHandle /TAXONOMY
CommandTbanHandle /TBAN
CommandTimeHandle /TIME
CommandTitleHandle /TITLE
CommandTlineHandle /TLINE
CommandTopicHandle /TOPIC
CommandTraceHandle /TRACE
CommandUninviteHandle /UNINVITE
CommandUnloadmoduleHandle /UNLOADMODULE
CommandUnlockserv
CommandUserHandle /USER
CommandUserhostHandle /USERHOST
CommandUseripHandle /USERIP
CommandVersionHandle /VERSION
CommandVhostHandle /VHOST
CommandWallopsHandle /WALLOPS
CommandWatchHandle /WATCH
CommandWebirc
CommandWhoHandle /WHO
CommandWhoisHandle /WHOIS
CommandWhowasHandle /WHOWAS
CommandZlineHandle /ZLINE
irc::commasepstreamA derived form of sepstream, which seperates on commas
ConfigReaderAllows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file
ConfigReaderThread
ConnectClassHolds information relevent to <connect allow> and <connect deny> tags in the config file
connectionConnection is the base class of User, and holds basic user properties
CoreExceptionThis class can be used on its own to represent an exception, or derived to represent a module-specific exception
CountedBuffer
CullListUsed by the core to create lists of users prior to actually quitting (and deleting the objects) all at once
DCCAllow
DelayJoinMode
Deprecated
DLLFactory< ReturnType >This is the highest-level class of the DLLFactory system used to load InspIRCd modules and commands
DLLManagerAble to load a module file by filename, and locate its init_module symbol
DNSDNS is a singleton class used by the core to dispatch dns requests to the dns server, and route incoming dns replies back to Resolver objects, based upon the request ID
DNSBLConfEntry
DNSBLResolverResolver for CGI:IRC hostnames encoded in ident/GECOS
DNSHeaderRepresents a dns request/reply header, and its payload as opaque data
DNSRequest
DNSResultResult status, used internally
irc::dynamicbitmaskThe irc::dynamicbitmask class is used to maintain a bitmap of boolean values, which can grow to any reasonable size no matter how many bitfields are in it
ELineELine class
ELineFactoryAn XLineFactory specialized to generate ELine* pointers
EventUnicast message directed at all modules
EventHandlerThis class is a basic I/O handler class
exception
ExtensibleClass Extensible is the parent class of many classes such as User and Channel
FileLogStream
FileReaderCaches a text file into memory and can be used to retrieve lines from it
FileWriterThis class implements a nonblocking writer
FilterBase
FilterResult
FindSymbolException
floodsettingsHolds flood settings and state for mode +f
FounderProtectBaseHandles basic operation of +qa channel modes
GetAssocChanGet the channel associated with an SQL query ID
GetAssocUserGet the user associated with an SQL query ID
GLineGLine class
GLineFactoryAn XLineFactory specialized to generate GLine* pointers
HandlerBase0< ReturnType >
HandlerBase1< ReturnType, Param1 >
HandlerBase2< ReturnType, Param1, Param2 >
HandlerBase3< ReturnType, Param1, Param2, Param3 >
HandlerBase4< ReturnType, Param1, Param2, Param3, Param4 >
HandlerBase5< ReturnType, Param1, Param2, Param3, Param4, Param5 >
HandlerBase6< ReturnType, Param1, Param2, Param3, Param4, Param5, Param6 >
HandlerBase7< ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7 >
HandlerBase8< ReturnType, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8 >
HandshakeTimer
hash< irc::string >Hashing function to hash irc::string
hash< std::string >
HashHexRequestSend this class to the hashing module to change the hex sequence to use for generating the returned value
HashKeyRequestSend this class to hashing module to change the IVs (keys) to use for hashing
HashNameRequestSend this class to the hashing module to query for its name
HashRequestHashRequest is the base class used to send Hash requests to hashing.so
HashResetRequestSend this class to the hashing module to reset the Hash module to a known state
HashSumRequestSend this class to the hashing module to HashSUM a std::string
HelpopHandles user mode +h
HideChansHandles user mode +I
HideOperHandles user mode +H
HostHolds information on a host set by m_hostchange
HostItemHolds an entry for a ban list, exemption list, or invite list
HTTPACL
HTTPDocumentYou must return a HTTPDocument to the httpd module by using the Request class
HTTPHeadersA modifyable list of HTTP header fields
HTTPRequestThis class represents a HTTP request
HttpServerSocketA socket used for HTTP transport
IdentRequestSocket
InitialConfigHolds a core configuration item and its callbacks
InspIRCdThe main class of the irc server
InvisibleDeOper
InvisibleMode
InviteExceptionHandles channel mode +I
irc::irc_char_traitsThe irc_char_traits class is used for RFC-style comparison of strings
ISHRequestUsed to represent a request to a transport provider module
issl_sessionRepresents an SSL user's extra data
izip_sessionRepresents an zipped connections extra data
JoinFloodHandles channel mode +j
joinfloodsettingsHolds settings and state associated with channel mode +j
JsonException
KickRejoinHandles channel mode +J
KLineKLine class
KLineFactoryAn XLineFactory specialized to generate KLine* pointers
KnockHandles channel mode +K
LinkMight as well be a struct, but this is C++ and we don't believe in structs (!)
ListDataHolds a users m_safelist state
ListenSocketThis class handles incoming connections on client ports
ListItemAn item in a listmode's list
ListLimitThe number of items a listmode's list may contain
ListModeBaseThe base class for list modes, should be inherited
ListModeRequestA request used to check if a user is on a channel's list or not
LoadModuleException
LogManager
LogStreamLogStream base class
MD5ContextAn MD5 context, used by m_opermd5
ModeChannelBanChannel mode +b
ModeChannelHalfOpChannel mode +h
ModeChannelInviteOnlyChannel mode +i
ModeChannelKeyChannel mode +k
ModeChannelLimitChannel mode +l
ModeChannelModeratedChannel mode +m
ModeChannelNoExternalChannel mode +n
ModeChannelOpChannel mode +o
ModeChannelPrivateChannel mode +p
ModeChannelSecretChannel mode +s
ModeChannelTopicOpsChannel mode +t
ModeChannelVoiceChannel mode +v
ModeHandlerEach mode is implemented by ONE ModeHandler class
ModeParserThe mode parser handles routing of modes and handling of mode strings
irc::modestackerIrc::modestacker stacks mode sequences into a list
ModeUserInvisibleUser mode +i
ModeUserOperatorUser mode +o
ModeUserServerNoticeUser mode +s
ModeUserServerNoticeMaskUser mode +n
ModeUserWallopsUser mode +w
ModeWatcherCan be used to alter the behaviour of a mode implemented by the core or by another module
ModuleBase class for all InspIRCd modules This class is the base class for InspIRCd modules
ModuleAbbreviation
ModuleAlias
Modulealltime
ModuleAntiBear
ModuleAntiBottler
ModuleAuditorium
ModuleBanException
ModuleBanRedirect
ModuleBlockAmsg
ModuleBlockCAPS
ModuleBlockColour
ModuleBotMode
ModuleCallerID
ModuleCAP
ModuleCBan
ModuleCensor
ModuleCgiIRC
ModuleChanCreate
ModuleChanFilter
ModuleChanLog
ModuleChanProtect
ModuleCheck
ModuleChgHost
ModuleChgIdent
ModuleChgName
ModuleCloaking
ModuleClones
ModuleClose
ModuleConnFlood
ModuleConnJoin
ModuleCustomTitle
ModuleCycle
ModuleDCCAllow
ModuleDeaf
ModuleDelayJoin
ModuleDenyChannels
ModuleDeVoice
ModuleDNSBL
ModuleException
ModuleFilter
ModuleFilterPCRE
ModuleFoobar
ModuleGeoIP
ModuleGlobalLoad
ModuleGlobops
ModuleHelpop
ModuleHideChans
ModuleHideOper
ModuleHostChange
ModuleHTTPAccessList
ModuleHttpServer
ModuleHttpStats
ModuleIdent
ModuleInvisible
ModuleInviteException
ModuleJoinFlood
ModuleJumpServer
ModuleKickNoRejoin
ModuleKnock
ModuleLDAPAuth
ModuleLockserv
ModuleManagerModuleManager takes care of all things module-related in the core
ModuleMapHide
ModuleMD5
ModuleMessageBase class of Request and Event This class is used to represent a basic data structure which is passed between modules for safe inter-module communications
ModuleModesOnConnect
ModuleModesOnOper
ModuleMsgFlood
ModuleMsSQL
ModuleNamesX
ModuleNickBan
ModuleNickFlood
ModuleNickLock
ModuleNoCTCP
ModuleNoInvite
ModuleNoKicks
ModuleNoNickChange
ModuleNoNotice
ModuleOperChans
ModuleOperFlood
ModuleOperHash
ModuleOperjoin
ModuleOperLevels
ModuleOperLog
ModuleOpermotd
ModuleOperSSLCert
ModuleOverride
ModulePartMsgBan
ModulePermanentChannels
ModulePgSQL
ModulePrivacyMode
ModuleProxy
ModuleQuietBan
ModuleQuitBan
ModuleRandQuote
ModuleRedirect
ModuleRegOnlyCreate
ModuleRemove
ModuleRestrictBanned
ModuleRestrictChans
ModuleRestrictMsg
ModuleRIPEMD160
ModuleRLine
ModuleRpcJson
ModuleRPCTest
ModuleSafeList
ModuleSajoin
ModuleSaMode
ModuleSanick
ModuleSapart
ModuleSaquit
ModuleSASL
ModuleSecureList
ModuleSeeNicks
ModuleServicesDreamnforge-like services support
ModuleServicesAccount
ModuleServProtectMode
ModuleSetHost
ModuleSetIdent
ModuleSetIdle
ModuleSetName
ModuleSHA256
ModuleShowwhois
ModuleShun
ModuleSilence
ModuleSpanningTreeThis is the main class for the spanningtree module
ModuleSpy
ModuleSQLMySQL module
ModuleSQLAuth
ModuleSQLite3
ModuleSQLLog
ModuleSQLOper
ModuleSQLutils
ModuleSSLDummy
ModuleSSLGnuTLS
ModuleSSLInfo
ModuleSSLModes
ModuleSSLOpenSSL
ModuleStripColor
ModuleSVSHold
ModuleSWhois
ModuleTaxonomy
ModuleTestClient
ModuleTestCommand
ModuleTimedBans
ModuleTLine
ModuleUHNames
ModuleUninvite
ModuleUserIP
ModuleVHost
ModuleWaitPong
Modulewatch
ModuleXLineDB
ModuleXMLSocket
ModuleZLib
MsgFloodHandles channel mode +f
MsSQLResult
MultiConfigHolds a core configuration item and its callbacks where there may be more than one item
MySQLresultRepresents a mysql result set
NickFloodHandles channel mode +j
nickfloodsettingsHolds settings and state associated with channel mode +F
NoCTCP
NoInvite
NoKicks
NoNicks
NoNotice
NotifierUsed by m_mysql to notify one thread when the other has a result
OperChans
operclass_data
PCREFilter
PermChannelHandles the +P channel mode
PgSQLresultPgSQLresult is a subclass of the mostly-pure-virtual class SQLresult
irc::portparserThe portparser class seperates out a port range into integers
PrivacyModeHandles user mode +c
ProtocolInterface
ProtoServer
ProxySocket
QLineQLine class
QLineFactoryAn XLineFactory specialized to generate QLine* pointers
QueryInfo
QueryQueueQueryQueue, a queue of queries waiting to be executed
QuietOper
ReconnectTimer
RedirectHandle channel mode +L
RemoveBaseBase class for /FPART and /REMOVE
RequestUnicast message directed at a given module
RequestTimeout
ResolverHigh-level abstraction for resolving DNS entries
ResourceRecordRepresents a dns resource record (rr)
ResultNotifier
RLine
RLineFactoryAn XLineFactory specialized to generate RLine* pointers
RPCRequest
RPCValue
SaslAuthenticatorTracks SASL authentication state like charybdis does
SecurityIPResolverHandle resolving of server IPs for the cache
SeeWhoisHandle user mode +W
irc::sepstreamIrc::sepstream allows for splitting token seperated lists
ServerConfigThis class holds the bulk of the runtime configuration for the ircd
ServerLimits
ServernameResolverThis class is used to resolve server hostnames during /connect and autoconnect
serverstatsThis class contains various STATS counters It is used by the InspIRCd class, which internally has an instance of it
ServProtectModeHandles user mode +k
SHA256ContextAn sha 256 context, used by m_opersha256
Shun
ShunFactoryAn XLineFactory specialized to generate shun pointers
SimpleChannelModeHandlerA prebuilt mode handler which handles a simple channel mode, e.g
SimpleUserModeHandlerA prebuilt mode handler which handles a simple user mode, e.g
Snomask
SnomaskManagerSnomask manager handles routing of SNOMASK (usermode +n) messages to opers
SocketEngineProvides basic file-descriptor-based I/O support
SocketTimeoutUsed to time out socket connections
irc::spacesepstreamA derived form of sepstream, which seperates on spaces
SpanningTreeProtocolInterface
SpanningTreeUtilitiesContains helper functions and variables for this module, and keeps them out of the global namespace
SQLbadColNameAn exception thrown when a bad column or row name or id is requested
SQLConnSQLConn represents one SQL session
SQLConnectionRepresents a connection to a mysql database
SQLerrorSQLerror holds the error state of any SQLrequest or SQLresult
SQLexceptionThe base class of SQL exceptions
SQLfieldThis class contains a field's data plus a way to determine if the field is NULL or not without having to mess around with NULL pointers
SQLhostSQLHost represents a <database> config line and is useful for storing in a map and iterating on rehash to see which <database> tags was added/removed/unchanged
SQLite3Result
SQLquerySQLquery provides a way to represent a query string, and its parameters in a type-safe way
SQLrequestSQLrequest is sent to the SQL API to command it to run a query and return the result
SQLresolverUsed to resolve sql server hostnames
SQLresultSQLresult is a reply to a previous query
ssl_certSsl_cert is a class which abstracts SSL certificate and key information
SSLModeHandle channel mode +z
irc::StrHashCompThis class returns true if two strings match
irc::stringjoinerIrc::stringjoiner joins string lists into a string, using the given seperator string
SVSHoldHolds a SVSHold item
TestSuite
TestSuiteThread
ThreadDerive from this class to implement your own threaded sections of code
ThreadEngineHas the responsibility of initialising Thread derived classes
TimedBanHolds a timed ban
TimerTimer class for one-second resolution timers Timer provides a facility which allows module developers to create one-shot timers
TimerManagerThis class manages sets of Timers, and triggers them at their defined times
irc::tokenstreamIrc::tokenstream reads a string formatted as per RFC1459 and RFC2812
TreeServerEach server in the tree is represented by one class of type TreeServer
TreeSocketEvery SERVER connection inbound or outbound is represented by an object of type TreeSocket
UnAssociateUnassociate a user or class from an SQL query
UserHolds all information about a user This class stores all information about a user connected to the irc server
User_dUser mode +d - filter out channel messages and channel notices
User_g
User_rUser mode +r - mark a user as identified
User_RUser mode +R - only allow PRIVMSG and NOTICE from registered users
UserManager
UserResolverDerived from Resolver, and performs user forward/reverse lookups
UserStripColorHandles user mode +S
ValueContainer< T >ValueContainer is used to contain pointers to different core values such as the server name, maximum number of clients etc
ValueContainerBaseThe base class of the container 'ValueContainer' used internally by the core to hold core values
ValueItemHolds a config value, either string, integer or boolean
VersionHolds a module's Version information
VisDataVisibility data for a user
WhoWasGroupUsed to hold WHOWAS information
WhoWasMaintainTimer
XLineXLine is the base class for ban lines such as G lines and K lines
XLineFactoryXLineFactory is used to generate an XLine pointer, given just the pattern, timing information and type of line to create
XLineManagerXLineManager is a class used to manage glines, klines, elines, zlines and qlines, or any other line created by a module
ZLineZLine class
ZLineFactoryAn XLineFactory specialized to generate ZLine* pointers