Skip to content

Reference

OpcTaskSchedule Members

Defines the central entry point used to schedule any kind of task to perform using custom queuing and scheduling mechanisms.

Reference

OpcTaskSchedule Members ​

Type
OpcTaskSchedule
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Properties ​

CustomScheduler ​

static · since v2.11

Gets or sets the callback used to schedule task invocations.

csharp
public static OpcTaskSchedule.Scheduler CustomScheduler { get; set; }
vbnet
Public Shared Property CustomScheduler As OpcTaskSchedule.Scheduler

Property value

OpcTaskSchedule.Scheduler

A OpcTaskSchedule.Scheduler which is used to schedule task invocations, or a null reference (Nothing in Visual Basic) to use a default scheduler. The default value is a null reference (Nothing in Visual Basic).

DefaultScheduler ​

static · Obsolete: Use CustomScheduler instead.

Gets or sets the callback used to schedule task invocations. This property is obsolete, use CustomScheduler instead.

csharp
[Obsolete("Use CustomScheduler instead.")]
public static OpcTaskSchedule.Scheduler DefaultScheduler { get; set; }
vbnet
<Obsolete("Use CustomScheduler instead.")>
Public Shared Property DefaultScheduler As OpcTaskSchedule.Scheduler

Property value

OpcTaskSchedule.Scheduler

The CustomScheduler, or a scheduler which runs each invocation on the thread pool if no CustomScheduler is set. Setting the value sets the CustomScheduler.

Methods ​

QueryScheduler ​

static · since v2.11

Determines the OpcTaskSchedule.Scheduler to use to schedule task invocations with respect to the context specified.

csharp
public static OpcTaskSchedule.Scheduler QueryScheduler(
    SynchronizationContext context,
    out bool isContextSensitive)
vbnet
Public Shared Function QueryScheduler(
    context As SynchronizationContext,
    isContextSensitive As Boolean) As OpcTaskSchedule.Scheduler

Parameters

NameTypeDescription
contextSynchronizationContextThe SynchronizationContext to post the invocations to, or a null reference (Nothing in Visual Basic).
isContextSensitiveout BooleanWhen this method returns, the value true if the returned scheduler posts the invocations to the context; otherwise the value false.

Returns

OpcTaskSchedule.Scheduler

The CustomScheduler if it is set; otherwise a scheduler which posts each invocation to the context if it is not a null reference (Nothing in Visual Basic); otherwise a scheduler which runs each invocation on the thread pool.

Schedule ​

static · 2 overloads

OverloadDescription
Schedule(Action)staticSchedules the invocation of the action specified using custom queuing and scheduling mechanisms.
Schedule(Action, SynchronizationContext)static · since v2.11Schedules the invocation of the action specified using custom queuing and scheduling mechanisms.

Exceptions (all overloads)

ExceptionCondition
ArgumentNullExceptionThe action is a null reference (Nothing in Visual Basic).

Schedule(Action) ​

static

Schedules the invocation of the action specified using custom queuing and scheduling mechanisms.

csharp
public static void Schedule(Action action)
vbnet
Public Shared Sub Schedule(action As Action)

Parameters

NameTypeDescription
actionActionThe Action its invocation is to be scheduled.

Schedule(Action, SynchronizationContext) ​

static · since v2.11

Schedules the invocation of the action specified using custom queuing and scheduling mechanisms.

csharp
public static void Schedule(Action action, SynchronizationContext context)
vbnet
Public Shared Sub Schedule(action As Action, context As SynchronizationContext)

Parameters

NameTypeDescription
actionActionThe Action its invocation is to be scheduled.
contextSynchronizationContextThe SynchronizationContext to post the invocation to, or a null reference (Nothing in Visual Basic) (see QueryScheduler).