FormIt::MessageBroadcaster Class Reference

Description

FormIt::MessageBroadcaster class.

#include <FormItMessaging.h>

Static Public Member Functions
template<typename T >
static void	Broadcast (T const &message, typename T::Payload const &payload)
	Sends the given message to all Listeners that have subscribed to it.
template<typename T >
static void	Broadcast (T const &message, typename T::Payload &&payload)
static FORMIT_CORE_EXPORT void	Broadcast (MessageVoidStruct const &message)
static FORMIT_CORE_EXPORT void	SubscribeToMessage (MessageListener *listener, MessageStruct const &message)
	Makes sure that all future broadcasts of message do/don't go to the given listener.
static FORMIT_CORE_EXPORT MessageStruct const *	SubscribeToMessage (MessageListener *listener, 1::string const &message)
static FORMIT_CORE_EXPORT void	UnsubscribeFromMessage (MessageListener *listener, MessageStruct const &message)
	UnsubscribeFromMessage() function.
static FORMIT_CORE_EXPORT MessageStruct const *	UnsubscribeFromMessage (MessageListener *listener, 1::string const &message)
static FORMIT_CORE_EXPORT void	SubscribeToAllMessages (MessageListener *listener)
	SubscribeToAllMessages will broadcast all the messages to the given listener.
static FORMIT_CORE_EXPORT void	UnsubscribeFromAll (MessageListener *listener)
	UnsubscribeFromAll() function.
static FORMIT_CORE_EXPORT void	RegisterScriptMessage (1::string const &, const FormIt::MessageStruct *)
	Register the message for scripting.
static ::vector< 1::string >	GetScriptMessages ()
	Get the list of messages.
static void	construct ()
	construct() function.
static void	destroy ()
	destroy() function.

Member Function Documentation

Broadcast() [1/3]

static FORMIT_CORE_EXPORT void FormIt::MessageBroadcaster::Broadcast ( MessageVoidStruct const &  message )

static

Broadcast() [2/3]

template<typename T >

static void FormIt::MessageBroadcaster::Broadcast ( T const &  message, typename T::Payload &&  payload  )

inlinestatic

Broadcast() [3/3]

template<typename T >

static void FormIt::MessageBroadcaster::Broadcast ( T const &  message, typename T::Payload const &  payload  )

inlinestatic

Sends the given message to all Listeners that have subscribed to it.

Parameters

[in]	message
[in]	payload

construct()

static void FormIt::MessageBroadcaster::construct ( )

static

construct() function.

destroy()

static void FormIt::MessageBroadcaster::destroy ( )

static

destroy() function.

GetScriptMessages()

static ::vector< 1::string > FormIt::MessageBroadcaster::GetScriptMessages ( )

static

Get the list of messages.

RegisterScriptMessage()

static FORMIT_CORE_EXPORT void FormIt::MessageBroadcaster::RegisterScriptMessage ( 1::string const &  , const FormIt::MessageStruct *    )

static

Register the message for scripting.

SubscribeToAllMessages()

static FORMIT_CORE_EXPORT void FormIt::MessageBroadcaster::SubscribeToAllMessages ( MessageListener *  listener )

static

SubscribeToAllMessages will broadcast all the messages to the given listener.

For example, this is used to pipe all the messages into the Web app for handling in native JS code.

Parameters

[out]

listener

SubscribeToMessage() [1/2]

static FORMIT_CORE_EXPORT MessageStruct const * FormIt::MessageBroadcaster::SubscribeToMessage ( MessageListener *  listener, 1::string const &  message  )

static

SubscribeToMessage() [2/2]

static FORMIT_CORE_EXPORT void FormIt::MessageBroadcaster::SubscribeToMessage ( MessageListener *  listener, MessageStruct const &  message  )

static

Makes sure that all future broadcasts of message do/don't go to the given listener.

Parameters

[out]	listener
[in]	message

UnsubscribeFromAll()

static FORMIT_CORE_EXPORT void FormIt::MessageBroadcaster::UnsubscribeFromAll ( MessageListener *  listener )

static

UnsubscribeFromAll() function.

Parameters

[out]

listener

UnsubscribeFromMessage() [1/2]

static FORMIT_CORE_EXPORT MessageStruct const * FormIt::MessageBroadcaster::UnsubscribeFromMessage ( MessageListener *  listener, 1::string const &  message  )

static

UnsubscribeFromMessage() [2/2]

static FORMIT_CORE_EXPORT void FormIt::MessageBroadcaster::UnsubscribeFromMessage ( MessageListener *  listener, MessageStruct const &  message  )

static

UnsubscribeFromMessage() function.

Parameters

[out]	listener
[in]	message

---

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

• Public/FormItMessaging.h