Class EnsLib.Pipe.InboundAdapter

class EnsLib.Pipe.InboundAdapter extends Ens.InboundAdapter, Ens.Util.Pipe

An Ensemble adapter wrapping up pipe functionality

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	4	1

Summary

Properties
%CredentialsObj	%WarnedLatest	BusinessHost	CallInterval
Charset	CommandLine	Credentials	KeepaliveInterval
PipeMode	RegistryID	Timer

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	CheckTimer	ClearAllAppData	ClearRuntimeAppData
ClearStaticAppData	CredentialsSet	EnumerateSettingsClose	EnumerateSettingsExecute
EnumerateSettingsFetch	GetSettings	OnInit	OnKeepalive
OnTask	OnTearDown	RunCommand

Parameters

• parameter SERVICEINPUTCLASS = "%Stream.Object";

• parameter SETTINGS = "CommandLine,Timer,Charset::selector?context={Ens.ContextSearch/CharacterSets},PipeMode";

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

Properties

• property Charset as %String [ InitialExpression = "Native" ];

Character encoding scheme used to translate output to the file. For no encoding, use 'Binary'. Other choices include:
Native - the default character encoding of the installed locale of the InterSystems IRIS server
latin1 - the ISO Latin1 8-bit encoding
ISO-8859-1 - the ISO Latin1 8-bit encoding
UTF-8 - the Unicode 8-bit encoding
Unicode - the Unicode 16-bit encoding (Little-Endian)
UnicodeBig - the Unicode 16-bit encoding (Big-Endian)
@<ttable> - <ttable> means a raw InterSystems character translation table name. A prefix of '@' means to use the named table.

• property CommandLine as %String(MAXLEN=2048);

• property PipeMode as %String [ InitialExpression = "WR" ];

• property Timer as %String;

Methods

• method OnTask() as %Status

default InboundAdapter behavior: always call ProcessInput on CallInterval


[USER] > [EnsLib] > [Pipe] > [InboundAdapter]		Private Storage