CModeMessage Class Reference

#include <Message.h>

Inheritance diagram for CModeMessage:

Collaboration diagram for CModeMessage:

Public Types
enum class	Type {   Unknown , Account , Action , Away ,   Capability , ChgHost , CTCP , Error ,   Invite , Join , Kick , Mode ,   Nick , Notice , Numeric , Part ,   Ping , Pong , Quit , Text ,   Topic , Wallops }
enum	FormatFlags { IncludeAll = 0x0 , ExcludePrefix = 0x1 , ExcludeTags = 0x2 }

Public Member Functions
CString	GetModes () const
CString	GetModeList () const
VCString	GetModeParams () const
bool	HasModes () const
CString	GetTarget () const
void	SetTarget (const CString &sTarget)
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 ZNC_MSG_DEPRECATED("Use GetParamsColon() instead")
VCString	GetParamsSplit (unsigned int uIdx, unsigned int uLen=-1) const
	Get a subset of the message parameters. More...
void	SetParams (const VCString &vsParams)
void	SetParams (VCString &&vsParams)
CString	GetParamsColon (unsigned int uIdx, unsigned int uLen=-1) const
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 (const CString &sMessage)
template<typename M >
M &	As () &
template<typename M >
const M &	As () const &
template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>
	operator M& () &
template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>
	operator const M & () const &

Member Enumeration Documentation

FormatFlags

enum CMessage::FormatFlags

inherited

Enumerator
IncludeAll
ExcludePrefix
ExcludeTags

Type

enum CMessage::Type

stronginherited

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

Member Function Documentation

As() [1/2]

template<typename M >

M& CMessage::As ( ) &

inlineinherited

As() [2/2]

template<typename M >

const M& CMessage::As ( ) const &

inlineinherited

Clone()

void CMessage::Clone ( const CMessage &  Other )

inherited

Equals()

bool CMessage::Equals ( const CMessage &  Other ) const

inherited

Referenced by CBufLine::Equals().

GetChan()

CChan* CMessage::GetChan ( ) const

inlineinherited

GetClient()

CClient* CMessage::GetClient ( ) const

inlineinherited

GetCommand()

const CString& CMessage::GetCommand ( ) const

inlineinherited

Referenced by CNumericMessage::GetCode(), CBufLine::GetCommand(), and CCTCPMessage::IsReply().

GetModeList()

CString CModeMessage::GetModeList ( ) const

inline

References CMessage::GetParam().

Referenced by HasModes().

GetModeParams()

VCString CModeMessage::GetModeParams ( ) const

inline

References CMessage::GetParamsSplit().

GetModes()

CString CModeMessage::GetModes ( ) const

inline

Deprecated:

Use GetModeList() and GetModeParams()

References CMessage::GetParamsColon(), and CString::TrimPrefix_n().

GetNetwork()

CIRCNetwork* CMessage::GetNetwork ( ) const

inlineinherited

GetNick() [1/2]

CNick& CMessage::GetNick ( )

inlineinherited

Referenced by CNickMessage::GetOldNick().

GetNick() [2/2]

const CNick& CMessage::GetNick ( ) const

inlineinherited

GetParam()

CString CMessage::GetParam ( unsigned int  uIdx ) const

inherited

Referenced by CJoinMessage::GetKey(), CKickMessage::GetKickedNick(), GetModeList(), CChgHostMessage::GetNewHost(), CChgHostMessage::GetNewIdent(), CNickMessage::GetNewNick(), CKickMessage::GetReason(), CPartMessage::GetReason(), CQuitMessage::GetReason(), CTargetMessage::GetTarget(), CActionMessage::GetText(), CCTCPMessage::GetText(), CNoticeMessage::GetText(), CTextMessage::GetText(), and CTopicMessage::GetTopic().

GetParams() [1/2]

const VCString& CMessage::GetParams ( ) const

inlineinherited

GetParams() [2/2]

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

inlineinherited

Deprecated:

use GetParamsColon() instead.

References CMessage::GetParamsColon().

GetParamsColon()

CString CMessage::GetParamsColon ( unsigned int  uIdx, unsigned int  uLen = -1  ) const

inherited

Referenced by GetModes(), and CMessage::GetParams().

GetParamsSplit()

VCString CMessage::GetParamsSplit ( unsigned int  uIdx, unsigned int  uLen = -1  ) const

inherited

Get a subset of the message parameters.

This allows accessing a vector of a specific range of parameters, allowing easy inline use, such as pChan->SetModes(Message.GetParam(2), Message.GetParamsSplit(3));

Parameters

uIdx	The index of the first parameter to retrieve
uLen	How many parameters to retrieve

Returns

A VCString containing the retrieved parameters

Referenced by GetModeParams().

GetTag()

CString CMessage::GetTag ( const CString &  sKey ) const

inherited

GetTags()

const MCString& CMessage::GetTags ( ) const

inlineinherited

Referenced by CBufLine::GetTags().

GetTarget()

CString CTargetMessage::GetTarget ( ) const

inlineinherited

References CMessage::GetParam().

GetTime()

const timeval& CMessage::GetTime ( ) const

inlineinherited

Referenced by CBufLine::GetTime().

GetType()

Type CMessage::GetType ( ) const

inlineinherited

HasModes()

bool CModeMessage::HasModes ( ) const

inline

References GetModeList().

operator const M &()

template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>

CMessage::operator const M & ( ) const &

inlineinherited

operator M&()

template<typename M , typename = typename std::enable_if< std::is_base_of<CMessage, M>{}>::type>

CMessage::operator M& ( ) &

inlineinherited

Parse()

void CMessage::Parse ( const CString &  sMessage )

inherited

Referenced by CBufLine::SetFormat().

SetChan()

void CMessage::SetChan ( CChan *  pChan )

inlineinherited

SetClient()

void CMessage::SetClient ( CClient *  pClient )

inlineinherited

SetCommand()

void CMessage::SetCommand ( const CString &  sCommand )

inherited

SetNetwork()

void CMessage::SetNetwork ( CIRCNetwork *  pNetwork )

inlineinherited

SetNick()

void CMessage::SetNick ( const CNick &  Nick )

inlineinherited

SetParam()

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

inherited

Referenced by CJoinMessage::SetKey(), CKickMessage::SetKickedNick(), CChgHostMessage::SetNewHost(), CChgHostMessage::SetNewIdent(), CNickMessage::SetNewNick(), CKickMessage::SetReason(), CPartMessage::SetReason(), CQuitMessage::SetReason(), CTargetMessage::SetTarget(), CActionMessage::SetText(), CCTCPMessage::SetText(), CNoticeMessage::SetText(), CTextMessage::SetText(), and CTopicMessage::SetTopic().

SetParams() [1/2]

void CMessage::SetParams ( const VCString &  vsParams )

inherited

SetParams() [2/2]

void CMessage::SetParams ( VCString &&  vsParams )

inherited

SetTag()

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

inherited

SetTags()

void CMessage::SetTags ( const MCString &  mssTags )

inlineinherited

Referenced by CBufLine::SetTags().

SetTarget()

void CTargetMessage::SetTarget ( const CString &  sTarget )

inlineinherited

References CMessage::SetParam().

SetTime()

void CMessage::SetTime ( const timeval &  ts )

inlineinherited

Referenced by CBufLine::SetTime().

ToString()

CString CMessage::ToString ( unsigned int  uFlags = IncludeAll ) const

inherited

Referenced by CBufLine::GetFormat().

---

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

• Message.h