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

#include <clientprotocolmsg.h>

Inheritance diagram for ClientProtocol::Messages::Join:
ClientProtocol::Message ClientProtocol::MessageSource ClientProtocol::Events::Join

Public Member Functions

 Join ()
 
 Join (Membership *Memb)
 
 Join (Membership *Memb, const std::string &sourcestrref)
 
void SetParams (Membership *Memb)
 
MembershipGetMember () const
 
- 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

JOIN message. Sent when a user joins a channel.

Constructor & Destructor Documentation

◆ Join() [1/3]

ClientProtocol::Messages::Join::Join ( )
inline

Constructor. Does not populate parameters, call SetParams() before sending the message.

◆ Join() [2/3]

ClientProtocol::Messages::Join::Join ( Membership Memb)
inline

Constructor.

Parameters
MembMembership of the joining user.

◆ Join() [3/3]

ClientProtocol::Messages::Join::Join ( Membership Memb,
const std::string &  sourcestrref 
)
inline

Constructor.

Parameters
MembMembership of the joining user.
sourcestrrefMessage source string, must remain valid as long as this object is alive.

Member Function Documentation

◆ GetMember()

Membership* ClientProtocol::Messages::Join::GetMember ( ) const
inline

Get the Membership of the joining user.

Returns
Membership of the joining user.

◆ SetParams()

void ClientProtocol::Messages::Join::SetParams ( Membership Memb)
inline

Populate parameters from a Membership

Parameters
MembMembership of the joining user.

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