Application Summary

Application Summary

This method returns a summary of the applications currently executing within the n2svcd instance. This interaction is slower than the simple Application List because the ManageApp needs to send a !MANAGEMENT-SUMMARY-REQUEST message to the application(s) and wait for the corresponding !MANAGEMENT-SUMMARY-RESPONSE message(s).

The caller can request that this be performed for all applications, or for a single named application.

HTTP Request

Special characters in the (such as :) must be URI percent-encoded.

HTTP Response

In failure, the response is a non-200 HTTP Status, with an optional text/plain Content describing the reason for failure.

In success, the HTTP Response content is a text/json representation of the system status and application list.

The JSON Object has the following structure:

Attribute Type Description
admin 0/1 [Required] Does this connection have access to update fields, and query protected fields.
config_file String [Required] The n2svcd.xml configuration file as specified at startup time.
multi 0/1 [Required] This this n2svcd install running in multi-process mode with shared-memory IPC communication?
shm_path String When running in multi-process mode, this is the path of the shared memory area.
Two n2svcd instancess running on the same platform must use different shared memory paths.
apps Array [Required] Array of applications running within this n2svcd instance.
.idx Integer [Required] The unique index number of this application.
.name Integer [Required] The unique name of this application.
.pid Integer The process ID of this application.
Present only when running in multi-process mode.
.admin_alloc Integer Size (bytes) of application's inbound administration (priority) IPC message buffer.
Present only when running in multi-process mode.
.admin_used Integer Size (bytes) of as-yet-unread messages waiting in the administration IPC message buffer.
Present only when running in multi-process mode.
.user_alloc Integer Size (bytes) of application's inbound user (non-priority) IPC message buffer.
Present only when running in multi-process mode.
.user_used Integer Size (bytes) of as-yet-unread messages waiting in the user IPC message buffer.
Present only when running in multi-process mode.
.status 0-8 The availability status of this application. Refer to the list in the Application Configuration section.
.status_name String The human-readable label corresponding to the status level. Refer to the list in the Application Configuration section.
.shutdown_level 0/1/2 [Required] The application's current shutdown level 0 = None, 1 = Pending, 2 = Shutdown.
.configuration Object Container for scalar and vector configuration values on this application.
See configuration attribute in !MANAGEMENT-SUMMARY-RESPONSE internal message documentation.
.resource Array Container for scalar and vector resource values on this application.
See resource attribute in !MANAGEMENT-SUMMARY-RESPONSE internal message documentation.
.statistics Array An Array of Objects representing current application Statistics counters.
See statistics attribute in !MANAGEMENT-SUMMARY-RESPONSE internal message documentation.
.poll_stats Object A container for timing information regarding recent polling/work-loop timing.
See poll_stats attribute in !MANAGEMENT-SUMMARY-RESPONSE internal message documentation.