InspIRCd  3.0
Public Member Functions | List of all members
ClientProtocol::Messages::Numeric Class Reference

#include <clientprotocolmsg.h>

Inheritance diagram for ClientProtocol::Messages::Numeric:
ClientProtocol::Message ClientProtocol::MessageSource

Public Member Functions

 Numeric (const ::Numeric::Numeric &num, User *user)
 
 Numeric (const ::Numeric::Numeric &num, const std::string &target)
 
 Numeric (unsigned int num)
 
- Public Member Functions inherited from ClientProtocol::Message
 Message (const char *cmd, User *Sourceuser=NULL)
 
 Message (const char *cmd, const std::string &Sourcestr, User *Sourceuser=NULL)
 
const ParamList & GetParams () const
 
const TagMapGetTags () const
 
const char * GetCommand () const
 
void PushParam (const char *str)
 
void PushParam (const std::string &str)
 
void PushParamRef (const std::string &str)
 
void PushParamPlaceholder ()
 
void ReplaceParam (unsigned int index, const char *str)
 
void ReplaceParam (unsigned int index, const std::string &str)
 
void ReplaceParamRef (unsigned int index, const std::string &str)
 
void AddTag (const std::string &tagname, MessageTagProvider *tagprov, const std::string &val, void *tagdata=NULL)
 
void AddTags (const ClientProtocol::TagMap &newtags)
 
const SerializedMessage & GetSerialized (const SerializedInfo &serializeinfo) const
 
void ClearParams ()
 
void InvalidateCache ()
 
void CopyAll ()
 
void SetSideEffect (bool Sideeffect)
 
bool IsSideEffect () const
 
- Public Member Functions inherited from ClientProtocol::MessageSource
 MessageSource (User *Sourceuser=NULL)
 
 MessageSource (const std::string &Sourcestr, User *Sourceuser=NULL)
 
const std::string * GetSource () const
 
UserGetSourceUser () const
 
void SetSourceUser (User *Sourceuser)
 
void SetSource (const std::string &Sourcestr, User *Sourceuser=NULL)
 
void SetSource (const MessageSource &other)
 

Additional Inherited Members

- Public Types inherited from ClientProtocol::Message
typedef std::vector< ParamParamList
 
- Protected Member Functions inherited from ClientProtocol::Message
void SetCommand (const char *cmd)
 

Detailed Description

Numeric message. Doesn't have a fixed command name, it's always a 3 digit number padded with zeroes if necessary. The first parameter is the target of the numeric which is almost always the nick of the user the numeric will be sent to.

Constructor & Destructor Documentation

◆ Numeric() [1/3]

ClientProtocol::Messages::Numeric::Numeric ( const ::Numeric::Numeric num,
User user 
)
inline

Constructor, target is a User.

Parameters
numNumeric object to send. Must remain valid as long as this object is alive and must not be modified.
userUser to send the numeric to. May be unregistered, must remain valid as long as this object is alive.

◆ Numeric() [2/3]

ClientProtocol::Messages::Numeric::Numeric ( const ::Numeric::Numeric num,
const std::string &  target 
)
inline

Constructor, target is a string.

Parameters
numNumeric object to send. Must remain valid as long as this object is alive and must not be modified.
targetTarget string, must stay valid as long as this object is alive.

◆ Numeric() [3/3]

ClientProtocol::Messages::Numeric::Numeric ( unsigned int  num)
inline

Constructor. Only the numeric number has to be specified.

Parameters
numNumeric number.

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