Represents a scheduled item of work that will be run on the event loop either once or on a repeating basis. The task allows for easy cancelation and for asynchronous awaits via the return completion Task. More...

Public Member Functions
bool	Cancel ()
	Request to cancel the scheduled task if possible, returns true if the task was canceled before it ran, false otherwise. If the Task is a periodic variant then all future executions are cancelled as well. More...

Properties
long	Delay `[get]`
	Returns the delay time in as high of precision as possible for the time the task executes and the next iteration if this task is periodic. More...

long	Deadline `[get]`
	Returns the next time to run in as high of precision value as possible in the current environment. More...

Task	CompletionTask `[get]`
	A Task that can be awaited for scheduled work that is not periodic in nature. More...

Detailed Description

Represents a scheduled item of work that will be run on the event loop either once or on a repeating basis. The task allows for easy cancelation and for asynchronous awaits via the return completion Task.

Member Function Documentation

◆ Cancel()

bool Apache.Qpid.Proton.Client.Concurrent.IScheduledTask.Cancel ( )

Request to cancel the scheduled task if possible, returns true if the task was canceled before it ran, false otherwise. If the Task is a periodic variant then all future executions are cancelled as well.

Returns: true if cancelled, false otherwise

Property Documentation

◆ CompletionTask

Task Apache.Qpid.Proton.Client.Concurrent.IScheduledTask.CompletionTask

get

A Task that can be awaited for scheduled work that is not periodic in nature.

◆ Deadline

long Apache.Qpid.Proton.Client.Concurrent.IScheduledTask.Deadline

get

Returns the next time to run in as high of precision value as possible in the current environment.

◆ Delay

long Apache.Qpid.Proton.Client.Concurrent.IScheduledTask.Delay

get

Returns the delay time in as high of precision as possible for the time the task executes and the next iteration if this task is periodic.

The documentation for this interface was generated from the following file:

src/Proton.Client/Client/Concurrent/IScheduledTask.cs

Public Member Functions