com.ibm.mqlight.api.timer

Interface TimerService

public interface TimerService

Plug point for timer 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, TimerService, com.google.gson.GsonBuilder, com.ibm.mqlight.api.ClientOptions, com.ibm.mqlight.api.NonBlockingClientListener, Object) method.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(Promise<Void> promise) Cancels a previously scheduled promise (e.g.
void	schedule(long delay, Promise<Void> promise) Schedules a timer that will "pop" at some point in the future.

Method Detail

schedule

void schedule(long delay,
            Promise<Void> promise)

Schedules a timer that will "pop" at some point in the future. When the timer "pops" the promise, specified as a parameter, must be completed successfully by calling the Promise.setSuccess(Object) method. Timers are "single shot" as the promise can only be completed once.

The implementation cannot block the calling thread - and so must employ some scheme that uses another thread to complete the promise.

Parameters:

delay - a delay in milliseconds

promise - a promise object to be completed after the delay period

cancel

void cancel(Promise<Void> promise)

Cancels a previously scheduled promise (e.g. one that has previously been passed to the schedule(long, Promise) method. If the cancel operation is successful then the promise's Promise.setFailure(Exception) method will be invoked.

Once a promise has been scheduled, using the schedule(long, Promise) it will always be completed - even if it is cancelled as a result of this method being invoked.

If this method is invoked on a promise which has already completed, it should have no effect.

Parameters:

promise - the promise to cancel