Inheritance diagram for ICSXSVulcanMessageHandler:

Public Types
enum	{ kDefaultIID = IID_ICSXSVULCANMESSAGEHANDLER }

typedef void(*	MessageListenerFn )(const std::string &message)

Public Member Functions
virtual void	SendMessage (const std::string &messageType, const std::string &appId, const std::string &appVersion, const std::string &message)=0

virtual void	AddMessageListener (MessageListenerFn messageListener, const std::string &messageType)=0

virtual void	RemoveMessageListener (MessageListenerFn messageListener, const std::string &messageType)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual void ICSXSVulcanMessageHandler::AddMessageListener	(	MessageListenerFn	messageListener,
		const std::string &	messageType
	)

pure virtual

Adds a listener for vulcan messages

Parameters

messageListener	Listener to add.
messageType	The message type the listener listens to.

virtual void ICSXSVulcanMessageHandler::RemoveMessageListener	(	MessageListenerFn	messageListener,
		const std::string &	messageType
	)

pure virtual

Removes a listener already added.

Parameters

messageListener	Listener to remove.
messageType	The message type the listener listens to.

virtual void ICSXSVulcanMessageHandler::SendMessage	(	const std::string &	messageType,
		const std::string &	appId,
		const std::string &	appVersion,
		const std::string &	message
	)

pure virtual

Send a message to an application.

Parameters

messageType	Message type, this is used by the listener to process the messages.
appId	Application ID of the application to which this message will be sent to.
appVersion	Application Version of the application to which this message will be sent to. This can be empty as well.
message	Message payload.

For example, this can be called as: vulcanMessage->SendMessage("com.adobe.indesign", "IDSN", "10.0", kSnipRunHelloCSXSMessage);

Public Types