Ens.Enterprise.MsgBank.Node

persistent class Ens.Enterprise.MsgBank.Node extends %Library.Persistent

SQL Table Name: Ens_Enterprise_MsgBank.Node

A class representing each client node the Message Bank Server knows about

Property Inventory

Clone
ID
IPAddr
IPAddress
Instance
Iteration
Machine
Name
Namespace
Port
TimeConnected
TimeCreated
TimeUpdated
WebIPAddr
WebPort
WebServer
WebURLRoot

Properties

property Clone as %String [ Calculated , Transient , ReadOnly ];

Alphabet character to distingush multiple nodes connected simultaneously from different IP Adddresses

Property methods: CloneCompute(), CloneDisplayToLogical(), CloneIsValid(), CloneLogicalToDisplay(), CloneLogicalToOdbc(), CloneNormalize(), CloneSQLCompute()

property ID as %Integer (MAXVAL = 999, MINVAL = 100) [ Required ];

3 digit internal node key number

Property methods: IDDisplayToLogical(), IDGet(), IDGetStored(), IDIsValid(), IDLogicalToDisplay(), IDNormalize(), IDSet()

property IPAddr as %String [ Calculated , Transient , ReadOnly ];

The IP Address portion of the IPAddress

Property methods: IPAddrCompute(), IPAddrDisplayToLogical(), IPAddrIsValid(), IPAddrLogicalToDisplay(), IPAddrLogicalToOdbc(), IPAddrNormalize(), IPAddrSQLCompute()

property IPAddress as %String);

The node's IP Address and port

Property methods: IPAddressDisplayToLogical(), IPAddressGet(), IPAddressGetStored(), IPAddressIsValid(), IPAddressLogicalToDisplay(), IPAddressLogicalToOdbc(), IPAddressNormalize(), IPAddressSet()

property Instance as %String [ Calculated , Transient , ReadOnly ];

Instance name of the node

Property methods: InstanceCompute(), InstanceDisplayToLogical(), InstanceIsValid(), InstanceLogicalToDisplay(), InstanceLogicalToOdbc(), InstanceNormalize(), InstanceSQLCompute()

property Iteration as %String [ Calculated , Transient , ReadOnly ];

Number of times the MessageHeader ID counter has been reset on the node

Property methods: IterationCompute(), IterationDisplayToLogical(), IterationIsValid(), IterationLogicalToDisplay(), IterationLogicalToOdbc(), IterationNormalize(), IterationSQLCompute()

property Machine as %String) [ Calculated , Transient , ReadOnly ];

Machine name of the node

Property methods: MachineCompute(), MachineDisplayToLogical(), MachineIsValid(), MachineLogicalToDisplay(), MachineLogicalToOdbc(), MachineNormalize(), MachineSQLCompute()

property Name as %String) [ Required ];

composite Node name

Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

property Namespace as %String [ Calculated , ReadOnly ];

Namespace of the node

Property methods: NamespaceCompute(), NamespaceDisplayToLogical(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSQLCompute()

property Port as %Integer [ Calculated , Transient , ReadOnly ];

The Port portion of the IPAddress

Property methods: PortCompute(), PortDisplayToLogical(), PortIsValid(), PortLogicalToDisplay(), PortNormalize(), PortSQLCompute()

property TimeConnected as Ens.DataType.UTC;

The last time a Handshake was accepted from a client node

Property methods: TimeConnectedDisplayToLogical(), TimeConnectedGet(), TimeConnectedGetStored(), TimeConnectedIsValid(), TimeConnectedLogicalToDisplay(), TimeConnectedLogicalToOdbc(), TimeConnectedNormalize(), TimeConnectedOdbcToLogical(), TimeConnectedSet(), TimeConnectedStorageToLogical(), TimeConnectedtimeCmp(), TimeConnectedtimeDiff(), TimeConnectedtimeLocal(), TimeConnectedtimeLocaltoUTC(), TimeConnectedtimeUTC(), TimeConnectedtimeUTCH(), TimeConnectedtimeUTCHtoUTC(), TimeConnectedtimeUTCtoLocal(), TimeConnectedtimeUTCtoUTCH()

property TimeCreated as Ens.DataType.UTC [ InitialExpression = $$$timeUTC ];

Property methods: TimeCreatedDisplayToLogical(), TimeCreatedGet(), TimeCreatedGetStored(), TimeCreatedIsValid(), TimeCreatedLogicalToDisplay(), TimeCreatedLogicalToOdbc(), TimeCreatedNormalize(), TimeCreatedOdbcToLogical(), TimeCreatedSet(), TimeCreatedStorageToLogical(), TimeCreatedtimeCmp(), TimeCreatedtimeDiff(), TimeCreatedtimeLocal(), TimeCreatedtimeLocaltoUTC(), TimeCreatedtimeUTC(), TimeCreatedtimeUTCH(), TimeCreatedtimeUTCHtoUTC(), TimeCreatedtimeUTCtoLocal(), TimeCreatedtimeUTCtoUTCH()

property TimeUpdated as Ens.DataType.UTC;

The last time a change was stored to the IP and Port values

Property methods: TimeUpdatedDisplayToLogical(), TimeUpdatedGet(), TimeUpdatedGetStored(), TimeUpdatedIsValid(), TimeUpdatedLogicalToDisplay(), TimeUpdatedLogicalToOdbc(), TimeUpdatedNormalize(), TimeUpdatedOdbcToLogical(), TimeUpdatedSet(), TimeUpdatedStorageToLogical(), TimeUpdatedtimeCmp(), TimeUpdatedtimeDiff(), TimeUpdatedtimeLocal(), TimeUpdatedtimeLocaltoUTC(), TimeUpdatedtimeUTC(), TimeUpdatedtimeUTCH(), TimeUpdatedtimeUTCHtoUTC(), TimeUpdatedtimeUTCtoLocal(), TimeUpdatedtimeUTCtoUTCH()

property WebIPAddr as %String [ Calculated , Transient , ReadOnly ];

The IP Address portion of the WebServer

Property methods: WebIPAddrCompute(), WebIPAddrDisplayToLogical(), WebIPAddrIsValid(), WebIPAddrLogicalToDisplay(), WebIPAddrLogicalToOdbc(), WebIPAddrNormalize(), WebIPAddrSQLCompute()

property WebPort as %Integer [ Calculated , Transient , ReadOnly ];

The Port portion of the WebServer

Property methods: WebPortCompute(), WebPortDisplayToLogical(), WebPortIsValid(), WebPortLogicalToDisplay(), WebPortNormalize(), WebPortSQLCompute()

property WebServer as %String);

The node's webserver IP Address, port, and URL root

Property methods: WebServerDisplayToLogical(), WebServerGet(), WebServerGetStored(), WebServerIsValid(), WebServerLogicalToDisplay(), WebServerLogicalToOdbc(), WebServerNormalize(), WebServerSet()

property WebURLRoot as %String [ Calculated , Transient , ReadOnly ];

The URL Root portion of the WebServer

Property methods: WebURLRootCompute(), WebURLRootDisplayToLogical(), WebURLRootIsValid(), WebURLRootLogicalToDisplay(), WebURLRootLogicalToOdbc(), WebURLRootNormalize(), WebURLRootSQLCompute()

Methods

classmethod %OnAfterDelete(oid As %ObjectIdentity) as %Status

Inherited description: This callback method is invoked by the %Delete() method to provide notification that the object specified by oid has been deleted. The callback occurs immediately after %DeleteData has been called. If %DeleteData returns an error then %OnAfterDelete is not called.

If %OnAfterDelete returns an error (%Status) then the transaction is rolled back.

classmethod DeleteNodes(pUnusedOnly As %Boolean = 1, Output pNumDeleted As %Integer) as %Status

classmethod GetNodeName(pNodeId As %Integer) as %String

method GetWebIPAddrPort() as %String

Return whatever IP address and port we can glean from all the properties

Indexes

index (ID on ID) [IdKey, Type = key];

Index methods: IDCheck(), IDDelete(), IDDisplayToLogical(), IDExists(), IDGet(), IDGetStored(), IDIsValid(), IDLogicalToDisplay(), IDNormalize(), IDOpen(), IDSQLCheckUnique(), IDSQLExists(), IDSQLFindPKeyByConstraint(), IDSQLFindRowIDByConstraint(), IDSet()

index (Name on Name) [Unique];

Index methods: NameCheck(), NameCheckUnique(), NameDelete(), NameDisplayToLogical(), NameExists(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameOpen(), NameSQLCheckUnique(), NameSQLExists(), NameSQLFindPKeyByConstraint(), NameSQLFindRowIDByConstraint(), NameSet(), NamespaceCompute(), NamespaceDisplayToLogical(), NamespaceGet(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize(), NamespaceSQLCompute()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (Ens.Enterprise.MsgBank.Node)

^Ens.EntMsgBank.NodeD(ID)

%%CLASSNAME

Name

TimeCreated

TimeUpdated

TimeConnected

IPAddress

WebServer