HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions
rwsf::NamedObjectLoader Class Reference

Loads and registers named objects with the Agent's global naming context. More...

#include <rwsf/agent_methods/NamedObjectLoader.h>

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

Public Member Functions

virtual void init (const rwsf::Config &config, const rwsf::AgentContext &context)
 
virtual void invoke ()
 
- Public Member Functions inherited from rwsf::AgentMethodImp
 AgentMethodImp ()
 

Additional Inherited Members

Detailed Description

See also
NamingContext::load() For more information.

This class loads the named objects defined in an XML configuration file and registers them with the Agent's global NamingContext instance.

The NamedObjectLoader is configured in the main Agent configuration file, rwagent.xml, located in the <installdir>\conf directory.

For more information about how to configure and use named objects, see the User Guide on Named Objects.

Member Function Documentation

virtual void rwsf::NamedObjectLoader::init ( const rwsf::Config config,
const rwsf::AgentContext manager 
)
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.

Implements rwsf::AgentMethodImp.

virtual void rwsf::NamedObjectLoader::invoke ( )
virtual

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

Implements rwsf::AgentMethodImp.

Copyright © 2019 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.