%SYS
Agent Class Reference

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

Inheritance diagram for Agent:
Collaboration diagram for Agent:

Static Public Member Functions

_.Library.String GetApplicationInterface ()
 Returns the application interface adddress of the ISCAgent if it is running, "*" if bound on all ports, and an empty string otherwise.
 
_.Library.Integer GetApplicationPort ()
 Returns the application port of the ISCAgent if it is running, an empty string otherwise.
 
_.Library.String GetVersion ()
 Returns the version string of the ISCAgent if it is running, an empty string otherwise.
 
_.Library.Boolean IsMirroringEnabled ()
 Returns true if the mirroring application is enabled, false otherwise.
 
_.Library.Boolean IsRunning ()
 Returns true if an instance of the ISCAgent is running on this system, false otherwise.
 
_.Library.Status VerifyConnection (_.Library.Integer timeout)
 Verifies the ISCAgent is running available on its reported application port. More...
 

Static Private Member Functions

_.Library.Boolean __CheckStatusFile (_.Library.String fileName)
 Check for the existence and non-0 size of the candidate file.
 
_.Library.String __GetVMSPid ()
 Gets the PID on VMS via the QueryAgent script.
 
_.Library.String __StatusFileName ()
 Retrieves the default status file name for this OS.
 
_.Library.String __StatusFileValue (_.Library.String property)
 Retrieve the value of a status file property.
 

Detailed Description

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

Member Function Documentation

◆ VerifyConnection()

_.Library.Status VerifyConnection ( _.Library.Integer  timeout)
static

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.