OSB_CORBA::CorbaContext Class Reference

Collaboration diagram for OSB_CORBA::CorbaContext:

[legend]List of all members.

---

Detailed Description

Stores configurations and runtime options.

This class initialises and read the configurations required in a corba server application. It also proivdes common functionalities required by the corba application servers.

Remarks:

Corba servers that require specified additional functions can extend functionalities from this context.

Definition at line 75 of file corbacontext.h.

Log file handling:

• bool openLog (const std::string &app, const std::string &dir)

  Open the log file.
  

• std::string logPath () const

  Get path and name of log file.
  

• void closeLog ()

  Close the log file.
  

• OSB_APP::FileLockLog logger_

  Logging interface to use.
  

Public Member Functions

• CorbaContext ()

  Default constructor.
  

• void initialise (OSB_DB::Session &session)

  Initialise context from database.
  

• void checkNlsLang ()

  Check if NLS_LANG is supported.
  

• int handleArgs (int argc, char **argv)

  Handle command line arguments.
  

• void printHeader (const std::string &tag)

  Print 1st message.
  

• void printTrailer ()

  Print last message.
  

• void printUsage ()

  Print help message.
  

• void printNamingServiceInfo ()

  Print hostname and port number of naming service.
  

Public Attributes

• Config config

  Configuration.
  

• const Config configDefaults

  Default configuration.
  

• Option option

  Command line args.
  

• std::string appName_

  Application of context.
  

• OSB_LIB::ModuleId module_

  Module of context.
  

Control structures:

• OSB_DB::SessionCtrl sessionCtrl_

  Database session.
  

• OSB_LIB::MsgCat::Init msgCatInit_

  Error text manager.
  

Private Member Functions

• long readConfig (OSB_DB::Session &session, std::ostream &strm)

  Read configuration from database.
  

Classes

• struct Config

  Container for configuration. More...
  

• struct Option

  Container for command line args. More...
  

---

Constructor & Destructor Documentation

OSB_CORBA::CorbaContext::CorbaContext

(

)

[inline]

Default constructor.

Definition at line 79 of file corbacontext.h.

References logger_, and OSB_LIB::Log::setInstance().

---

Member Function Documentation

void OSB_CORBA::CorbaContext::checkNlsLang

(

)

Check if NLS_LANG is supported.

void OSB_CORBA::CorbaContext::closeLog

(

)

Close the log file.

int OSB_CORBA::CorbaContext::handleArgs	(	int	argc,
		char **	argv
	)

Handle command line arguments.

void OSB_CORBA::CorbaContext::initialise

(

OSB_DB::Session &

session

)

Initialise context from database.

The function initialises the corba server with configurations from the database.

Parameters:

session

Database session to use.

std::string OSB_CORBA::CorbaContext::logPath

(

)

const

Get path and name of log file.

Warning:

Don't use inside a sequence of output operations:
The function locks and unlocks and an output operator is no sequence point!

bool OSB_CORBA::CorbaContext::openLog	(	const std::string &	app,
		const std::string &	dir
	)

Open the log file.

void OSB_CORBA::CorbaContext::printHeader

(

const std::string &

tag

)

Print 1st message.

Parameters:

tag

CVS tag name.

void OSB_CORBA::CorbaContext::printNamingServiceInfo

(

)

Print hostname and port number of naming service.

void OSB_CORBA::CorbaContext::printTrailer

(

)

Print last message.

void OSB_CORBA::CorbaContext::printUsage

(

)

Print help message.

long OSB_CORBA::CorbaContext::readConfig	(	OSB_DB::Session &	session,
		std::ostream &	strm
	)			[private]

Read configuration from database.

The function reads configurations for corba server from the database.

Parameters:

	session	Database session to use.
	strm	output stream for messages.

---

Member Data Documentation

std::string OSB_CORBA::CorbaContext::appName_

Application of context.

Definition at line 177 of file corbacontext.h.

Config OSB_CORBA::CorbaContext::config

Configuration.

Definition at line 152 of file corbacontext.h.

const Config OSB_CORBA::CorbaContext::configDefaults

Default configuration.

Definition at line 155 of file corbacontext.h.

OSB_APP::FileLockLog OSB_CORBA::CorbaContext::logger_

Logging interface to use.

Definition at line 108 of file corbacontext.h.

Referenced by CorbaContext().

OSB_LIB::ModuleId OSB_CORBA::CorbaContext::module_

Module of context.

Definition at line 179 of file corbacontext.h.

OSB_LIB::MsgCat::Init OSB_CORBA::CorbaContext::msgCatInit_

Error text manager.

Definition at line 92 of file corbacontext.h.

Option OSB_CORBA::CorbaContext::option

Command line args.

Definition at line 174 of file corbacontext.h.

OSB_DB::SessionCtrl OSB_CORBA::CorbaContext::sessionCtrl_

Database session.

Definition at line 90 of file corbacontext.h.

---

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

• corbacontext.h

---