IRISLIB database
Utility Class Reference

This class is for InterSystems internal use. More...

Inheritance diagram for Utility:
Collaboration diagram for Utility:

Static Public Member Functions

_.Library.Boolean CheckGateway (_.Library.String pServer, _.Library.String pPort, _.Library.Boolean pVerbose, _.Library.Boolean pPing, _.Library.String pInterface)
 This class is for InterSystems internal use. More...
 
_.Library.String GeneratePassphrase (_.Library.String pName, _.Library.Boolean pNoPassphrase)
 Generates a Pass phrase for a given Port and records. More...
 
_.Library.Boolean IsEnsembleNamespace ()
 Checks for production-enabled namespace.
 
_.Library.Boolean IsServerLocal (_.Library.String pServer)
 Check if the server address or name corresponds to the local machine.
 
_.Library.Status RunCommandViaCPIPE (_.Library.String pCmd, _.Library.String pDevice, _.Library.String pOutput, _.Library.Integer pTimeoutOpen, _.Library.Integer pTimeoutRead, pCmdArgs, pEnvVars)
 Run a command using a CPIPE device. More...
 
_.Library.Status RunCommandViaZF (_.Library.String pCmd, _.Library.String pTempFileName, _.Library.String pOutput, _.Library.Integer pOpenTimeout, _.Library.Boolean pDeleteTempFile, _.Library.String pRetCode, pCmdArgs, _.Library.Boolean pAsynchronous)
 Run a command using $ZF(-100) and an external temporary file to store the command output. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

This class is for InterSystems internal use.

Helper methods for Net.Remote classes.

Member Function Documentation

◆ CheckGateway()

_.Library.Boolean CheckGateway ( _.Library.String  pServer,
_.Library.String  pPort,
_.Library.Boolean  pVerbose,
_.Library.Boolean  pPing,
_.Library.String  pInterface 
)
static

This class is for InterSystems internal use.

Helper methods for Net.Remote classes.

Check if Gateway is running and optionally if it is responding to PING.

Same as method ##class(Net.Remote.Service).IsGatewayRunning(pServer, pPort, pVerbose, pPing, pInterface).

◆ GeneratePassphrase()

_.Library.String GeneratePassphrase ( _.Library.String  pName,
_.Library.Boolean  pNoPassphrase 
)
static

Generates a Pass phrase for a given Port and records.

It returns the Pass phrase to use on the Command Line Uses pNoPassPhrase to clear a previous PassPhrase for this port

◆ RunCommandViaCPIPE()

_.Library.Status RunCommandViaCPIPE ( _.Library.String  pCmd,
_.Library.String  pDevice,
_.Library.String  pOutput,
_.Library.Integer  pTimeoutOpen,
_.Library.Integer  pTimeoutRead,
  pCmdArgs,
  pEnvVars 
)
static

Run a command using a CPIPE device.

The first unused CPIPE device is allocated and returned in pDevice. Upon exit the device is open; it is up to the caller to close that device when done with it.
pTimeoutOpen indicates how long to wait for the initial OPEN and pTimeoutRead indicates how long to wait between reading the output chunks.
Note that CPIPE (and PIPE) devices are supported on Unix and Windows, but not on VMS. If this method is invoked on an instance installed on VMS, execution flow will be diverted to method <method>RunCommandViaZF</method> which uses a different technique.

◆ RunCommandViaZF()

_.Library.Status RunCommandViaZF ( _.Library.String  pCmd,
_.Library.String  pTempFileName,
_.Library.String  pOutput,
_.Library.Integer  pOpenTimeout,
_.Library.Boolean  pDeleteTempFile,
_.Library.String  pRetCode,
  pCmdArgs,
_.Library.Boolean  pAsynchronous 
)
static

Run a command using $ZF(-100) and an external temporary file to store the command output.


If pDeleteTempFile is 0 (false), the temporary file is not deleted; in this case, it is up to the caller to delete it when done with it.