Here is a small explanation of how messages on IRC work, and how you can use this class to get useful information from the parsed message. More...

#include <Message.h>

Inheritance diagram for CMessage:

Public Types
enum	Type { Type::Unknown, Type::Account, Type::Action, Type::Away, Type::Capability, Type::CTCP, Type::Error, Type::Invite, Type::Join, Type::Kick, Type::Mode, Type::Nick, Type::Notice, Type::Numeric, Type::Part, Type::Ping, Type::Pong, Type::Quit, Type::Text, Type::Topic, Type::Wallops }

enum	FormatFlags { IncludeAll = 0x0, ExcludePrefix = 0x1, ExcludeTags = 0x2 }

Public Member Functions
	CMessage (const CString &sMessage="")

	CMessage (const CNick &Nick, const CString &sCommand, const VCString &vsParams=VCString(), const MCString &mssTags=MCString::EmptyMap)

Type	GetType () const

bool	Equals (const CMessage &Other) const

void	Clone (const CMessage &Other)

CIRCNetwork *	GetNetwork () const

void	SetNetwork (CIRCNetwork *pNetwork)

CClient *	GetClient () const

void	SetClient (CClient *pClient)

CChan *	GetChan () const

void	SetChan (CChan *pChan)

CNick &	GetNick ()

const CNick &	GetNick () const

void	SetNick (const CNick &Nick)

const CString &	GetCommand () const

void	SetCommand (const CString &sCommand)

const VCString &	GetParams () const

CString	GetParams (unsigned int uIdx, unsigned int uLen=-1) const

void	SetParams (const VCString &vsParams)

CString	GetParam (unsigned int uIdx) const

void	SetParam (unsigned int uIdx, const CString &sParam)

const timeval &	GetTime () const

void	SetTime (const timeval &ts)

const MCString &	GetTags () const

void	SetTags (const MCString &mssTags)

CString	GetTag (const CString &sKey) const

void	SetTag (const CString &sKey, const CString &sValue)

CString	ToString (unsigned int uFlags=IncludeAll) const

void	Parse (CString sMessage)

template<typename M >
M &	As () ZNC_LVREFQUAL

template<typename M >
const M &	As () const ZNC_LVREFQUAL

template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>
	operator M & () ZNC_LVREFQUAL

template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>
	operator const M & () const ZNC_LVREFQUAL

Detailed Description

Here is a small explanation of how messages on IRC work, and how you can use this class to get useful information from the parsed message.

The output varies greatly and this advice may not apply to every message type, but this will hopefully help you understand how it works more accurately.

=some-tag :server.network.net 366 something #channel :End of /NAMES list. tags nick cmd 0 1 2

tags is the IRCv3 tags associated with the message, obtained with GetTag("t"). the tag can also be obtained with GetTime(), some messages have other tags with them. Tags may not always be present. Refer to IRCv3 for documentation on tags.
nick is the sender, which can be obtained with GetNick()
cmd is command, which is obtained via GetCommand()
0, 1, ... are parameters, available via GetParam(n), which removes the leading colon (:). If you don't want to remove the colon, use GetParams().

For certain events, like a PRIVMSG, convienience commands like GetChan() and GetNick() are available, this is not true for all CMessage extensions.

Member Enumeration Documentation

enum CMessage::FormatFlags

Enumerator
IncludeAll
ExcludePrefix
ExcludeTags

enum CMessage::Type

strong

Enumerator
Unknown
Account
Action
Away
Capability
CTCP
Error
Invite
Join
Kick
Mode
Nick
Notice
Numeric
Part
Ping
Pong
Quit
Text
Topic
Wallops

Constructor & Destructor Documentation

CMessage::CMessage ( const CString & sMessage = "" )

explicit

CMessage::CMessage	(	const CNick &	Nick,
		const CString &	sCommand,
		const VCString &	vsParams = `VCString()`,
		const MCString &	mssTags = `MCString::EmptyMap`
	)