File: ManualWorkflowSchedulerService.cs

package info (click to toggle)
mono 6.14.1%2Bds2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,282,732 kB
  • sloc: cs: 11,182,461; xml: 2,850,281; ansic: 699,123; cpp: 122,919; perl: 58,604; javascript: 30,841; asm: 21,845; makefile: 19,602; sh: 10,973; python: 4,772; pascal: 925; sql: 859; sed: 16; php: 1
file content (381 lines) | stat: -rw-r--r-- 15,694 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
using System;
using System.Threading;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Collections.ObjectModel;
using System.Workflow.Runtime;
using System.Diagnostics;
using System.Globalization;

namespace System.Workflow.Runtime.Hosting
{
    [Obsolete("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")]
    public class ManualWorkflowSchedulerService : WorkflowSchedulerService
    {
        private class CallbackInfo
        {
            WaitCallback callback;
            Guid instanceId;
            Guid timerId;
            DateTime when;

            public CallbackInfo(WaitCallback callback, Guid instanceId, Guid timerId, DateTime when)
            {
                this.callback = callback;
                this.when = when;
                this.instanceId = instanceId;
                this.timerId = timerId;
            }

            public DateTime When
            {
                get { return when; }
            }

            public bool IsExpired
            {
                get { return DateTime.UtcNow >= when; }
            }

            public Guid InstanceId { get { return instanceId; } }

            public Guid TimerId { get { return timerId; } }

            public WaitCallback Callback
            {
                get { return callback; }
            }
        }

        private KeyedPriorityQueue<Guid, CallbackInfo, DateTime> pendingScheduleRequests = new KeyedPriorityQueue<Guid, CallbackInfo, DateTime>();
        private Dictionary<Guid, DefaultWorkflowSchedulerService.WorkItem> scheduleRequests = new Dictionary<Guid, DefaultWorkflowSchedulerService.WorkItem>();
        private object locker = new Object();
        private Timer callbackTimer;
        private readonly TimerCallback timerCallback;   // non-null indicates that active timers are enabled
        private volatile bool threadRunning;    // indicates that the timer thread is running
        private static TimeSpan infinite = new TimeSpan(Timeout.Infinite);
        private IList<PerformanceCounter> queueCounters;
        private static TimeSpan fiveMinutes = new TimeSpan(0, 5, 0);

        private const string USE_ACTIVE_TIMERS_KEY = "UseActiveTimers";

        // Note that pendingScheduleRequests are keyed by instance ID under the assertion that there is at most one outstanding
        // timer for any given instance ID. To support cancellation, and additional map is kept of timerID-to-instanceID so that
        // we can find the appropriate pending  given a timer ID

        public ManualWorkflowSchedulerService()
        {
        }

        public ManualWorkflowSchedulerService(bool useActiveTimers)
        {
            if (useActiveTimers)
            {
                timerCallback = new TimerCallback(OnTimerCallback);
                pendingScheduleRequests.FirstElementChanged += OnFirstElementChanged;
                WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: started with active timers");
            }
        }
        public ManualWorkflowSchedulerService(NameValueCollection parameters)
        {
            if (parameters == null)
                throw new ArgumentNullException("parameters");

            foreach (string key in parameters.Keys)
            {
                if (key == null)
                    throw new ArgumentException(String.Format(Thread.CurrentThread.CurrentCulture, ExecutionStringManager.UnknownConfigurationParameter, "null"));
                string p = parameters[key];
                if (!key.Equals(USE_ACTIVE_TIMERS_KEY, StringComparison.OrdinalIgnoreCase))
                    throw new ArgumentException(String.Format(Thread.CurrentThread.CurrentCulture, ExecutionStringManager.UnknownConfigurationParameter, key));
                bool useActiveTimers;
                if (!bool.TryParse(p, out useActiveTimers))
                    throw new FormatException(USE_ACTIVE_TIMERS_KEY);
                if (useActiveTimers)
                {
                    timerCallback = new TimerCallback(OnTimerCallback);
                    pendingScheduleRequests.FirstElementChanged += OnFirstElementChanged;
                    WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: Started with active timers");
                }
            }
        }

        internal protected override void Schedule(WaitCallback callback, Guid workflowInstanceId)
        {
            if (callback == null)
                throw new ArgumentNullException("callback");
            if (workflowInstanceId.Equals(Guid.Empty))
                throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, ExecutionStringManager.CantBeEmptyGuid, "workflowInstanceId"));

            lock (locker)
            {
                WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: Schedule workflow {0}", workflowInstanceId);
                if (!scheduleRequests.ContainsKey(workflowInstanceId))
                    scheduleRequests.Add(workflowInstanceId, new DefaultWorkflowSchedulerService.WorkItem(callback, workflowInstanceId));
            }
            if (queueCounters != null)
            {
                foreach (PerformanceCounter p in queueCounters)
                {
                    p.RawValue = scheduleRequests.Count;
                }
            }
        }

        internal protected override void Schedule(WaitCallback callback, Guid workflowInstanceId, DateTime whenUtc, Guid timerId)
        {
            if (callback == null)
                throw new ArgumentNullException("callback");
            if (workflowInstanceId.Equals(Guid.Empty))
                throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, ExecutionStringManager.CantBeEmptyGuid, "workflowInstanceId"));
            if (timerId.Equals(Guid.Empty))
                throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, ExecutionStringManager.CantBeEmptyGuid, "timerId"));

            lock (locker)
            {
                WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: Schedule timer {0} for workflow {1} at {2}", timerId, workflowInstanceId, whenUtc);
                pendingScheduleRequests.Enqueue(timerId, new CallbackInfo(callback, workflowInstanceId, timerId, whenUtc), whenUtc);
            }
        }

        internal protected override void Cancel(Guid timerId)
        {
            if (timerId.Equals(Guid.Empty))
                throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, ExecutionStringManager.CantBeEmptyGuid, "timerId"));

            lock (locker)
            {
                WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: Cancel timer {0}", timerId);
                pendingScheduleRequests.Remove(timerId);
            }
        }

        private bool RunOne(Guid workflowInstanceId)
        {
            bool retval = false;
            DefaultWorkflowSchedulerService.WorkItem cs = null;
            lock (locker)
            {
                if (scheduleRequests.ContainsKey(workflowInstanceId))
                {
                    cs = scheduleRequests[workflowInstanceId];
                    scheduleRequests.Remove(workflowInstanceId);
                }
            }
            try
            {
                if (cs != null)
                {
                    WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: Executing {0}", workflowInstanceId);
                    if (queueCounters != null)
                    {
                        foreach (PerformanceCounter p in queueCounters)
                        {
                            p.RawValue = scheduleRequests.Count;
                        }
                    }
                    cs.Invoke(this);
                    retval = true;
                }
            }
            catch (Exception e)
            {
                RaiseServicesExceptionNotHandledEvent(e, workflowInstanceId);
            }
            return retval;
        }

        private bool HasExpiredTimer(Guid workflowInstanceId, out Guid timerId)
        {
            lock (locker)
            {
                CallbackInfo ci = pendingScheduleRequests.FindByPriority(DateTime.UtcNow,
                    delegate(CallbackInfo c) { return c.InstanceId == workflowInstanceId; });
                if (ci != null)
                {
                    timerId = ci.TimerId;
                    return true;
                }
            }
            timerId = Guid.Empty;
            return false;
        }
        private bool ProcessTimer(Guid workflowInstanceId)
        {
            bool retval = false;
            CallbackInfo cs = null;
            Guid timerId = Guid.Empty;
            lock (locker)
            {
                Guid expTimerId;
                if (HasExpiredTimer(workflowInstanceId, out expTimerId))
                {
                    cs = pendingScheduleRequests.Remove(expTimerId);
                }
            }
            try
            {
                if (cs != null)
                {
                    WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: Processing timer {0}", timerId);
                    cs.Callback(cs.InstanceId);
                    retval = true;
                }
            }
            catch (Exception e)
            {
                RaiseServicesExceptionNotHandledEvent(e, workflowInstanceId);
            }
            return retval;
        }

        private bool CanRun(Guid workflowInstanceId)
        {
            bool retval = false;
            lock (locker)
            {
                Guid timerId;
                retval = scheduleRequests.ContainsKey(workflowInstanceId) || HasExpiredTimer(workflowInstanceId, out timerId);
                WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: CanRun is {0}", retval);
            }
            return retval;
        }

        public bool RunWorkflow(Guid workflowInstanceId)
        {
            if (workflowInstanceId.Equals(Guid.Empty))
                throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, ExecutionStringManager.CantBeEmptyGuid, "workflowInstanceId"));

            WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "ManualWorkflowSchedulerService: Running workflow {0}", workflowInstanceId);

            bool retval = false; // return true if we do any work at all
            while (CanRun(workflowInstanceId))
            {
                if (RunOne(workflowInstanceId) || ProcessTimer(workflowInstanceId))
                    retval = true;  // did some work, try again
                else
                    break;  // no work done this iteration
            }
            return retval;
        }
        private Timer CreateTimerCallback(CallbackInfo info)
        {
            DateTime now = DateTime.UtcNow;
            TimeSpan span = (info.When > now) ? info.When - now : TimeSpan.Zero;
            // never let more than five minutes go by without checking
            if (span > fiveMinutes)
            {
                span = fiveMinutes;
            }
            return new Timer(timerCallback, info.InstanceId, span, infinite);
        }
        override protected void OnStarted()
        {
            base.OnStarted();
            if (this.timerCallback != null)
            {
                lock (locker)
                {
                    CallbackInfo ci = pendingScheduleRequests.Peek();
                    if (ci != null)
                        callbackTimer = CreateTimerCallback(ci);
                }
            }
            lock (locker)
            {
                if (queueCounters == null && this.Runtime.PerformanceCounterManager != null)
                {
                    queueCounters = this.Runtime.PerformanceCounterManager.CreateCounters(ExecutionStringManager.PerformanceCounterWorkflowsWaitingName);
                }
            }
        }
        protected internal override void Stop()
        {
            base.Stop();
            if (this.timerCallback != null)
            {
                lock (locker)
                {
                    if (callbackTimer != null)
                    {
                        callbackTimer.Dispose();
                        callbackTimer = null;
                    }
                }
            }
        }
        private void OnTimerCallback(object ignored)
        {
            CallbackInfo ci = null;
            try
            {
                lock (locker)
                {
                    if (State.Equals(WorkflowRuntimeServiceState.Started))
                    {
                        ci = pendingScheduleRequests.Peek();
                        if (ci != null)
                        {
                            if (ci.IsExpired)
                            {
                                WorkflowTrace.Host.TraceEvent(TraceEventType.Information, 0, "Timeout occured for timer for instance {0}", ci.InstanceId);
                                threadRunning = true;
                                pendingScheduleRequests.Dequeue();
                            }
                            else
                            {
                                callbackTimer = CreateTimerCallback(ci);
                            }
                        }
                    }
                }
                if (threadRunning)
                {
                    ci.Callback(ci.InstanceId);  // delivers the timer message
                    RunWorkflow(ci.InstanceId);
                }
            }
            catch (ThreadAbortException e)
            {
                WorkflowTrace.Host.TraceEvent(TraceEventType.Error, 0, "Timeout for instance, {0} threw exception {1}", ci == null ? Guid.Empty : ci.InstanceId, e.Message);
                RaiseServicesExceptionNotHandledEvent(e, ci.InstanceId);
                throw;
            }
            catch (Exception e)
            {
                WorkflowTrace.Host.TraceEvent(TraceEventType.Error, 0, "Timeout for instance, {0} threw exception {1}", ci == null ? Guid.Empty : ci.InstanceId, e.Message);
                RaiseServicesExceptionNotHandledEvent(e, ci.InstanceId);
            }
            finally
            {
                lock (locker)
                {
                    if (threadRunning)
                    {
                        threadRunning = false;
                        ci = pendingScheduleRequests.Peek();
                        if (ci != null)
                            callbackTimer = CreateTimerCallback(ci);
                    }
                }
            }
        }
        private void OnFirstElementChanged(object source, KeyedPriorityQueueHeadChangedEventArgs<CallbackInfo> e)
        {
            lock (locker)
            {
                if (threadRunning)
                    return;     // ignore when a timer thread is already processing a timer request
                if (callbackTimer != null)
                {
                    callbackTimer.Dispose();
                    callbackTimer = null;
                }
                if (e.NewFirstElement != null && this.State == WorkflowRuntimeServiceState.Started)
                {
                    callbackTimer = CreateTimerCallback(e.NewFirstElement);
                }
            }
        }
    }
}