This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %CSP.Mgr.Helper.CacheServer

%CSP.Mgr.Helper.CacheServer

serial class %CSP.Mgr.Helper.CacheServer extends %Library.SerialObject, %XML.Adaptor


This object is part of the %CSP.Mgr.GatewaySystemStatus object.

Property Inventory (Including Private)

Parameters

parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties (Including Private)

property Activity as %String;
Total number of transactions (hits) the Caché system has processed.
Property methods: ActivityDisplayToLogical(), ActivityGet(), ActivityIsValid(), ActivityLogicalToDisplay(), ActivityLogicalToOdbc(), ActivityNormalize(), ActivitySet()
property CacheServerName as %String;
Name of the Caché system connected to.
Property methods: CacheServerNameDisplayToLogical(), CacheServerNameGet(), CacheServerNameIsValid(), CacheServerNameLogicalToDisplay(), CacheServerNameLogicalToOdbc(), CacheServerNameNormalize(), CacheServerNameSet()
property ConnectionsInUse as %Integer;
Number of connections that are currently in use (actively serving a Web request).
Property methods: ConnectionsInUseDisplayToLogical(), ConnectionsInUseGet(), ConnectionsInUseIsValid(), ConnectionsInUseLogicalToDisplay(), ConnectionsInUseNormalize(), ConnectionsInUseSet(), ConnectionsInUseXSDToLogical()
property IPAddress as %String;
IP address of the Caché system.
Property methods: IPAddressDisplayToLogical(), IPAddressGet(), IPAddressIsValid(), IPAddressLogicalToDisplay(), IPAddressLogicalToOdbc(), IPAddressNormalize(), IPAddressSet()
property MirrorMember as %String;
Name of the Caché Mirror Member connected to.
Property methods: MirrorMemberDisplayToLogical(), MirrorMemberGet(), MirrorMemberIsValid(), MirrorMemberLogicalToDisplay(), MirrorMemberLogicalToOdbc(), MirrorMemberNormalize(), MirrorMemberSet()
property MirrorStatus as %String;
Status of the Caché Mirror Member connected to.
Property methods: MirrorStatusDisplayToLogical(), MirrorStatusGet(), MirrorStatusIsValid(), MirrorStatusLogicalToDisplay(), MirrorStatusLogicalToOdbc(), MirrorStatusNormalize(), MirrorStatusSet()
property PrivateConnections as %Integer;
Number of connections that are currently in use as state-aware sessions (preserve mode 1).
Property methods: PrivateConnectionsDisplayToLogical(), PrivateConnectionsGet(), PrivateConnectionsIsValid(), PrivateConnectionsLogicalToDisplay(), PrivateConnectionsNormalize(), PrivateConnectionsSet(), PrivateConnectionsXSDToLogical()
property QueuedRequests as %Integer;
Number of Web requests that are held in a queue waiting for a free connection to the Caché syste. Queued requests are an indication that the Caché license should be increased in order to maintain good performance.
Property methods: QueuedRequestsDisplayToLogical(), QueuedRequestsGet(), QueuedRequestsIsValid(), QueuedRequestsLogicalToDisplay(), QueuedRequestsNormalize(), QueuedRequestsSet(), QueuedRequestsXSDToLogical()
property TCPPort as %String;
TCP port on the Caché server through which the connectin communicates.
Property methods: TCPPortDisplayToLogical(), TCPPortGet(), TCPPortIsValid(), TCPPortLogicalToDisplay(), TCPPortLogicalToOdbc(), TCPPortNormalize(), TCPPortSet()
property TotalConnections as %Integer;
Number of connections to the Caché syste.
Property methods: TotalConnectionsDisplayToLogical(), TotalConnectionsGet(), TotalConnectionsIsValid(), TotalConnectionsLogicalToDisplay(), TotalConnectionsNormalize(), TotalConnectionsSet(), TotalConnectionsXSDToLogical()

Inherited Members

Inherited Methods (Including Private)