This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


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

An Ensemble adapter wrapping up pipe functionality

Property Inventory

Method Inventory


parameter SERVICEINPUTCLASS = %Stream.Object;
parameter SETTINGS = CommandLine,Timer,Charset::selector?context={Ens.ContextSearch/CharacterSets},PipeMode;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


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 Ensemble 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 methods: CharsetDisplayToLogical(), CharsetGet(), CharsetIsValid(), CharsetLogicalToDisplay(), CharsetLogicalToOdbc(), CharsetNormalize(), CharsetSet()
property CommandLine as %String (MAXLEN = 2048);
Property methods: CommandLineDisplayToLogical(), CommandLineGet(), CommandLineIsValid(), CommandLineLogicalToDisplay(), CommandLineLogicalToOdbc(), CommandLineNormalize(), CommandLineSet()
property PipeMode as %String [ InitialExpression = "WR" ];
Property methods: PipeModeDisplayToLogical(), PipeModeGet(), PipeModeIsValid(), PipeModeLogicalToDisplay(), PipeModeLogicalToOdbc(), PipeModeNormalize(), PipeModeSet()
property Timer as %String;
Property methods: TimerDisplayToLogical(), TimerGet(), TimerIsValid(), TimerLogicalToDisplay(), TimerLogicalToOdbc(), TimerNormalize(), TimerSet()


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

Inherited Members

Inherited Properties

Inherited Methods