Class Shuffler.Shuffle

Description

This class contains the state for one ongoing data shuffling operation. To create a Shuffle instance, use the Shuffler()->shuffle method.

Variable done_callback

function(Shuffle, int:void) Shuffler.Shuffle.done_callback

Description

This function will be called when all sources have been processed, or if an error occurs.

Set via set_done_callback().

Variable shuffler

Shuffler Shuffler.Shuffle.shuffler

Description

The Shuffler that owns this Shuffle object

Variable throttler

Throttler Shuffler.Shuffle.throttler

Description

The Throttler that is associated with this Shuffle object, if any.

Method create

Shuffler.Shuffle Shuffler.Shuffle(object fd, object shuffler, mixed throttler, mixed backend, void|int start, void|int length)

Description

This object is normally not created directly, instead use Shuffler()->shuffle