DocBook|Search
Class Reference
%Net.Remote.Service
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%Net] >  [Remote] >  [Service]
Private  Storage  

class %Net.Remote.Service extends %RegisteredObject

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
21


Summary

Methods
%%OIDGet %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject CheckMonitor ConnectGateway GatewayMonitor
OpenGateway PingGateway RunStartCmd ShutdownGateway
StartGateway StartGatewayObject StartMonitor StartMonitorObject
StopGateway StopGatewayObject StopMonitor


Methods

• 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 ConnectGateway(pGateway As %Net.Remote.ObjectGateway, ByRef pGatewayConn As %Net.Remote.Gateway, pAdditionalPaths As %String = "") as %Status
Connect to a running Java Gateway Server. ConnectGateway(pGateway, .GatewayConn)
• 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)
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 OpenGateway(pName As %String, Output pGateway As %Net.Remote.ObjectGateway) 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) as %Status
"Ping" the Gateway server to check if it's alive.
• classmethod RunStartCmd(pGateway As %Net.Remote.ObjectGateway) as %Status
Run command to start the Gateway Server.
• classmethod ShutdownGateway(pGateway As %Net.Remote.ObjectGateway) as %Status
Shutdown the Gateway Server.
• classmethod StartGateway(pName As %String, pVerbose As %Boolean = 0) as %Status
Start up the Object Gateway Server whose definition is identified by pName. To supress write of progress messages, pass pVerbose = 0.
• classmethod StartGatewayObject(pGateway As %Net.Remote.ObjectGateway, pVerbose As %Boolean = 0) as %Status
Start up the Object Gateway 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 Object Gateway 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 %Net.Remote.ObjectGateway, pVerbose As %Boolean = 0)
Monitor the Object Gateway 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 Object Gateway Server whose definition is identified by pName. To supress write of progress messages, pass pVerbose = 0.
• classmethod StopGatewayObject(pGateway As %Net.Remote.ObjectGateway, pVerbose As %Boolean = 0, pStopMonitor As %Boolean = 1) as %Status
Stop the Object Gateway 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) as %Status
Terminate process currently monitoring a Gateway Server.