ClientProtocol::Event Class Reference

#include <clientprotocol.h>

Inheritance diagram for ClientProtocol::Event:

Public Member Functions
	Event (EventProvider &protoeventprov)
	Event (EventProvider &protoeventprov, ClientProtocol::Message &msg)
void	SetMessage (Message *msg)
void	SetMessageList (const MessageList &msglist)
void	GetMessagesForUser (LocalUser *user, MessageList &messagelist)

Detailed Description

Client protocol event class. All messages sent to a user must be part of an event. A single event may result in more than one protocol message being sent, for example a join event may result in a JOIN and a MODE protocol message sent to members of the channel if the joining user has some prefix modes set.

Event hooks attached to a specific event can alter the messages sent for that event.

Constructor & Destructor Documentation

Event() [1/2]

ClientProtocol::Event::Event ( EventProvider &  protoeventprov )

inline

Constructor.

Parameters

protoeventprov

Protocol event provider the event is an instance of.

Event() [2/2]

ClientProtocol::Event::Event ( EventProvider &  protoeventprov, ClientProtocol::Message &  msg  )

inline

Constructor.

Parameters

protoeventprov	Protocol event provider the event is an instance of.
msg	Message to include in this event by default.

Member Function Documentation

GetMessagesForUser()

void ClientProtocol::Event::GetMessagesForUser	(	LocalUser *	user,
		MessageList &	messagelist
	)

Get a list of messages to send to a user. The exact messages sent to a user are determined by the initial message(s) set and hooks.

Parameters

user	User to get the messages for.
messagelist	List to fill in with messages to send to the user for the event

SetMessage()

void ClientProtocol::Event::SetMessage ( Message *  msg )

inline

Set a single message as the initial message in the event. Modules may alter this later.

SetMessageList()

void ClientProtocol::Event::SetMessageList ( const MessageList &  msglist )

inline

Set a list of messages as the initial messages in the event. Modules may alter this later.

---

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

• include/clientprotocol.h
• src/clientprotocol.cpp