SubscribeProgress

ISubscription IUpdatable.SubscribeProgress(double increment, UpdatableProgressHandler handler, double interval = System.double.MaxValue)

Subscribes a callback to be executed when the progress of a transfer reaches a multiple of increment or when the time since the previous callback reaches interval.

Parameters

• increment – Progress increment [0.05-1.0], e.g. use 0.05 for progress events every 5% of the total transfer size.

• handler – Delegate to be invoked.

• interval – Progress maximum interval in seconds.

Returns

ISubscription – An ISubscription for the callback.

Throws

• NullArgumentException – Null reference was passed.

• InvalidArgumentException – Invalid increment value.

• InvalidArgumentException – Invalid interval value (NaN).

• OutOfResourcesException – No resources available to subscribe callback.

• CommunicationErrorException – Protocol error.

• ConnectionLostException – Connection to controller lost.

• RebootedException – Controller has been rebooted since this object reference was retrieved, invalidating this reference.