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 > ENSLIB namespace > Ens.Enterprise.MsgBank.Handshake


class Ens.Enterprise.MsgBank.Handshake extends %Library.RegisteredObject, %XML.Adaptor

Handshake message for initializing a connection to the archive server - goes both ways

Property Inventory (Including Private)


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.
parameter XMLNAME = SHAKE;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties (Including Private)

property CurrEvtId as %Integer (XMLPROJECTION = "ATTRIBUTE");
The current top Id on the client of Ens.Util.Log (the Event Log)
Property methods: CurrEvtIdDisplayToLogical(), CurrEvtIdGet(), CurrEvtIdIsValid(), CurrEvtIdLogicalToDisplay(), CurrEvtIdNormalize(), CurrEvtIdSet(), CurrEvtIdXSDToLogical()
property CurrHdrId as %Integer (XMLPROJECTION = "ATTRIBUTE");
The current top Id on the client of Ens.MessageHeader
Property methods: CurrHdrIdDisplayToLogical(), CurrHdrIdGet(), CurrHdrIdIsValid(), CurrHdrIdLogicalToDisplay(), CurrHdrIdNormalize(), CurrHdrIdSet(), CurrHdrIdXSDToLogical()
property IPAddress as %String);
The node's IP Address and port
Property methods: IPAddressDisplayToLogical(), IPAddressGet(), IPAddressIsValid(), IPAddressLogicalToDisplay(), IPAddressLogicalToOdbc(), IPAddressNormalize(), IPAddressSet()
property LastEvtId as %Integer (XMLPROJECTION = "ATTRIBUTE");
The top Id on the client of Ens.Util.Log (the Event Log) that we archived
Property methods: LastEvtIdDisplayToLogical(), LastEvtIdGet(), LastEvtIdIsValid(), LastEvtIdLogicalToDisplay(), LastEvtIdNormalize(), LastEvtIdSet(), LastEvtIdXSDToLogical()
property LastHdrId as %Integer (XMLPROJECTION = "ATTRIBUTE");
The top Id on the client of Ens.MsgHeader that we archived
Property methods: LastHdrIdDisplayToLogical(), LastHdrIdGet(), LastHdrIdIsValid(), LastHdrIdLogicalToDisplay(), LastHdrIdNormalize(), LastHdrIdSet(), LastHdrIdXSDToLogical()
property MirrorName as %String (XMLPROJECTION = "ATTRIBUTE");
If not empty then this is a mirrored instance
Property methods: MirrorNameDisplayToLogical(), MirrorNameGet(), MirrorNameIsValid(), MirrorNameLogicalToDisplay(), MirrorNameLogicalToOdbc(), MirrorNameNormalize(), MirrorNameSet()
property Node as %String);
The node the Client remembers / the node the Server prescribes
Property methods: NodeDisplayToLogical(), NodeGet(), NodeIsValid(), NodeLogicalToDisplay(), NodeLogicalToOdbc(), NodeNormalize(), NodeSet()
property RawNode as %String);
The node the Client would be if starting fresh
Property methods: RawNodeDisplayToLogical(), RawNodeGet(), RawNodeIsValid(), RawNodeLogicalToDisplay(), RawNodeLogicalToOdbc(), RawNodeNormalize(), RawNodeSet()
property Version as %String (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = "1.0" ];
The archive protocol version(s) the client proposes / the Server accepts
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()
property WebServer as %String);
The node's webserver IP Address, port, and URL root
Property methods: WebServerDisplayToLogical(), WebServerGet(), WebServerIsValid(), WebServerLogicalToDisplay(), WebServerLogicalToOdbc(), WebServerNormalize(), WebServerSet()

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window