This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > SYS.Info.Accessor

SYS.Info.Accessor

class SYS.Info.Accessor extends %Library.RegisteredObject

This class provides facilities to enumerate cache instances and their services

Method Inventory (Including Private)

Methods (Including Private)

method EnumerateApplications(pProviderName As %String, Output pInstallations As %ListOfObjects, pAppId As %String = "SYS.Info.Accessor") as %Status
This method enumerates 'Applications'. Individual instances of Cache or Ensemble may advertise 'Applications' which typically represent a 'service' that is provided, for example, the System Management Portal. The AppId parameter is reserved for future use. The information regarding the Applications is returned as a list of dictionary objects each which contains a set of keys and values describing each application. Each application has these well known keys:- TBD:
classmethod EnumerateInfoProvidersClose(ByRef qHandle As %Binary) as %Status
classmethod EnumerateInfoProvidersExecute(ByRef qHandle As %Binary) as %Status
classmethod EnumerateInfoProvidersFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod EnumerateInstallationsClose(ByRef qHandle As %Binary) as %Status
classmethod EnumerateInstallationsExecute(ByRef qHandle As %Binary, pProviderName As %String) as %Status
classmethod EnumerateInstallationsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod TestEnumerateApplications()
Test enumeration of applications
classmethod TestEnumerateInfoProviders()
Test enumeration of the installed 'Info Providers'
classmethod TestEnumerateInstallations()
Test enumeration of the installed 'Installations'

Queries

query EnumerateInfoProviders()
Selects Name As %Library.String, Description As %Library.String
This Query enumerates 'InfoProviders'. An InfoProvider is an object (implemented in an external library) which knows how to find instances of Cache and determine information about the 'applications' those Cache instances support. An example of an application would be the system management portal. Currently there are two InfoProviders available, the 'Bonjour' provider which uses Apples Bonjour protocol to find instances of Cache on the local network and the 'Http' provider which uses Http to discover the applications which individual Cache instances provide. The result set contains two rows, Name and Description. Use this name with the 'EnumerateInstallations' or 'EnumerateApplications' queries
query EnumerateInstallations(pProviderName As %String)
Selects host As %Library.String, name As %Library.String, serverPort As %Library.Integer, status As %Library.String, version As %Library.String
This query enumerates 'Installations', that is, individual instances of Cache or Ensemble. Depending upon which InfoProvider is selected, these installations may be local to this machine or remote. The 'HttpProvider' will enumerate local installations whilst the 'BonjourProvider' will enumerate installations that have been advertised by the 'Bonjour' protocol. The query requires the name of the InfoProvider to use such as 'HttpProvider' or 'BonjourProvider. The AppId parameter is reserved for future use. The information regarding the installations is returned as a list of dictionary objects each which contains a set of keys and values describing each installation. Each installation has these well known keys:- host: The hostname of the computer where the installation is located name: The name of the instance of Cache or Ensemble serverPort: The superserver port status: The current status of the installatio, 'up', 'dn' etc version: The $ZV version string

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window