Class Ens.Enterprise.MsgBank.Node

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

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

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	17	17		2

Summary

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

Methods
%%CLASSNAMELogicalToStorage	%%CLASSNAMEStorageToLogical	%AddToSaveSet	%AddToSyncSet
%BMEBuilt	%BuildIndicesAsync	%BuildIndicesAsyncResponse	%CheckConstraints
%CheckConstraintsForExtent	%ClassIsLatestVersion	%ClassName	%ComposeOid
%ConstructClone	%Delete	%DeleteExtent	%DeleteId
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Exists
%ExistsId	%Extends	%GUID	%GUIDSet
%GetLock	%GetParameter	%GetSwizzleObject	%Id
%InsertBatch	%IsA	%IsModified	%IsNull
%KillExtent	%KillExtentData	%LoadFromMemory	%LockExtent
%LockId	%New	%NormalizeObject	%ObjectIsNull
%ObjectModified	%Oid	%OnAfterDelete	%OnBeforeAddToSync
%OnDeleteFinally	%OnDetermineClass	%OnOpenFinally	%OnSaveFinally
%Open	%OpenId	%OriginalNamespace	%PackageName
%PhysicalAddress	%PurgeIndices	%Reload	%RemoveFromSaveSet
%ResolveConcurrencyConflict	%RollBack	%Save	%SaveDirect
%SaveIndices	%SerializeObject	%SetModified	%SortBegin
%SortEnd	%SyncObjectIn	%SyncTransport	%UnlockExtent
%UnlockId	%ValidateIndices	%ValidateObject	%ValidateTable
DeleteNodes	GetNodeName	GetWebIPAddrPort

Properties

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

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

• property ID as %Integer(MAXVAL=999,MINVAL=100);

3 digit internal node key number

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

The IP Address portion of the IPAddress

• property IPAddress as %String(MAXLEN="");

The node's IP Address and port

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

Instance name of the node

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

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

• property Machine as %String(MAXLEN="") [ Calculated,Transient,ReadOnly ];

Machine name of the node

• property Name as %String(MAXLEN="") [ Required ];

composite Node name

• property Namespace as %String [ Calculated,ReadOnly ];

Namespace of the node

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

The Port portion of the IPAddress

• property TimeConnected as Ens.DataType.UTC;

The last time a Handshake was accepted from a client node

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

• property TimeUpdated as Ens.DataType.UTC;

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

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

The IP Address portion of the WebServer

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

The Port portion of the WebServer

• property WebServer as %String(MAXLEN="");

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

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

The URL Root portion of the WebServer

Methods

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

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

Indices

•index (ID on ID) [IdKey];

•index (Name on Name) [Unique];

Class Reference IRIS for UNIX 2024.1.2
Documentation Search