Class KepServerJobPromise

Namespace

Kepware.Api.Model.Services

Assembly

Kepware.Api.dll

Represents a promise for a job initiated on the Kepware server, allowing for asynchronous completion tracking and disposal.

public class KepServerJobPromise : IDisposable

Inheritance

object

KepServerJobPromise

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Endpoint

Gets the endpoint associated with the job.

JobTimeToLive

Gets the time-to-live duration for the job.

WaitDelayBetweenCompletionPolls

Gets or sets the delay between completion polls.

Methods

AwaitCompletionAsync(CancellationToken)

Awaits the completion of the job asynchronously. If the job is completed successfully, the task result will contain true. You can call this method multiple times to get the result, it will not re-run the job or wait again for the completion. It is safe to call this method after the job has been completed. This is thread-safe.

AwaitCompletionAsync(TimeSpan, CancellationToken)

Awaits the completion of the job asynchronously. If the job is completed successfully, the task result will contain true. You can call this method multiple times to get the result, it will not re-run the job or wait again for the completion. It is safe to call this method after the job has been completed. This is thread-safe.

Dispose()

Releases all resources used by the KepServerJobPromise.

Dispose(bool)

Releases the unmanaged resources used by the KepServerJobPromise and optionally releases the managed resources.