This enumeration defines the states of a StreamLink connection. When the connection state changes, a
IConnectionStatusEvent event is raised on any supplied IConnectionListener listeners.
The IConnectionStatusEvent.Status has the property Status that contains one of these state values.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public enum ConnectionStatus
Public Enumeration ConnectionStatus
public enum class ConnectionStatus
Members| Member | Description |
|---|---|
| Connecting |
A connection attempt is in progress.
|
| Connected |
A network connection has been established.
|
| RetrievingCredentials |
Credentials are being fetched from the ICredentialsProvider.
|
| CredentialsRetrieved |
Credentials have been retrieved from the ICredentialsProvider.
|
| CredentialRetrievalFailed |
The attempt at retrieving the credentials from the ICredentialsProvider failed.
|
| LoggingIn |
StreamLink is in the process of logging into the server.
|
| LoggedIn |
The attempt to login to the server has been successful.
StreamLink has now established a session and subscription requests can be processed.
|
| LoggedOut |
StreamLink has logged out of the server in response to
a call to the IStreamLinkProvider’s Disconnect()()() method.
|
| ConnectionLost |
The connection to the server has been lost, StreamLink will try to automatically re-establish the connection.
|
| AttemptingReconnection |
Attempting to reconnect after a connection to the server has been lost
(ConnectionLost state).
|
| Reconnected |
The session has been successfully reconnected following an earlier loss. No updates have been lost.
|
| Disconnecting |
The connection to the Liberator is in the process of disconnecting.
|
| Disconnected |
Disconnected from the Liberator.
|
| SessionEjected |
The session has been ejected by the Liberator. StreamLink will not try to reconnect to the server.
|
| SessionExpired |
The current session has expired. StreamLink will try to reconnect.
|
| LoginFailed |
The login attempt has failed due to bad Credentials.
The login attempt has failed because the user credentials provided through
ICredentialsProvider did not specify an authorized user.
|
| ConnectionFailed |
A connection attempt has failed.
StreamLink will retry until there are no more configured connections available.
|
| NoConnectionsAvailable |
There are no more configured connections available.
StreamLink will not try to connect unless
IStreamLinkProvider’s Connect()()() method is called.
|