Skip to main content

SYS.Agent

Class SYS.Agent Extends %RegisteredObject

Used to retrieve information about the current ISCAgent instance on this system (if any)

Methods​

IsRunning​

ClassMethod IsRunning() As %Boolean

Returns true if an instance of the ISCAgent is running on this system, false otherwise

GetVersion​

ClassMethod GetVersion() As %String

Returns the version string of the ISCAgent if it is running, an empty string otherwise

VerifyConnection​

ClassMethod VerifyConnection(timeout As %Integer = 10) As %Status

Verifies the ISCAgent is running available on its reported application port Returns $$$OK if the ISCAgent is available and responding to requests, and an error status if not.

GetApplicationPort​

ClassMethod GetApplicationPort() As %Integer

Returns the application port of the ISCAgent if it is running, an empty string otherwise

GetApplicationInterface​

ClassMethod GetApplicationInterface() As %String

Returns the application interface adddress of the ISCAgent if it is running, "*" if bound on all ports, and an empty string otherwise

IsMirroringEnabled​

ClassMethod IsMirroringEnabled() As %Boolean

Returns true if the mirroring application is enabled, false otherwise

CheckStatusFile​

ClassMethod CheckStatusFile(fileName As %String) As %Boolean [ Private ]

Check for the existence and non-0 size of the candidate file

StatusFileName​

ClassMethod StatusFileName() As %String [ Private ]

Retrieves the default status file name for this OS

GetVMSPid​

ClassMethod GetVMSPid() As %String [ Private ]

Gets the PID on VMS via the QueryAgent script

StatusFileValue​

ClassMethod StatusFileValue(property As %String) As %String [ Private ]

Retrieve the value of a status file property