Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ConnectionState

Represents the current connection state of a remote server.

Index

Enumeration members

Enumeration members

CONNECTED

CONNECTED: = 2

The remote server is connected and actively in use by components that require it.

FAILED

FAILED: = 4

The connection failed to establish.

If the connection was in an inactive or failed state state, a test connection was tried and failed.

In this case RemoteServerStatus.failureMessage will provide more detail.

INACTIVE

INACTIVE: = 1

The connection is inactive.

This means that the remote server can successfully connect but a physical connection is not being maintained as there are no components that require the remote server.

If in an inactive or failed state, a test connection will have been tried to check that the connection can be made and the connection will then have been closed.

MISSING

MISSING: = 5

The named remote server did not exist.

RETRYING

RETRYING: = 3

The connection has failed but a retry is scheduled.

In this case RemoteServerStatus.failureMessage will provide details of the failure that resulted in a retry.