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() [ Language = objectscript ]
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:
classmethod GetRemoteDBMountStatus(ServerName As %String, Directory As %String) as %Integer [ Language = objectscript ]
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 [ Language = objectscript ]
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 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()