WklTimerList

Dim myWklTimerList As WklTimerList
Set myWklTimerList = Me!ControlName.Object

Scheduled tasks of a form: a delayed search, a counter refreshed periodically, a paced queue of web requests. Visible in Design view, invisible in Form view.

None

Events are posted and delivered after the running event procedure of the control has ended, never from inside another of its events. The tasks end when the form closes; no event arrives afterwards. See the overview for the scheduling rules.

An ActiveX control: inserted into a form in design view (Form Design › Controls › ActiveX Controls); reports are not supported. VBA reaches it through the Object property of the control, where ControlName is the name of the control on the form.

None

None

Property Get Tasks() As WklTimerTasks

Gets the tasks of the list.

None

Property value: `WklTimerTasks` – The collection of tasks.

Read-only.

None

Declared by WklTimerList.

Sub Start()

Starts all enabled tasks.

None

In Design view nothing runs; the tasks start in Form view.

None

Declared by WklTimerList.

Sub Stop()

Stops all tasks.

None

A running VBA event and a web request on the way end normally and are reported; nothing more is scheduled.

None

Declared by WklTimerList.

Sub Pause()

Pauses all waiting tasks; the time left is kept.

None

None

None

Declared by WklTimerList.

Sub Resume()

Resumes all paused tasks and every web request queue halted by an answer 401.

None

None

None

Declared by WklTimerList.

Property Get AutoStart() As Boolean
Property Let AutoStart(RHS As Boolean)

Gets or sets whether all tasks start when the form opens in Form view.

None

Property value: Boolean – True: start with the form; False (default): start by code.

Read/write.

None

Declared by WklTimerList.

Property Get Running() As Long

Gets the number of runs going on.

None

Property value: Long – The number of runs handed out and not yet ended.

Read-only.

None

Declared by WklTimerList.

Property Get MaxParallel() As Long
Property Let MaxParallel(RHS As Long)

Gets or sets how many background jobs may run at the same time.

None

Property value: Long – At least 1 (default 1).

Reserved for the file, checksum, ZIP and program kinds. Each web request queue sends one request at a time; several queues run side by side.

Read/write.

None

Declared by WklTimerList.

Event TaskDue(ByVal Key As String, ByVal RunId As Long, ByVal Tag As Variant, ByRef Cancel As Integer)

Occurs when a run of a wttEvent task is due; the event procedure is the run.

Set Cancel to True to skip this run; an interval series goes on. A web request queue raises TaskStarted instead.

In a form module: Private Sub <ControlName>_TaskDue(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event TaskStarted(ByVal Key As String, ByVal RunId As Long)

Occurs when a background run sends its first web request.

In a form module: Private Sub <ControlName>_TaskStarted(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event TaskProgress(ByVal Key As String, ByVal RunId As Long, ByVal Percent As Long, ByVal Text As String)

Occurs when a background job reports progress.

Raised by the file, checksum, ZIP and program kinds, which are not available in this version.

In a form module: Private Sub <ControlName>_TaskProgress(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event TaskCompleted(ByVal Key As String, ByVal RunId As Long, ByVal Result As Variant)

Occurs when a background run ended successfully; for a web request queue, when the queue became empty.

A wttEvent run raises no TaskCompleted: its run is TaskDue.

In a form module: Private Sub <ControlName>_TaskCompleted(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event TaskFailed(ByVal Key As String, ByVal RunId As Long, ByVal Number As Long, ByVal Description As String, ByVal WillRetry As Boolean)

Occurs when a background run failed.

Raised by the file, checksum, ZIP and program kinds; a web request reports RequestFailed.

In a form module: Private Sub <ControlName>_TaskFailed(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event TaskCancelled(ByVal Key As String, ByVal RunId As Long, ByVal Reason As WklTimerCancelReason)

Occurs when a background run was canceled.

In a form module: Private Sub <ControlName>_TaskCancelled(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event RequestCompleted(ByVal Key As String, ByVal Id As Long, ByVal Tag As Variant, ByVal Status As Long, ByRef Result As WklHttpResult)

Occurs when a web request was answered with a status 2xx or 3xx.

Further requests may be added to the queue here, for example the requests that need the key returned in the answer.

In a form module: Private Sub <ControlName>_RequestCompleted(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event RequestFailed(ByVal Key As String, ByVal Id As Long, ByVal Tag As Variant, ByVal Status As Long, ByVal Description As String, ByVal WillRetry As Boolean, ByRef Result As WklHttpResult)

Occurs when a web request was answered with another status, or not at all.

Only a request without answer and an answer 429 are sent again; any other answer, also 5xx, is reported as it is, because a repetition could do the work twice. A second 401 in a row for the same request is reported here, and the queue halts again.

In a form module: Private Sub <ControlName>_RequestFailed(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event RequestCancelled(ByVal Key As String, ByVal Id As Long, ByVal Tag As Variant, ByVal Reason As WklTimerCancelReason)

Occurs when a web request was canceled.

A request whose connection was closed may have changed data at the service; its outcome is unknown.

In a form module: Private Sub <ControlName>_RequestCancelled(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event QueuePaused(ByVal Key As String, ByVal Reason As String, ByVal ResumeAt As Date)

Occurs when an answer 429 paused the whole queue.

The pause is the time in Retry-After (seconds or an HTTP date); without it, RateWindow, or 60 seconds.

In a form module: Private Sub <ControlName>_QueuePaused(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event QueueHalted(ByVal Key As String, ByVal Id As Long, ByVal Status As Long, ByVal Headers As String)

Occurs when an answer 401 halted the whole queue.

Sign in again on the main thread, set the shared headers and call Resume: the halted request is sent first.

In a form module: Private Sub <ControlName>_QueueHalted(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.

Event QueueResumed(ByVal Key As String)

Occurs when a pause ended or Resume was called.

In a form module: Private Sub <ControlName>_QueueResumed(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklTimerList.