Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Net] >  [Remote] >  [Service]
Private  Storage   

class %Net.Remote.Service extends %RegisteredObject

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
37


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
IsGatewayRunning PingGateway SpawnGateway StopGateway


Methods

• classmethod IsGatewayRunning(host As %String = "127.0.0.1", port As %String = "", pVerbose As %Boolean = 0, Output pSC As %Status, pPing As %Boolean = 1, allowedip 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 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 SpawnGateway(pName As %String = "", pConfirmationTimeout As %Integer = 60) as %Status
• classmethod StopGateway(pName As %String, pVerbose As %Boolean = 0, pStopMonitor As %Boolean = 1, pTimeout As %Integer = 0) as %Status
Stop the External Language Server whose definition is identified by pName. To supress write of progress messages, pass pVerbose = 0. pName : gateway name pVerbose : flag to enable verbose logging, 0 by default pStopMonitor : flag to enable monitoring of gateway shutdown process, no longer in use pTimeout : soft shutdown timeout in seconds, 0 by default

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