wGui::CMessageServer Class Reference

A server which queues and dispatches messages. More...

#include <wg_message_server.h>

Public Types

enum EClientPriority {
PRIORITY_LAST = 0, PRIORITY_LOW = 50, PRIORITY_NORMAL = 100, PRIORITY_HIGH = 150,
PRIORITY_FIRST = 255
}
Used for marking the priority of registered message clients, where the higher priority clients will get messages first. More...

Public Member Functions

void RegisterMessageClient (CMessageClient *pClient, CMessage::EMessageType eMessageType, unsigned char Priority=PRIORITY_NORMAL)
void DeregisterMessageClient (CMessageClient *pClient, CMessage::EMessageType eMessageType)
void DeregisterMessageClient (CMessageClient *pClient)
void DeliverMessage (void)
Takes the next message in the queue and dispatches it to any registered clients in priority order.
void QueueMessage (CMessage *pMessage)
bool MessageAvailable (void)
void IgnoreAllNewMessages (bool bIgnore)

Static Public Member Functions

static CMessageServer & Instance (void)

Protected Member Functions

CMessageServer (void)
The CMessageServer class cannot be directly instantiated, it must be access through Instance().
virtual ~CMessageServer (void)
Standard constructor.

Protected Attributes

std::deque< CMessage * > m_MessageQueue
The message queue.
t_MessageClientMap m_MessageClients
A map of all the registered clients.
SDL_sem * m_pSemaphore
A semaphore indicating how many messages are in the queue.
bool m_bIgnoreAllNewMessages
Locks the queue so that no new messages are added, this is used during initialization, defaults to true.

Static Protected Attributes

static CMessageServer * m_pInstance
A pointer to the single instande of the message server.

Detailed Description

A server which queues and dispatches messages.

CMessageServer is a singeton (only one instance of it is allowed to exist at any time) Clients must register to get messages sent to them

See also:: CMessage CMessageClient

Definition at line 69 of file wg_message_server.h.

Member Enumeration Documentation

enum wGui::CMessageServer::EClientPriority

Used for marking the priority of registered message clients, where the higher priority clients will get messages first.

Enumerator:

PRIORITY_LAST	The absolute lowest priority available.
PRIORITY_LOW	Low priority.
PRIORITY_NORMAL	Standard priority.
PRIORITY_HIGH	High priority.
PRIORITY_FIRST	The absolute highest priority available.

Definition at line 81 of file wg_message_server.h.

Member Function Documentation

CMessageServer & wGui::CMessageServer::Instance ( void ) [static]

Gets the single instance of the message server

Returns:: The single valid instance of the message server, or create one if it doesn't already exist

Definition at line 55 of file wg_message_server.cpp.

References m_pInstance.

Referenced by wGui::CButton::CButton(), wGui::CCheckBox::CCheckBox(), wGui::CDropDown::CDropDown(), wGui::CEditBox::CEditBox(), wGui::CFrame::CFrame(), wGui::CListBox::CListBox(), wGui::CFrame::CloseFrame(), wGui::CMenu::CMenu(), wGui::CMenuBase::CMenuBase(), wGui::CPopupMenu::CPopupMenu(), wGui::CRadioButton::CRadioButton(), wGui::CScrollBar::CScrollBar(), wGui::CTextBox::CTextBox(), wGui::CToolBar::CToolBar(), wGui::CToolTip::CToolTip(), wGui::CView::CView(), wGui::CWindow::Draw(), wGui::CApplication::Exec(), wGui::CView::HandleMessage(), wGui::CToolBar::HandleMessage(), wGui::CTextBox::HandleMessage(), wGui::CScrollBar::HandleMessage(), wGui::CRadioButton::HandleMessage(), wGui::CMessageBox::HandleMessage(), wGui::CMenuBase::HandleMessage(), wGui::CFrame::HandleMessage(), wGui::CEditBox::HandleMessage(), wGui::CDropDown::HandleMessage(), wGui::CCheckBox::HandleMessage(), wGui::CApplication::HandleSDLEvent(), wGui::CPopupMenu::Hide(), wGui::CToolTip::HideTip(), wGui::CApplication::Init(), wGui::CWindow::MoveWindow(), wGui::CTextBox::OnMouseButtonDown(), wGui::CPopupMenu::OnMouseButtonDown(), wGui::CMenu::OnMouseButtonDown(), wGui::CFrame::OnMouseButtonDown(), wGui::CEditBox::OnMouseButtonDown(), wGui::CRadioButton::OnMouseButtonUp(), wGui::CListBox::OnMouseButtonUp(), wGui::CCheckBox::OnMouseButtonUp(), wGui::CButton::OnMouseButtonUp(), wGui::CApplication::SetKeyFocus(), wGui::CApplication::SetMouseFocus(), wGui::CRangeControl< int >::SetValue(), wGui::CWindow::SetVisible(), wGui::CTimer::TimerHit(), wGui::CMessageClient::~CMessageClient(), and wGui::CWindow::~CWindow().

void wGui::CMessageServer::RegisterMessageClient	(	CMessageClient *	pClient,
		CMessage::EMessageType	eMessageType,
		unsigned char	Priority = `PRIORITY_NORMAL`
	)

Parameters:

	pClient	A pointer to the client which should recieve the messages
	eMessageType	The message type the client wishes to recieve
	Priority	The priority of the client for recieving the message

Definition at line 70 of file wg_message_server.cpp.

References wUtil::CLog::AddLogEntry(), wGui::APP_LOG_ERROR, wGui::CApplication::GetApplicationLog(), wGui::CApplication::Instance(), and m_MessageClients.