Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [SYS] >  [Agent]
Private  Storage   

class SYS.Agent extends %RegisteredObject

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


Parameters Properties Methods Queries Indices ForeignKeys Triggers


%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
GetApplicationInterface GetApplicationPort GetVersion IsMirroringEnabled
IsRunning VerifyConnection


• 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
• classmethod GetApplicationPort() as %Integer
Returns the application port of the ISCAgent if it is running, an empty string otherwise
• classmethod GetVersion() as %String
Returns the version string of the ISCAgent if it is running, an empty string otherwise
• classmethod IsMirroringEnabled() as %Boolean
Returns true if the mirroring application is enabled, false otherwise
• classmethod IsRunning() as %Boolean
Returns true if an instance of the ISCAgent is running on this system, false otherwise
• 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.

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