SYS.ECP

abstract class SYS.ECP

Enterprise Cache Protocol Notes:

Method Inventory

Parameters

parameter DOMAIN = %Utility;
Default Localization Domain

Methods

classmethod ChangeToNotConnected(ConnectionName As %String) as %Boolean
Changes an ECP connection state to not connected. Connection name is as specified in the network panel. Returns zero if the connection name is invalid
classmethod DisplayDatabases()
Display the list of database remote databases this client has "mounted"
classmethod GetClientConnState(ConnectionName As %String) as %Integer
Returns the state of an ECP Client Connection.
Connection name is as specified in the network panel.
Return value:
  • -1 - Invalid connection name
  • 0 - Free
  • 1 - Normal
  • 2 - Trouble
  • 3 - Recovering
  • 4 - Restart
  • classmethod GetRemoteDBMountStatus(ServerName As %String, Directory As %String) as %Integer
    Given the data server connection name and the remote directory name on this client, returns the mount status codes of the remote database.
    The Status Codes are:
    0 - Remote database has not been mounted yet.
    1 - Remote database is dismounted.
    2 - Remote database is mounted read-only.
    3 - Remote database is mounted read-write.
    classmethod GetServerConnState(ConnectionName As %String) as %Integer
    Returns the state of an ECP Server Connection.
    Connection name is as specified in the network panel.
    Return value:
  • -2 - Invalid connection name
  • -1 - Invalid
  • 0 - Initializing
  • 1 - Not Connected
  • 2 - Connection in Progress
  • 3 - Connection Failed
  • 4 - Disabled
  • 5 - Normal
  • 6 - Trouble
  • 7 - Recovery
  • classmethod ServerAction(ConnectionName As %String, Action As %Integer, Wait As %Boolean = 1) as %Status
    Performs Action on an ECP Server Connection.
    Connection name is as specified in the network panel.
    Action:
  • 1 - Change to Not Connected
  • 2 - Change to Disabled
  • 3 - Change to Normal
    Wait: 1=wait for answer, 0=do not wait
  • Queries

    query ClientList()
    Selects Client Name As %String, Status As %String, IP Address As %String, IP Port As %Integer
    Query to list remote app server connections. Returned app server's client name, status, IP address and port number.

    The Client Name is in ConnectName:CliSysName:InstanceName formart:
    ConnectName - Connection name as defined in the app server's ECPServers configuration.
    CliSysName - CliSysName in Config.Startup of the app server if defined. If not defined, defaults to app server's hostname..
    InstanceName - App server's instance name.

    The Status can be:
    Normal - Node is actively in use.
    Trouble - Node failed, waiting for recovering.
    Recovering - Node is in process of recovering.
    Restart - Server has restarted, but this connection is awaiting for recovery.
    DeadCleanup - Server is in process of cleanning dead dmns..
    Invalid - Node has inavlid status code.
    query DatabaseList(DBNames As %String = "*", ServerName As %String = "*", Directory As %String = "*")
    Selects DBName As %String, ServerName As %String, Directory As %String, MountStatus As %String
    Query to list configured remote databases. Returned database's configuration name, server name, directory and mount status codes.
    The Status Codes are:
    0 - Remote database has not been mounted yet.
    1 - Remote database is dismounted.
    2 - Remote database is mounted read-only.
    3 - Remote database is mounted read-write.
    query ServerList()
    Selects Server Name As %String, Host Name As %String, Status As %String, IP Address As %String, IP Port As %Integer
    Feedback