AMPS.Client.ServerChooser Interface Reference

Inheritance diagram for AMPS.Client.ServerChooser:

Public Member Functions
string	getCurrentURI ()
Authenticator	getCurrentAuthenticator ()
void	reportFailure (Exception exception, ConnectionInfo ci)
String	getError ()
void	reportSuccess (ConnectionInfo ci)

Member Function Documentation

getCurrentAuthenticator()

Authenticator AMPS.Client.ServerChooser.getCurrentAuthenticator

(

)

Returns the Authenticator instance associated with the current URI.

Returns

An Authenticator or

null 

if none is required for logon.

Implemented in AMPS.Client.DefaultServerChooser.

getCurrentURI()

string AMPS.Client.ServerChooser.getCurrentURI

(

)

Returns the current URI.

Returns

A string with the URI to connect to, or null if no server is available to connect to.

Implemented in AMPS.Client.DefaultServerChooser.

getError()

String AMPS.Client.ServerChooser.getError

(

)

Provides additional detail to be included in an exception thrown when the AMPS instance(s) are not available. Called by the HAClient when creating an exception.

Returns

An String with information about the connection that failed and the reason for the failure. When no further information is available, returns an empty string.

Implemented in AMPS.Client.DefaultServerChooser.

reportFailure()

void AMPS.Client.ServerChooser.reportFailure	(	Exception	exception,
		ConnectionInfo	ci
	)

Called by the HAClient when an error occurs connecting to the current URI, and/or when an error occurs logging on. Implementors will likely advance the current URI to the next one in a list, or choose to stay with the current one, based on the exception type.

Parameters

exception	The exception associated with this failure.
uri	The uri that we attempted to connect with (but failed)
clientName	The name of the client that is being reconnected.

Implemented in AMPS.Client.DefaultServerChooser.

reportSuccess()

void AMPS.Client.ServerChooser.reportSuccess

(

ConnectionInfo

ci

)

Called by the HAClient when successfully connected and logged on to the current instance.

Parameters

uri	The uri that we have successfully connected with.
clientName	The name of the client that was successfully reconnected.

Implemented in AMPS.Client.DefaultServerChooser.

---

The documentation for this interface was generated from the following file:

• AMPS.Client/ServerChooser.cs