SYS.ECP

abstract class SYS.ECP

• 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()
• GetServerConnState()
• ServerAction()

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 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) 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

Queries

query ClientList()

Selects Client Name As %String, Status As %String, IP Address As %String, IP Port As %Integer

query ServerList()

Selects Server Name As %String, Host Name As %String, Status As %String, IP Address As %String, IP Port As %Integer