Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%Net] >  [Remote] >  [Utility]
Private  Storage   

class %Net.Remote.Utility extends %RegisteredObject

This class is for InterSystems internal use. Helper methods for %Net.Remote classes.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
14 1


Summary

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
CheckGateway GeneratePassphrase GetAllClassesClose GetAllClassesExecute
GetAllClassesFetch IsEnsembleNamespace IsServerLocal RunCommandViaCPIPE
RunCommandViaZF


Methods

• classmethod CheckGateway(pServer As %String, pPort As %String, pVerbose As %Boolean = 0, pPing As %Boolean = 1, pInterface As %String = "") as %Boolean
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).
• classmethod GeneratePassphrase(pPort As %String = "", pNoPassphrase As %Boolean = 0) as %String
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
• classmethod GetAllClassesClose(ByRef qHandle As %Binary) as %Status
• classmethod GetAllClassesExecute(ByRef qHandle As %Binary, pFilename As %String, pServer As %String, pPort As %String) as %Status
• classmethod GetAllClassesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod IsEnsembleNamespace() as %Boolean
Checks for production-enabled namespace.
• classmethod IsServerLocal(pServer As %String) as %Boolean
Check if the server address or name corresponds to the local machine.
• classmethod RunCommandViaCPIPE(pCmd As %String, Output pDevice As %String, Output pOutput As %String, pTimeoutOpen As %Integer = 10, pTimeoutRead As %Integer = 5, ByRef pCmdArgs) as %Status
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 RunCommandViaZF which uses a different technique.
• classmethod RunCommandViaZF(pCmd As %String, Output pTempFileName As %String, Output pOutput As %String, pOpenTimeout As %Integer = 5, pDeleteTempFile As %Boolean = 1, Output pRetCode As %String, ByRef pCmdArgs, pAsynchronous As %Boolean = 0) as %Status
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.

Queries

• query GetAllClasses(pFilename As %String, pServer As %String, pPort As %String)
Selects Classname As %String
This query returns all classes found inside pFilename (passed to Execute() as the 1st argument). Must also pass the name/IP of the server (2nd argument) and port (3rd argument) of a running Object Gateway Server.


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