SYS.ECP
abstract class SYS.ECP
Enterprise Cache Protocol Notes:- A Server Connection is a connection from this system as a client to a remote server.
- A Client Connection is a connection from a remote client to this system as a server.
Method Inventory
- ChangeToNotConnected()
- DisplayDatabases()
- GetClientConnState()
- GetRemoteDBMountStatus()
- GetServerConnState()
- ServerAction()
Parameters
parameter DOMAIN = %Utility;
Default Localization Domain
Methods
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"
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
Connection name is as specified in the network panel.
Return value:
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.
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.
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
Connection name is as specified in the network panel.
Return value:
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
Connection name is as specified in the network panel.
Action:
Wait: 1=wait for answer, 0=do not wait
Queries
query ClientList()
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.
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 = "*")
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.
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()