DtLuaMessageInterface Class Reference

Handles translation of messages from C++ structures into Lua tables and the reverse translation as well. Provides interface for Lua scripts to register interest in various messages and send messages.

Public Types
typedef DtAdminContent *(*	luaTableToAdminContentFcn )(const luabind::object &messageContents)
typedef bool(*	adminContentToLuaTableFcn )(const DtAdminContent *, luabind::object &luaTable)
typedef std::function< void(const DtVrfObjectMessage *msg)>	MessageReceiveFcn

Public Member Functions
	DtLuaMessageInterface (DtVrfObjectCommunicationInterface *commIf, MessageReceiveFcn fcn)
virtual	~DtLuaMessageInterface ()
virtual void	sendMessage (const DtScriptVrfObject &receiver, const std::string &messageType, const luabind::object &messageContents)
virtual void	sendRadioMessage (const DtScriptVrfObject &receiver, const std::string &messageType, const luabind::object &messageContents)
virtual void	registerForMessage (const std::string &messageType)
virtual void	unregisterForMessage (const std::string &messageType)

Protected Member Functions
virtual void	processObjectMessage (const DtVrfObjectMessage *msg)

Static Protected Member Functions
static void	objectMessageCallback (const DtVrfObjectMessage *msg, void *usr)

Protected Attributes
DtVrfObjectCommunicationInterface *	myCommunicationIf
std::list < DtAdminContentMessageType >	myRegisteredAdminTypes
MessageReceiveFcn	myMessageReceiveFcn

Private Member Functions
	DtLuaMessageInterface (const DtLuaMessageInterface &other)
DtLuaMessageInterface &	operator= (const DtLuaMessageInterface &other)

Member Typedef Documentation

typedef DtAdminContent*(* DtLuaMessageInterface::luaTableToAdminContentFcn)(const luabind::object &messageContents)

typedef bool(* DtLuaMessageInterface::adminContentToLuaTableFcn)(const DtAdminContent *, luabind::object &luaTable)

typedef std::function<void(const DtVrfObjectMessage* msg)> DtLuaMessageInterface::MessageReceiveFcn

Function signature for the function called when.

Constructor & Destructor Documentation

DtLuaMessageInterface::DtLuaMessageInterface ( const DtLuaMessageInterface &  other )

private

Not implemented.

DtLuaMessageInterface::DtLuaMessageInterface	(	DtVrfObjectCommunicationInterface *	commIf,
		MessageReceiveFcn	fcn
	)

virtual DtLuaMessageInterface::~DtLuaMessageInterface ( )

virtual

Member Function Documentation

DtLuaMessageInterface& DtLuaMessageInterface::operator= ( const DtLuaMessageInterface &  other )

private

Not implemented.

virtual void DtLuaMessageInterface::sendMessage ( const DtScriptVrfObject &  receiver, const std::string &  messageType, const luabind::object &  messageContents  )

virtual

virtual void DtLuaMessageInterface::sendRadioMessage ( const DtScriptVrfObject &  receiver, const std::string &  messageType, const luabind::object &  messageContents  )

virtual

virtual void DtLuaMessageInterface::registerForMessage ( const std::string &  messageType )

virtual

virtual void DtLuaMessageInterface::unregisterForMessage ( const std::string &  messageType )

virtual

static void DtLuaMessageInterface::objectMessageCallback ( const DtVrfObjectMessage *  msg, void *  usr  )

staticprotected

virtual void DtLuaMessageInterface::processObjectMessage ( const DtVrfObjectMessage *  msg )

protectedvirtual

Member Data Documentation

DtVrfObjectCommunicationInterface* DtLuaMessageInterface::myCommunicationIf

protected

std::list<DtAdminContentMessageType> DtLuaMessageInterface::myRegisteredAdminTypes

protected

MessageReceiveFcn DtLuaMessageInterface::myMessageReceiveFcn

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfLua/luaMessageInterface.h