IP Media Gateway (IPML) Demo Guide: 5.2.3 Configuration Class

5.2.3 Configuration Class

The Configuration class' main role is to provide an interface to get the needed configuration data. It contains all the needed data structures to parse and save the system configuration (the configuration file and the command line options) and reflects the system configuration to the other classes.

The Configuration class attributes are described in Table 8. Refer to the source code for method information.

Table 8. Configuration Class Attributes

Name

Access Privilege

Type

Description

m_pstnProtocol public char PSTN protocol to be used, read from the configuration file and updated during initialization. It is not changed until demo termination. It is accessed while opening the PSTN Board and Digital PSTN devices.

m_remoteHostPortInfo public IPM_PORT_INFO Structure that contains the remote host IP address and port, read from the configuration file and updated during initialization. It is not changed until demo termination. It is accessed while sending IP messages to the remote gateway.

m_localHostPortInfo public IPM_PORT_INFO Structure that contains the local host port, read from the configuration file and updated during initialization. It is not changed until demo termination. It is accessed while initializing the server.

m_logFArr public char Log level that the logs will be printed with, read whenever something is printed to the log. It is updated by command line option during initialization or by the user request when pressing the d or D key during run time. The log level is the same for all log objects.

m_firstCallId public long The lowest CallId (IP call control identifier) number allowed, read from the configuration file during initialization. It is not changed until demo termination. The Call IDs range must be different at the two gateways.

m_lastCallId public long The highest CallId (IP call control identifier) number allowed.

m_QoSFlag public int If the QoS feature is enabled by the -q command line option, it is read from the configuration file during initialization and not changed until demo termination. It is accessed before calling any QoS function to check if that function should be called.

m_stage private unsigned char The stage of parsing the configuration file

m_line private int The line in the configuration file currently being parsed

m_firstSession private long Used to fill the channel information from the configuration file

m_lastSession private long Used to fill the channel information from the configuration file

m_cfgFile private char* The configuration file name

m_logFileFlag private int Flag for using log files, one for each channel (by the -l command line option)

m_userChannels public unsigned int Indicates the number of channels that the demo will work with. Updated after reading the -n command line option and remains unchanged until demo termination.

m_DigitMaps private int [MAX_DIGIT_MAPS] Array of "digit maps" to collect DTMFs in order to send them over the IP. The digit map includes only number of digits for each loop.

m_DigitMapNum private int Current digit map read

m_chanInfo public ChannelInfo[ ] Array that contains all the channel information from the configuration file, such as Tx coder information, the print to log file flag, and the phone number to call. It is updated while getting data from the configuration file.

**Table 8. Configuration Class Attributes**
Name	Access Privilege	Type	Description
m_pstnProtocol	public	char	PSTN protocol to be used, read from the configuration file and updated during initialization. It is not changed until demo termination. It is accessed while opening the PSTN Board and Digital PSTN devices.
m_remoteHostPortInfo	public	IPM_PORT_INFO	Structure that contains the remote host IP address and port, read from the configuration file and updated during initialization. It is not changed until demo termination. It is accessed while sending IP messages to the remote gateway.
m_localHostPortInfo	public	IPM_PORT_INFO	Structure that contains the local host port, read from the configuration file and updated during initialization. It is not changed until demo termination. It is accessed while initializing the server.
m_logFArr	public	char	Log level that the logs will be printed with, read whenever something is printed to the log. It is updated by command line option during initialization or by the user request when pressing the d or D key during run time. The log level is the same for all log objects.
m_firstCallId	public	long	The lowest CallId (IP call control identifier) number allowed, read from the configuration file during initialization. It is not changed until demo termination. The Call IDs range must be different at the two gateways.
m_lastCallId	public	long	The highest CallId (IP call control identifier) number allowed.
m_QoSFlag	public	int	If the QoS feature is enabled by the -q command line option, it is read from the configuration file during initialization and not changed until demo termination. It is accessed before calling any QoS function to check if that function should be called.
m_stage	private	unsigned char	The stage of parsing the configuration file
m_line	private	int	The line in the configuration file currently being parsed
m_firstSession	private	long	Used to fill the channel information from the configuration file
m_lastSession	private	long	Used to fill the channel information from the configuration file
m_cfgFile	private	char*	The configuration file name
m_logFileFlag	private	int	Flag for using log files, one for each channel (by the -l command line option)
m_userChannels	public	unsigned int	Indicates the number of channels that the demo will work with. Updated after reading the -n command line option and remains unchanged until demo termination.
m_DigitMaps	private	int [MAX_DIGIT_MAPS]	Array of "digit maps" to collect DTMFs in order to send them over the IP. The digit map includes only number of digits for each loop.
m_DigitMapNum	private	int	Current digit map read
m_chanInfo	public	ChannelInfo[ ]	Array that contains all the channel information from the configuration file, such as Tx coder information, the print to log file flag, and the phone number to call. It is updated while getting data from the configuration file.

Click here to contact Telecom Support Resources