Rogue Wave web site:  Home Page  |  Main Documentation Page

rwsf::AgentMethodImp Class Reference
[Agent Methods]

Abstract base class for implementing Agent methods. More...

#include <rwsf/agent_methods/AgentMethodImp.h>

Inheritance diagram for rwsf::AgentMethodImp:

List of all members.

Public Member Functions
	AgentMethodImp ()
virtual void	init (const rwsf::Config &config, const rwsf::AgentContext &manager)=0
virtual void	invoke ()=0
Related Functions
(Note that these are not member functions.)
	RWSF_DEFINE_METHOD(NAME)

---

Detailed Description

Class rwsf::AgentMethodImp is the abstract base class for implementing Agent methods, such as rwsf::MessageInfo handlers.

---

Constructor & Destructor Documentation

rwsf::AgentMethodImp::AgentMethodImp

(

)

Default constructor.

---

Member Function Documentation

virtual void rwsf::AgentMethodImp::init	(	const rwsf::Config &	config,
		const rwsf::AgentContext &	manager
	)			[pure virtual]

Initializes the method with configuration options specified in the configuration file rwagent.xml, located in the <installdir>\conf directory.

• The config parameter holds the configuration properties defined in the config file.
• The agent parameter is the rwsf::AgentContext, which contains the AgentMethod.

virtual void rwsf::AgentMethodImp::invoke

(

)

[pure virtual]

Defines the main functionality of the AgentMethod. Anyone extending from this class must implement the invoke() method to define the method's behavior.

---

Friends And Related Function Documentation

RWSF_DEFINE_METHOD

(

NAME

)

[related]

Defines a function that returns an AgentMethod of type NAME. The macro names the function by prefacing NAME with the word "create". The Agent uses the function to construct an instance of AgentMethod. For example to use the newly defined method you would need to do the following:

Add the following to the implementation file of your newly defined AgentMethod.

 RWSF_DEFINE_METHOD(MyAgentMethod)

Add the following element as a child of either the <rwsf:preStartup>, <rwsf:postStartup>, <rwsf:preShutdown>, or <rwsf:postShutdown> element, in the rwagent.xml configuration file.

 <rwsf:method name="some-name" class="<i>dllName</i>.createMyAgentMethod"/>