Show / Hide Table of Contents

# Class Scheduler

Scheduler Service useful for running various delayed units of work.

##### Inheritance

System.Object
Scheduler

##### Inherited Members

System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)

###### Namespace: Apache.NMS.ActiveMQ.Threads

###### Assembly: Apache.NMS.ActiveMQ.dll

##### Syntax

    public class Scheduler

### Constructors

| Improve this Doc View Source

#### Scheduler(String)

##### Declaration

    public Scheduler(string name)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | name |

### Properties

| Improve this Doc View Source

#### Name

##### Declaration

    public string Name { get; }

##### Property Value

Type | Description
--- | ---
System.String |

| Improve this Doc View Source

#### Started

##### Declaration

    public bool Started { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

### Methods

| Improve this Doc View Source

#### Cancel(Object)

##### Declaration

    public void Cancel(object task)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Object | task |

| Improve this Doc View Source

#### ExecuteAfterDelay(WaitCallback, Object, Int32)

Executes the given task the after delay, no reference is kept for this task so it cannot be cancelled later.

##### Declaration

    public void ExecuteAfterDelay(WaitCallback task, object arg, int delay)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Threading.WaitCallback | task |
System.Object | arg |
System.Int32 | delay |

| Improve this Doc View Source

#### ExecuteAfterDelay(WaitCallback, Object, TimeSpan)

Executes the given task the after delay, no reference is kept for this task so it cannot be cancelled later.

##### Declaration

    public void ExecuteAfterDelay(WaitCallback task, object arg, TimeSpan delay)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Threading.WaitCallback | task |
System.Object | arg |
System.TimeSpan | delay |

| Improve this Doc View Source

#### ExecutePeriodically(WaitCallback, Object, Int32)

Executes the given task periodically using a fixed-delay execution style which prevents tasks from bunching should there be some delay such as garbage collection or machine sleep.

This repeating unit of work can later be cancelled using the WaitCallback that was originally used to initiate the processing.

##### Declaration

    public void ExecutePeriodically(WaitCallback task, object arg, int period)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Threading.WaitCallback | task |
System.Object | arg |
System.Int32 | period |

| Improve this Doc View Source

#### ExecutePeriodically(WaitCallback, Object, TimeSpan)

Executes the given task periodically using a fixed-delay execution style which prevents tasks from bunching should there be some delay such as garbage collection or machine sleep.

This repeating unit of work can later be cancelled using the WaitCallback that was originally used to initiate the processing.

##### Declaration

    public void ExecutePeriodically(WaitCallback task, object arg, TimeSpan period)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Threading.WaitCallback | task |
System.Object | arg |
System.TimeSpan | period |

| Improve this Doc View Source

#### Start()

##### Declaration

    public void Start()

| Improve this Doc View Source

#### Stop()

##### Declaration

    public void Stop()

| Improve this Doc View Source

#### ToString()

##### Declaration

    public override string ToString()

##### Returns

Type | Description
--- | ---
System.String |

##### Overrides

System.Object.ToString()