#include <FederatorConfig.h>

Collaboration diagram for OpenDDS::Federator::Config:

Public Member Functions
	Config (int argc, ACE_TCHAR **argv)
	Default constructor. More...

virtual	~Config ()

int &	argc ()
	Access the enhanced argv. More...

int	argc () const

ACE_TCHAR **&	argv ()
	Access the enhanced argc. More...

ACE_TCHAR **	argv () const

void	addArg (ACE_TCHAR *arg)
	Add an argument. More...

TAO_DDS_DCPSFederationId &	federationId ()
	Federation Id value. More...

const TAO_DDS_DCPSFederationId &	federationId () const

void	federationDomain (long domain)
	Federation Id value. More...

long	federationDomain () const

void	federationPort (short port)
	Federation Port value. More...

short	federationPort () const

void	federateIor (const tstring &ior)
	Initial federation IOR value. More...

tstring	federateIor () const

void	configFile (const tstring &file)
	Configuration filename. More...

tstring	configFile () const

Static Public Attributes
static const tstring	FEDERATOR_CONFIG_OPTION
	Command line option specifying the configuration file. More...

static const tstring	FEDERATOR_ID_OPTION
	Command line option specifying the federation Id value. More...

static const tstring	FEDERATE_WITH_OPTION
	Command line option specifying a repository to federate with. More...

Private Member Functions
void	processFile ()
	Process a configuration file. More...

Private Attributes
int	argc_
	Enhanced argc. More...

ACE_TCHAR **	argv_
	Enhanced argv. More...

tstring	configFile_
	Configuration filename, if any. More...

tstring	federateIor_
	Initial federation IOR, if any. More...

TAO_DDS_DCPSFederationId	federationId_
	Configured Federation Id value. More...

long	federationDomain_
	Configured Federation Domain value. More...

short	federationPort_
	Configured Federation Port value. More...

Detailed Description

Definition at line 28 of file FederatorConfig.h.

Constructor & Destructor Documentation

◆ Config()

OpenDDS::Federator::Config::Config	(	int	argc,
		ACE_TCHAR **	argv
	)

Default constructor.

Definition at line 190 of file FederatorConfig.cpp.

References ACE_DEBUG, ACE_TEXT(), argv_, OpenDDS::DCPS::DCPS_debug_level, LM_DEBUG, and processFile().

   : argc_(0),
     federationId_(hash_endpoints(argc, argv)),
     federationDomain_(DEFAULT_FEDERATIONDOMAIN),
     federationPort_(-1)
 {
   if (::OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) INFO: Federator::Config::Config()\n")));
   }
 
   // Setup the internal storage.
   this->argv_ = new ACE_TCHAR*[argc + 1](); // argv_[argc] == 0
 
   // Process the federation arguments.  Copy the uninteresting arguments verbatim.
   ArgCopier argCopier(this);
   std::for_each(&argv[0], &argv[ argc], argCopier);
 
   // Read and process any configuration file.
   this->processFile();
 }

◆ ~Config()

OpenDDS::Federator::Config::~Config ( )

virtual

Definition at line 212 of file FederatorConfig.cpp.

References ACE_DEBUG, ACE_TEXT(), argv_, OpenDDS::DCPS::DCPS_debug_level, and LM_DEBUG.

 {
   if (::OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) INFO: Federator::Config::~FederatorConfig()\n")));
   }
 
   // We prwn this
   delete [] this->argv_;
 }

Member Function Documentation

◆ addArg()

ACE_INLINE void OpenDDS::Federator::Config::addArg ( ACE_TCHAR * arg )

Add an argument.

Definition at line 40 of file FederatorConfig.inl.

References ACE_INLINE, argc_, and argv_.

Referenced by OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::ArgCopier::operator()().

 {
   this->argv_[this->argc_++] = arg;
 }

◆ argc() [1/2]

OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE int & OpenDDS::Federator::Config::argc ( void )

Access the enhanced argv.

Definition at line 12 of file FederatorConfig.inl.

References ACE_INLINE, and argc_.

 {
   return this->argc_;
 }

◆ argc() [2/2]

ACE_INLINE int OpenDDS::Federator::Config::argc ( void ) const

Definition at line 19 of file FederatorConfig.inl.

References ACE_INLINE, and argc_.

 {
   return this->argc_;
 }

◆ argv() [1/2]

ACE_INLINE ACE_TCHAR **& OpenDDS::Federator::Config::argv ( void )

Access the enhanced argc.

Definition at line 26 of file FederatorConfig.inl.

References ACE_INLINE, and argv_.

Referenced by InfoRepo::init().

 {
   return this->argv_;
 }

◆ argv() [2/2]

ACE_INLINE ACE_TCHAR ** OpenDDS::Federator::Config::argv ( void ) const

Definition at line 33 of file FederatorConfig.inl.

References ACE_INLINE, and argv_.

 {
   return this->argv_;
 }

◆ configFile() [1/2]

ACE_INLINE void OpenDDS::Federator::Config::configFile ( const tstring & file )

Configuration filename.

Definition at line 75 of file FederatorConfig.inl.

References ACE_INLINE, and configFile_.

Referenced by OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::ArgCopier::operator()().

 {
   this->configFile_ = file;
 }

◆ configFile() [2/2]

ACE_INLINE OpenDDS::Federator::tstring OpenDDS::Federator::Config::configFile ( ) const

Definition at line 82 of file FederatorConfig.inl.

References ACE_INLINE, and configFile_.

 {
   return this->configFile_;
 }

◆ federateIor() [1/2]

ACE_INLINE void OpenDDS::Federator::Config::federateIor ( const tstring & ior )

Initial federation IOR value.

Definition at line 89 of file FederatorConfig.inl.

References ACE_INLINE, and federateIor_.

Referenced by InfoRepo::init(), and OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::ArgCopier::operator()().

 {
   this->federateIor_ = ior;
 }

◆ federateIor() [2/2]

ACE_INLINE OpenDDS::Federator::tstring OpenDDS::Federator::Config::federateIor ( ) const

Definition at line 96 of file FederatorConfig.inl.

References ACE_INLINE, and federateIor_.

 {
   return this->federateIor_;
 }

◆ federationDomain() [1/2]

ACE_INLINE void OpenDDS::Federator::Config::federationDomain ( long domain )

Federation Id value.

Definition at line 47 of file FederatorConfig.inl.

References ACE_INLINE, and federationDomain_.

Referenced by OpenDDS::Federator::ManagerImpl::destroy(), InfoRepo::init(), OpenDDS::Federator::ManagerImpl::initialize(), OpenDDS::Federator::ManagerImpl::join_federation(), OpenDDS::Federator::ManagerImpl::leave_federation(), OpenDDS::Federator::ManagerImpl::pushState(), and OpenDDS::Federator::ManagerImpl::repository().

 {
   this->federationDomain_ = domain;
 }

◆ federationDomain() [2/2]

ACE_INLINE long OpenDDS::Federator::Config::federationDomain ( ) const

Definition at line 54 of file FederatorConfig.inl.

References ACE_INLINE, and federationDomain_.

 {
   return this->federationDomain_;
 }

◆ federationId() [1/2]

ACE_INLINE TAO_DDS_DCPSFederationId & OpenDDS::Federator::Config::federationId ( )

Federation Id value.

Definition at line 103 of file FederatorConfig.inl.

References ACE_INLINE, and federationId_.

Referenced by OpenDDS::Federator::ManagerImpl::id(), InfoRepo::init(), and OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::ArgCopier::operator()().

 {
   return this->federationId_;
 }

◆ federationId() [2/2]

ACE_INLINE const TAO_DDS_DCPSFederationId & OpenDDS::Federator::Config::federationId ( ) const

Definition at line 110 of file FederatorConfig.inl.

References federationId_, and OPENDDS_END_VERSIONED_NAMESPACE_DECL.

 {
   return this->federationId_;
 }

◆ federationPort() [1/2]

ACE_INLINE void OpenDDS::Federator::Config::federationPort ( short port )

Federation Port value.

Definition at line 61 of file FederatorConfig.inl.

References ACE_INLINE, and federationPort_.

 {
   this->federationPort_ = port;
 }

◆ federationPort() [2/2]

ACE_INLINE short OpenDDS::Federator::Config::federationPort ( ) const

Definition at line 68 of file FederatorConfig.inl.

References ACE_INLINE, and federationPort_.

 {
   return this->federationPort_;
 }

◆ processFile()

void OpenDDS::Federator::Config::processFile ( )

private

Process a configuration file.

Definition at line 224 of file FederatorConfig.cpp.

References ACE_DEBUG, ACE_ERROR, ACE_TEXT(), ACE_OS::atoi(), ACE_String_Base< char >::c_str(), configFile_, OpenDDS::DCPS::DCPS_debug_level, OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::FEDERATION_DOMAIN_KEY, OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::FEDERATION_ID_KEY, OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::FEDERATION_PORT_KEY, federationDomain_, federationId_, federationPort_, ACE_Configuration_Heap::get_string_value(), TAO_DDS_DCPSFederationId::id(), LM_DEBUG, LM_ERROR, ACE_Configuration_Heap::open(), OPENDDS_END_VERSIONED_NAMESPACE_DECL, TAO_DDS_DCPSFederationId::overridden(), and ACE_Configuration::root_section().

Referenced by Config().

 {
   if (::OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) INFO: Federator::Config::process()\n")));
   }
 
   if (this->configFile_.empty()) {
     // No filename, no processing.
     return;
   }
 
   // Grab a spot to stick the configuration.
   ACE_Configuration_Heap heap;
 
   if (0 != heap.open()) {
     ACE_ERROR((LM_ERROR,
                ACE_TEXT("(%P|%t) ERROR: Federator::Config::process - ")
                ACE_TEXT("unable to open configuration heap.\n")));
     return;
   }
 
   // Import the file into our shiny new spot.
   ACE_Ini_ImpExp import(heap);
 
   if (0 != import.import_config(this->configFile_.c_str())) {
     ACE_ERROR((LM_ERROR,
                ACE_TEXT("(%P|%t) ERROR: Federator::Config::process - ")
                ACE_TEXT("unable to import configuration file.\n")));
     return;
   }
 
   // Configuration file format:
   //
   //   FederationDomain = <number>                       (REQUIRED)
   //   FederationId     = <number>                       (REQUIRED)
   //   FederationPort   = <number>                       (REQUIRED)
   //
 
   // Grab the common configuration settings.
   const ACE_Configuration_Section_Key &root = heap.root_section();
 
   // Federation Domain value - REQUIRED
   ACE_TString federationDomainString;
 
   if (0 != heap.get_string_value(root, FEDERATION_DOMAIN_KEY, federationDomainString)) {
     ACE_ERROR((LM_ERROR,
                ACE_TEXT("(%P|%t) ERROR: Federator::Config::process - ")
                ACE_TEXT("Unable to obtain value for FederationDomain in root section\n")));
     return;
   }
 
   // Convert to numeric repository key value.
   this->federationDomain_ = ACE_OS::atoi(federationDomainString.c_str());
 
   if (::OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t)   FederationDomain == %d\n"),
                this->federationDomain_));
   }
 
   // Federation Id value - REQUIRED
   ACE_TString federationIdString;
 
   if (0 != heap.get_string_value(root, FEDERATION_ID_KEY, federationIdString)) {
     ACE_ERROR((LM_ERROR,
                ACE_TEXT("(%P|%t) ERROR: Federator::Config::process - ")
                ACE_TEXT("Unable to obtain value for FederationId in root section\n")));
     return;
   }
 
   // Convert to numeric repository key value.
   RepoKey idValue = ACE_OS::atoi(federationIdString.c_str());
 
   // Allow the command line to override the file value.
   if (this->federationId_.overridden()) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t)   FederationId == %d from file ")
                ACE_TEXT("overridden by value %d from command line.\n"),
                idValue,
                this->federationId_.id()));
 
   } else {
     this->federationId_.id(idValue);
 
     if (::OpenDDS::DCPS::DCPS_debug_level > 0) {
       ACE_DEBUG((LM_DEBUG,
                  ACE_TEXT("(%P|%t)   FederationId == %d\n"),
                  this->federationId_.id()));
     }
   }
 
   // Federation port value - REQUIRED
   ACE_TString federationPortString;
 
   if (0 != heap.get_string_value(root, FEDERATION_PORT_KEY, federationPortString)) {
     ACE_ERROR((LM_ERROR,
                ACE_TEXT("(%P|%t) ERROR: Federator::Config::process - ")
                ACE_TEXT("Unable to obtain value for FederationPort in root section\n")));
     return;
   }
 
   // Convert to numeric repository key value.
   this->federationPort_ = ACE_OS::atoi(federationPortString.c_str());
 
   if (::OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t)   FederationPort == %d\n"),
                this->federationPort_));
   }
 }

Member Data Documentation

◆ argc_

int OpenDDS::Federator::Config::argc_

private

Enhanced argc.

Definition at line 80 of file FederatorConfig.h.

Referenced by addArg(), and argc().

◆ argv_

ACE_TCHAR** OpenDDS::Federator::Config::argv_

private

Enhanced argv.

Definition at line 83 of file FederatorConfig.h.

Referenced by addArg(), argv(), Config(), and ~Config().

◆ configFile_

tstring OpenDDS::Federator::Config::configFile_

private

Configuration filename, if any.

Definition at line 86 of file FederatorConfig.h.

Referenced by configFile(), and processFile().

◆ FEDERATE_WITH_OPTION

const tstring OpenDDS::Federator::Config::FEDERATE_WITH_OPTION

static

Command line option specifying a repository to federate with.

Definition at line 37 of file FederatorConfig.h.

Referenced by OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::ArgCopier::operator()().

◆ federateIor_

tstring OpenDDS::Federator::Config::federateIor_

private

Initial federation IOR, if any.

Definition at line 89 of file FederatorConfig.h.

Referenced by federateIor().

◆ federationDomain_

long OpenDDS::Federator::Config::federationDomain_

private

Configured Federation Domain value.

Definition at line 95 of file FederatorConfig.h.

Referenced by federationDomain(), and processFile().

◆ federationId_

TAO_DDS_DCPSFederationId OpenDDS::Federator::Config::federationId_

private

Configured Federation Id value.

Definition at line 92 of file FederatorConfig.h.

Referenced by federationId(), and processFile().

◆ federationPort_

short OpenDDS::Federator::Config::federationPort_

private

Configured Federation Port value.

Definition at line 98 of file FederatorConfig.h.

Referenced by federationPort(), and processFile().

◆ FEDERATOR_CONFIG_OPTION

const tstring OpenDDS::Federator::Config::FEDERATOR_CONFIG_OPTION

static

Command line option specifying the configuration file.

Definition at line 31 of file FederatorConfig.h.

Referenced by OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::ArgCopier::operator()().

◆ FEDERATOR_ID_OPTION

const tstring OpenDDS::Federator::Config::FEDERATOR_ID_OPTION

static

Command line option specifying the federation Id value.

Definition at line 34 of file FederatorConfig.h.

Referenced by OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL::ArgCopier::operator()().

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

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Config()

◆ ~Config()

Member Function Documentation

◆ addArg()

◆ argc() [1/2]

◆ argc() [2/2]

◆ argv() [1/2]

◆ argv() [2/2]

◆ configFile() [1/2]

◆ configFile() [2/2]

◆ federateIor() [1/2]

◆ federateIor() [2/2]

◆ federationDomain() [1/2]

◆ federationDomain() [2/2]

◆ federationId() [1/2]

◆ federationId() [2/2]

◆ federationPort() [1/2]

◆ federationPort() [2/2]

◆ processFile()

Member Data Documentation

◆ argc_

◆ argv_

◆ configFile_

◆ FEDERATE_WITH_OPTION

◆ federateIor_

◆ federationDomain_

◆ federationId_

◆ federationPort_

◆ FEDERATOR_CONFIG_OPTION

◆ FEDERATOR_ID_OPTION