Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

Ens.Enterprise.MsgBank.TCPService

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

Property Inventory

Method Inventory

Parameters

parameter ADAPTER = Ens.Enterprise.MsgBank.BankTCPAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter SETTINGS = IgnoreIPChanges:Connection,BankHelperClass;
Inherited description: 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 methods: %NodeIdDisplayToLogical(), %NodeIdGet(), %NodeIdIsValid(), %NodeIdLogicalToDisplay(), %NodeIdNormalize(), %NodeIdSet()
property %SearchTableMap [ MultiDimensional ];
Cached map from SearchTable class to table name
Property methods: %SearchTableMapDisplayToLogical(), %SearchTableMapGet(), %SearchTableMapIsValid(), %SearchTableMapLogicalToDisplay(), %SearchTableMapLogicalToOdbc(), %SearchTableMapNormalize(), %SearchTableMapSet()
property %Version as %String;
The version of the archive protocol we negotiated
Property methods: %VersionDisplayToLogical(), %VersionGet(), %VersionIsValid(), %VersionLogicalToDisplay(), %VersionLogicalToOdbc(), %VersionNormalize(), %VersionSet()
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: See the Ens.Enterprise.MsgBank.BankHelperClass for more details on the interface.
Property methods: BankHelperClassDisplayToLogical(), BankHelperClassGet(), BankHelperClassIsValid(), BankHelperClassLogicalToDisplay(), BankHelperClassLogicalToOdbc(), BankHelperClassNormalize(), BankHelperClassSet()
property IgnoreIPChanges as %Boolean [ InitialExpression = 0 ];
Ignore Client IP Changes

For clients that are:

  • not members of an Ensemble 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 Ensemble 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.

    Property methods: IgnoreIPChangesDisplayToLogical(), IgnoreIPChangesGet(), IgnoreIPChangesIsValid(), IgnoreIPChangesLogicalToDisplay(), IgnoreIPChangesNormalize(), IgnoreIPChangesSet()

    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 %Library.RegisteredObject, ByRef pHint As %Library.String) as %Status
    Inherited description: 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

    Inherited Members

    Inherited Properties

    Inherited Methods

    FeedbackOpens in a new tab