i6engine  1.0
i6e::api::MessagingFacade Class Reference

#include <D:/Projekte/i6engine/libs/i6engine-modules/include/i6engine/api/facades/MessagingFacade.h>

Public Member Functions

 MessagingFacade ()
 
 ~MessagingFacade ()
 
void deliverMessage (const GameMessage::Ptr &msg)
 sends a message More...
 
void registerMessageType (uint16_t msgType, core::MessageSubscriber *objMessageSubscriber, const boost::function< void(GameMessage::Ptr)> &ptrMessageMethod)
 This method registers a message type with the given message subscriber and the given Method. It is normally called via the macro ISIXE_REGISTERMESSAGETYPE. More...
 
void unregisterMessageType (uint16_t msgType, core::MessageSubscriber *objMessageSubscriber)
 This method unregisters a message type of the given message subscriber. More...
 

Friends

class EngineController
 

Detailed Description

Definition at line 46 of file MessagingFacade.h.

Constructor & Destructor Documentation

i6e::api::MessagingFacade::MessagingFacade ( )
i6e::api::MessagingFacade::~MessagingFacade ( )

Member Function Documentation

void i6e::api::MessagingFacade::deliverMessage ( const GameMessage::Ptr msg)

sends a message

void i6e::api::MessagingFacade::registerMessageType ( uint16_t  msgType,
core::MessageSubscriber objMessageSubscriber,
const boost::function< void(GameMessage::Ptr)> &  ptrMessageMethod 
)

This method registers a message type with the given message subscriber and the given Method. It is normally called via the macro ISIXE_REGISTERMESSAGETYPE.

Calling this method directly allows it, that objects let other objects subscribe to certain message types.

Parameters
strMessageTypeName of the new message type.
objMessageSubscriberThe new receiver of messages of the given type (should be the caller by itself).
ptrMessageMethodThe name of the method that will be called when a message of a certain type arrives at the receiver.
void i6e::api::MessagingFacade::unregisterMessageType ( uint16_t  msgType,
core::MessageSubscriber objMessageSubscriber 
)

This method unregisters a message type of the given message subscriber.

Parameters
strMessageTypeName of the new message type.
objMessageSubscriberReceiver to be deleted from the subscriber list.

Friends And Related Function Documentation

friend class EngineController
friend

Definition at line 47 of file MessagingFacade.h.


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