com.ibm.mqlight.api.endpoint

Interface EndpointService

public interface EndpointService

Plug point for endpoint lookup implementations. The implementation used for an instance of the client can be specified using the NonBlockingClient.create(com.ibm.mqlight.api.endpoint.EndpointService, com.ibm.mqlight.api.callback.CallbackService, com.ibm.mqlight.api.network.NetworkService, com.ibm.mqlight.api.timer.TimerService, com.google.gson.GsonBuilder, com.ibm.mqlight.api.ClientOptions, com.ibm.mqlight.api.NonBlockingClientListener, Object) method.

Method Summary

Modifier and Type	Method and Description
void	lookup(EndpointPromise promise) Called by the client each time it needs to make a decision about which endpoint to attempt a connection to.
void	onSuccess(Endpoint endpoint) Called by the client when it has successfully established a connection to one of the endpoints returned by this service.

Method Detail

lookup

void lookup(EndpointPromise promise)

Called by the client each time it needs to make a decision about which endpoint to attempt a connection to.

When the operation completes the promise (supplied as an argument) is used to notify the client of the outcome. If an endpoint is available it will be supplied to the Promise.setSuccess(Object) method. If no endpoints are currently available, the client can be advised to wait for a period of time before calling this method again using the EndpointPromise.setWait(long) method. Indicating failure by calling the Promise.setFailure(Exception) will cause the client to transition into stopped state.

Parameters:

promise - a promise that is to be completed when the endpoint service has completed the lookup request.

onSuccess

void onSuccess(Endpoint endpoint)

Called by the client when it has successfully established a connection to one of the endpoints returned by this service. This allows the endpoint service to optimise the order in which it returns endpoints (for example to implement an algorithm that always returns the most recently successful endpoints first).

Parameters:

endpoint - the endpoint to which a connection has successfully being established.