Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [InboundAdapter]
Private  Storage   

class Ens.InboundAdapter extends Ens.Adapter

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 2 1


Summary

Properties
%CredentialsObj %WarnedLatest BusinessHost CallInterval
Credentials KeepaliveInterval RegistryID

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AssignOneSetting ClearAllAppData ClearRuntimeAppData ClearStaticAppData
CredentialsSet EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch
GetSettings OnInit OnKeepalive OnTask
OnTearDown

Subclasses
EnsLib.DotNetGateway.ServiceAdapter EnsLib.EMail.InboundAdapter EnsLib.File.InboundAdapter
EnsLib.JavaGateway.InboundAdapter EnsLib.JavaGateway.ServiceAdapter EnsLib.MFT.Adapter.Inbound
EnsLib.MQSeries.InboundAdapter EnsLib.PEX.InboundAdapter EnsLib.Pipe.InboundAdapter
EnsLib.SQL.InboundAdapter EnsLib.TCP.DuplexAdapter EnsLib.TCP.InboundAdapter
EnsLib.UDP.InboundAdapter

Parameters

• parameter SERVICEINPUTCLASS = "%RegisteredObject";
• parameter SERVICEOUTPUTCLASS = "%RegisteredObject";
• parameter SETTINGS = "CallInterval:Basic";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property BusinessHost as Ens.BusinessService;
• property CallInterval as %Numeric(MINVAL="0.1") [ InitialExpression = 5 ];
The minimum interval between invocations of the adapter by the InterSystems IRIS framework. For adapters that poll for external events, this is the polling interval. However, most polling adapters will process all inputs immediately if several are detected at one time. This is also the interval at which each Business Service will check for shutdown requests.

Methods

• method OnTask() as %Status
default InboundAdapter behavior: always call ProcessInput on CallInterval


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.