Class Ens.Enterprise.MsgBank.TCPService

class Ens.Enterprise.MsgBank.TCPService extends Ens.BusinessService, Ens.Util.XML.Reader

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	8	6

Summary

This is a Business Service class.

The associated Adapter class is Ens.Enterprise.MsgBank.BankTCPAdapter.

Properties
%AlertStartTime	%ConfigName	%ConfigQueueName
%LastActionTime	%LastHandledTime	%LastReportedError
%NodeId	%OutsideCreated	%PreserveSession
%ProcessInputCalled	%QuitTask	%RequestHeader
%SearchTableMap	%SessionId	%SuperSession
%SuperSessionCreatedBeforeSession	%Version	%WaitForNextCallInterval
%WarnedLatest	%isShadow	Adapter
AlertGracePeriod	AlertGroups	AlertOnError
ArchiveIO	BankHelperClass	BusinessPartner
GenerateSuperSessionID	IOLogEntry	IgnoreIPChanges
InactivityTimeout	ThrottleDelay

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OnClose	%OnNew
%OriginalNamespace	%PackageName	%RemoveFromSaveSet	%SerializeObject
%SetModified	%SuperSessionSet	%ValidateObject	AdapterName
AssignOneSetting	ChangeXMLEncoding	ChangeXMLStreamEncoding	CloseIOLogEntry
EnumerateSettingsClose	EnumerateSettingsExecute	EnumerateSettingsFetch	ForceSessionId
GenerateSuperSession	GetDeferredResponseToken	GetMsgHdrRequestKey	GetProductionSettingValue
GetProductionSettings	GetPropertyConnections	GetSettings	GetShadowInstance
NewIOLogEntry	ObjectFromFile	ObjectFromStream	ObjectFromString
ObjectFromXData	ObjectsFromFile	ObjectsFromStream	ObjectsFromString
ObjectsFromXData	OnConnect	OnError	OnGenerateSuperSession
OnGetConnections	OnInit	OnKeepalive	OnMonitor
OnProcessInput	OnProductionStart	OnProductionStop	OnTearDown
PopulateSuperSession	QueueName	SaveIOLogEntry	SendAlert
SendDeferredResponse	SendRequestAsync	SendRequestSync	copyPart

Parameters

• parameter ADAPTER = "Ens.Enterprise.MsgBank.BankTCPAdapter";

The type of adapter used to communicate with external systems

• parameter SETTINGS = "IgnoreIPChanges:Connection,BankHelperClass";

List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property %NodeId as %Integer;

Our local server id for the node we are talking to

• property %SearchTableMap [ MultiDimensional ];

Cached map from SearchTable class to table name

• property %Version as %String;

The version of the archive protocol we negotiated

• property BankHelperClass as %String(MAXLEN=100);

The name of a class that functions as a helper to process messages when requests are received that include a message body. For each incoming message header, the service will call the OnBankMsg classmethod in the helper class with the following arguments:
pHeader - the Ens.Enterprise.MsgBank.MessageHeader object being banked,

pFullHeaderID - the full ID of the header,

pBody - the message body object being banked,

pFullBodyID - the full ID of the message body, and

pService - the Ens.Enterprise.MsgBank.TCPService instance.
See the Ens.Enterprise.MsgBank.BankHelperClass for more details on the interface.

• property IgnoreIPChanges as %Boolean [ InitialExpression = 0 ];

Ignore Client IP Changes
For clients that are:
not members of an InterSystems IRIS mirror and

might have different IP addresses after a restart and

it is not possible to specify the interface to connect to this service on so that it is the same IP each time

Enabling this setting prevents the Message Bank Service treating the change in client IP as a new node if the node name is found and the message header IDs follow the last connection.
This setting will apply to all clients that connect to this service that are not Mirror members.
It is important to note that with this setting enabled the Message Bank Service may not be able to detect a different client.
It is possible to have multiple Message Bank Services on different ports if this setting ought not to apply to all clients.
The default setting is off.

Methods

• method OnConnect(pTimeout) as %Status

The Adapter invokes the OnConnect() method to manage initialization of the connection

• method OnProcessInput(pInput As %Stream.GlobalBinary, Output pOutput As %RegisteredObject) as %Status

Override this method to process incoming data. Do not call SendRequestSync/Async() from outside this method (e.g. in a SOAP Service or a CSP page).

• method OnTearDown() as %Status

This user callback method is called from %OnClose()

• classmethod copyPart(target, source, pSize) as %Status

Class Reference IRIS for UNIX 2024.1.2
Documentation Search