HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions | Related Functions
rwsf::AgentMethodImp Class Referenceabstract

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

#include <rwsf/agent_methods/AgentMethodImp.h>

Inheritance diagram for rwsf::AgentMethodImp:
rwsf::NamedObjectCleanup rwsf::NamedObjectLoader

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.)


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.

Implemented in rwsf::NamedObjectLoader, and rwsf::NamedObjectCleanup.

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.

Implemented in rwsf::NamedObjectLoader, and rwsf::NamedObjectCleanup.

Friends And Related Function Documentation


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.


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"/>

Copyright © 2020 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.