CA_Get_System_State()

Purpose

Query the state of Blueworx Voice Response and its access to resources (DB2 and NFS) used by Blueworx Voice Response.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
extern CA_SYSTEM_STATE_ENUM    CA_Get_System_State (void);

Description

This subroutine returns an enumerated type indicating the state of Blueworx Voice Response:

CA_RUN
Blueworx Voice Response is running normally.
CA_INITIALIZE and CA_LOAD
The custom server should wait for CA_RUN to be returned before using any other Custom Server library calls.
CA_QUIESCE_SHUTDOWN
Blueworx Voice Response is shutting down.

If CA_QUIESCE_SHUTDOWN is returned and the custom server is interacting with a phone call it can proceed as normal. A call in progress will not be terminated by the shutdown. Blueworx Voice Response will not allow any new calls to be started.

The system administrator can initiate this state by selecting Quiesce Shutdown... from the Blueworx Voice Response Operations menu.

CA_SHUTDOWN
Blueworx Voice Response is shutting down immediately, all calls in progress are terminated and no new calls are accepted. If CA_SHUTDOWN is returned and the custom server is interacting with a phone call it will not proceed normally.

The system administrator can initiate this state by selecting Immediate Shutdown... from the Blueworx Voice Response Operations menu.

CA_RUN_NODB and CA_QUIESCE_NODB
These enumerations indicate that DBHEALTH (a Blueworx Voice Response process that monitors DB2 and filesystems containing voice and customer applications) has detected that Blueworx Voice Response has lost access to resources (DB2 or filesystems under $CUR_DIR) which are used for normal operation.

CA_QUIESCE_NODB indicates that Blueworx Voice Response is quiescing but there is a problem with a resource.

Check the error log to find out which resource has a problem.

Parameters

None.

Return codes

CA_LOAD
CA_INITIALIZE
CA_RUN
CA_QUIESCE_SHUTDOWN
CA_SHUTDOWN
CA_RUN_NODB = 8
CA_QUIESCE_NODB

Error Names

None.

Related Information

None.