%Net.Remote.Service

class %Net.Remote.Service extends %Library.RegisteredObject

This class contains methods to start, monitor and stop an External Language Server for Java or .NET.

Method Inventory

Methods

classmethod AddIntegratedMLServerDefinition() as %Status
deprecated classmethod CheckJavaVersionSupported(javaVersion As %String = "") as %Status
classmethod CheckMonitor(pName As %String, pPort As %String, Output pJob As %String) as %Status
Check if Gateway is being monitored and return the monitor job number.
classmethod CompareChecksum(Output compareResult As %String = "", serverName As %String, pythonVersion As %String, pythonPath As %String, irisVersion As %String) as %Status
classmethod ConnectGateway(pGateway As %DynamicObject, ByRef pGatewayConn As %Net.Remote.Gateway, pAdditionalPaths As %String = "", pStartOnDemand As %Boolean = 1, pVerbose As %Boolean = 0, useSharedMemoryIfPossible As %Boolean = 0) as %Status
Connect or reconnect to a running External Language Server.
When pStartOnDemand is true (which is the default), the Gateway will be started if it is not running.
classmethod DeleteVirtualEnv(serverName As %String) as %Status
classmethod GatewayMonitor(Name As %String, Type As %String, TypeExt As %String, Server As %String, Port As %String, Timeout As %String, HeartbeatInterval As %String, HeartbeatFailureTimeout As %String, HeartbeatFailureAction As %String, HeartbeatFailureRetry As %String, pVerbose As %Boolean = 0)
The Gateway Server is monitored with PING requests, according to the time interval specified by HeartbeatInterval. Hourly, a record of type "Info" is logged.
classmethod GetChecksumPath(Output checksumPath As %String = "", serverName As %String) as %Status
classmethod GetDotNetAssembly(pGateway As %DynamicObject, Output pCmd As %String, Output pCmdArgs, Output pPredictedCmdStr As %String) as %Status
deprecated classmethod GetJARDirectory(javaVersion As %Integer, Output JARDir As %String) as %Status
classmethod GetJavaExecutableCommand(javaHomeDir As %String = "", Output javaExecutable As %String = "", normalizeWithSpaces As %Boolean = 1) as %Status
classmethod GetJavaIntegratedMLJAR() as %String
classmethod GetJavaVersion(javaHomeDir As %String = "", Output version As %Integer, Output versionString As %String) as %Status
Returns the primary Java version number. For example, for 1.8.0_241, it returns 8. For 11.0.6, it returns 11. Rules of how the complete version string is formatted can be found here: http://www.oracle.com/technetwork/java/javase/versioning-naming-139433.html
classmethod GetPythonExecutableCommand(pythonPath As %String = "", Output pythonExecutable As %String = "", Output pythonVersion As %String = "", normalizeWithSpaces As %Boolean = 1) as %Status
classmethod GetPythonGatewayScript(Output pythonGatewayScript As %String = "", scriptName As %String, normalizeWithSpaces As %Boolean = 1) as %Status
classmethod GetPythonVersion(pythonExecutable As %String = "", Output pythonVersion As %String = "") as %Status
classmethod GetRequiredClassPath(pGateway As %DynamicObject, Output requiredClassPath As %String = "") as %Status
classmethod IsCore(pGateway As %DynamicObject) as %Boolean
True if the .NET version is .NET Core (ex: Core 2.1)
classmethod IsGatewayRunning(pServer As %String = "127.0.0.1", pPort As %String = "", pVerbose As %Boolean = 0, Output pSC As %Status, pPing As %Boolean = 1, pInterface As %String = "", sslConfiguration As %String = "") as %Boolean
Return true if Gateway is running, based on the status of the TCP port, and responsiveness to PING
If the port is not in use, then Gateway is not running on the port, otherwise, we will PING the port. Parameters pPing is deprecated.
classmethod IsNet(pGateway As %DynamicObject) as %Boolean
True if the .NET version is .NET 5 or greater
classmethod OnSystemStartup(Output pConsoleLog As %String)
Perform system startup task
classmethod OpenGateway(pName As %String, Output pGateway As %DynamicObject) as %Status
Get the Gateway definition object for a given Gateway name.
classmethod PingGateway(pPort As %String, pAddress As %String = "127.0.0.1", pTimeout As %Integer = 5, pReuseSocket As %Boolean = 0, pVerbose As %Boolean = 0) as %Status
"Ping" the Gateway server to check if it is alive. If pReuseSocket is true (the default is false), it will try to reuse the TCP device and in case the TCP connection has become invalid it will reconnect.
Instead of using this method it is recommended to instantiate or use an existing %Net.Remote.Gateway client and %Connect(), call %Ping() and then %Disconnect().
classmethod RunStartCmd(pGateway As %DynamicObject, Output pOutput As %String, pVerbose As %Boolean = 0) as %Status
Run command to start the Gateway Server.
classmethod SetupVirtualEnv(pythonSetupScript As %String, serverName As %String, pythonExecutable As %String, setupLevel As %String, irisVersion As %String) as %Status
classmethod ShutdownGateway(pGateway As %DynamicObject, pVerbose As %Boolean = 0) as %Status
Shutdown the Gateway Server.
classmethod SpawnGateway(pName As %String, pConfirmationTimeout As %Integer = 60) as %Status
classmethod StartGateway(pName As %String, pVerbose As %Boolean = 0, Output pOutput As %String, pConfirm As %Boolean = 0) as %Status
Start up the External Language Server whose definition is identified by pName. To supress write of progress messages, pass pVerbose = 0.
classmethod StartGatewayObject(pGateway As %DynamicObject, pVerbose As %Boolean = 0, Output pOutput As %String, pConfirm As %Boolean = 0) as %Status
Start up the External Language Server whose definition is an object reference variable pGateway. To supress write of progress messages, pass pVerbose = 0.
classmethod StartMonitor(pName As %String, pVerbose As %Boolean = 0) as %Status
Start a monitor process for the External Language Server whose definition is identified by pName, if the Gateway is configured to be monitored (HeartbeatInterval greater than 0). To supress write of progress messages, pass pVerbose = 0.
classmethod StartMonitorObject(pGateway As %DynamicObject, pVerbose As %Boolean = 0)
Monitor the External Language Server whose definition is an object reference variable pGateway. If the Gateway Server has HeartbeatInterval set to a value greater than 0, then job off a background process to monitor the Gateway Server, otherwise just exit.
classmethod StopGateway(pName As %String, pVerbose As %Boolean = 0, pStopMonitor As %Boolean = 1) as %Status
Stop the External Language Server whose definition is identified by pName. To supress write of progress messages, pass pVerbose = 0.
classmethod StopGatewayObject(pGateway As %DynamicObject, pVerbose As %Boolean = 0, pStopMonitor As %Boolean = 1) as %Status
Stop the External Language Server whose definition is an object reference variable pGateway. To supress write of progress messages, pass pVerbose = 0.
classmethod StopMonitor(pName As %String, pPort As %String, pVerbose As %Boolean = 0) as %Status
Terminate process currently monitoring a Gateway Server.

Inherited Members

Inherited Methods

Feedback