bbvcommon 6.268.0.20100803
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/lib/NET35/bbv.Common.AsyncModule.dll +0 -0
- data/lib/NET35/bbv.Common.AsyncModule.xml +893 -0
- data/lib/NET35/bbv.Common.Data.XML +245 -0
- data/lib/NET35/bbv.Common.Data.dll +0 -0
- data/lib/NET35/bbv.Common.Diagnostics.XML +102 -0
- data/lib/NET35/bbv.Common.Diagnostics.dll +0 -0
- data/lib/NET35/bbv.Common.EvaluationEngine.dll +0 -0
- data/lib/NET35/bbv.Common.EventBroker.XML +3100 -0
- data/lib/NET35/bbv.Common.EventBroker.dll +0 -0
- data/lib/NET35/bbv.Common.Formatters.dll +0 -0
- data/lib/NET35/bbv.Common.Formatters.xml +74 -0
- data/lib/NET35/bbv.Common.IO.dll +0 -0
- data/lib/NET35/bbv.Common.IO.xml +1354 -0
- data/lib/NET35/bbv.Common.RuleEngine.dll +0 -0
- data/lib/NET35/bbv.Common.RuleEngine.xml +659 -0
- data/lib/NET35/bbv.Common.Security.XML +339 -0
- data/lib/NET35/bbv.Common.Security.dll +0 -0
- data/lib/NET35/bbv.Common.StateMachine.XML +2559 -0
- data/lib/NET35/bbv.Common.StateMachine.dll +0 -0
- data/lib/NET35/bbv.Common.TestUtilities.dll +0 -0
- data/lib/NET35/bbv.Common.TestUtilities.xml +696 -0
- data/lib/NET35/bbv.Common.Threading.XML +401 -0
- data/lib/NET35/bbv.Common.Threading.dll +0 -0
- data/lib/NET35/bbv.Common.Windows.dll +0 -0
- data/lib/NET35/bbv.Common.Windows.xml +114 -0
- data/lib/NET35/bbv.Common.XML +831 -0
- data/lib/NET35/bbv.Common.dll +0 -0
- metadata +118 -0
|
Binary file
|
|
@@ -0,0 +1,893 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>bbv.Common.AsyncModule</name>
|
|
5
|
+
</assembly>
|
|
6
|
+
<members>
|
|
7
|
+
<member name="T:bbv.Common.AsyncModule.Events.AfterConsumeMessageEventArgs">
|
|
8
|
+
<summary>
|
|
9
|
+
Event arguments for the AfterMessageConsume event.
|
|
10
|
+
</summary>
|
|
11
|
+
</member>
|
|
12
|
+
<member name="T:bbv.Common.AsyncModule.Events.ConsumeMessageEventArgs">
|
|
13
|
+
<summary>
|
|
14
|
+
The event arguments of the module controller events:
|
|
15
|
+
BeforeConsumeMessage and AfterConsumeMessage.
|
|
16
|
+
</summary>
|
|
17
|
+
</member>
|
|
18
|
+
<member name="M:bbv.Common.AsyncModule.Events.ConsumeMessageEventArgs.#ctor(System.Object,System.Object)">
|
|
19
|
+
<summary>
|
|
20
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.Events.ConsumeMessageEventArgs"/> class.
|
|
21
|
+
</summary>
|
|
22
|
+
<param name="module">The module, which consumes the message.</param>
|
|
23
|
+
<param name="message">The message to be consumed.</param>
|
|
24
|
+
</member>
|
|
25
|
+
<member name="P:bbv.Common.AsyncModule.Events.ConsumeMessageEventArgs.Module">
|
|
26
|
+
<summary>
|
|
27
|
+
Gets the module, which consumes the message.
|
|
28
|
+
</summary>
|
|
29
|
+
</member>
|
|
30
|
+
<member name="P:bbv.Common.AsyncModule.Events.ConsumeMessageEventArgs.Message">
|
|
31
|
+
<summary>
|
|
32
|
+
Gets the message to be consumed.
|
|
33
|
+
</summary>
|
|
34
|
+
</member>
|
|
35
|
+
<member name="M:bbv.Common.AsyncModule.Events.AfterConsumeMessageEventArgs.#ctor(System.Object,System.Object,System.Boolean)">
|
|
36
|
+
<summary>
|
|
37
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.Events.AfterConsumeMessageEventArgs"/> class.
|
|
38
|
+
</summary>
|
|
39
|
+
<param name="module">The module.</param>
|
|
40
|
+
<param name="message">The message.</param>
|
|
41
|
+
<param name="notSkipped">True if the message was consumed, otherwise false (message was skipped).</param>
|
|
42
|
+
</member>
|
|
43
|
+
<member name="P:bbv.Common.AsyncModule.Events.AfterConsumeMessageEventArgs.NotSkipped">
|
|
44
|
+
<summary>
|
|
45
|
+
Gets a value indicating whether the message was actually consumed and not skipped.
|
|
46
|
+
</summary>
|
|
47
|
+
<value><c>true</c> if message was not skipped otherwise, <c>false</c>.</value>
|
|
48
|
+
</member>
|
|
49
|
+
<member name="T:bbv.Common.AsyncModule.Events.BeforeConsumeMessageEventArgs">
|
|
50
|
+
<summary>
|
|
51
|
+
Event args for the <see cref="E:bbv.Common.AsyncModule.IModuleController.BeforeConsumeMessage"/> event.
|
|
52
|
+
</summary>
|
|
53
|
+
</member>
|
|
54
|
+
<member name="M:bbv.Common.AsyncModule.Events.BeforeConsumeMessageEventArgs.#ctor(System.Object,System.Object)">
|
|
55
|
+
<summary>
|
|
56
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.Events.BeforeConsumeMessageEventArgs"/> class.
|
|
57
|
+
</summary>
|
|
58
|
+
<param name="module">The module, which consumes the message.</param>
|
|
59
|
+
<param name="message">The message to be consumed.</param>
|
|
60
|
+
</member>
|
|
61
|
+
<member name="P:bbv.Common.AsyncModule.Events.BeforeConsumeMessageEventArgs.Cancel">
|
|
62
|
+
<summary>
|
|
63
|
+
Gets or sets a value indicating whether this <see cref="T:bbv.Common.AsyncModule.Events.BeforeConsumeMessageEventArgs"/> is cancel (the message will not be passed to its handler).
|
|
64
|
+
</summary>
|
|
65
|
+
<value><c>true</c> if cancel; otherwise, <c>false</c>.</value>
|
|
66
|
+
</member>
|
|
67
|
+
<member name="T:bbv.Common.AsyncModule.Events.ConsumeMessageExceptionEventArgs">
|
|
68
|
+
<summary>
|
|
69
|
+
The event arguments of the module controller event
|
|
70
|
+
ConsumeMessageExceptionOccurred.
|
|
71
|
+
</summary>
|
|
72
|
+
</member>
|
|
73
|
+
<member name="M:bbv.Common.AsyncModule.Events.ConsumeMessageExceptionEventArgs.#ctor(System.Object,System.Object,System.Exception)">
|
|
74
|
+
<summary>
|
|
75
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.Events.ConsumeMessageExceptionEventArgs"/> class.
|
|
76
|
+
</summary>
|
|
77
|
+
<param name="module">The module.</param>
|
|
78
|
+
<param name="message">The message causing the exception.</param>
|
|
79
|
+
<param name="exception">The exception.</param>
|
|
80
|
+
</member>
|
|
81
|
+
<member name="P:bbv.Common.AsyncModule.Events.ConsumeMessageExceptionEventArgs.Exception">
|
|
82
|
+
<summary>
|
|
83
|
+
Gets the exception, which occured during the call to the
|
|
84
|
+
message consumer.
|
|
85
|
+
</summary>
|
|
86
|
+
</member>
|
|
87
|
+
<member name="P:bbv.Common.AsyncModule.Events.ConsumeMessageExceptionEventArgs.ExceptionHandled">
|
|
88
|
+
<summary>
|
|
89
|
+
Gets or sets a value indicating whether the extension
|
|
90
|
+
has handled the exception and no further action of the
|
|
91
|
+
module controller is necessary.
|
|
92
|
+
</summary>
|
|
93
|
+
</member>
|
|
94
|
+
<member name="T:bbv.Common.AsyncModule.Events.EnqueueMessageEventArgs">
|
|
95
|
+
<summary>
|
|
96
|
+
The event arguments of the module controller events:
|
|
97
|
+
BeforeEnqueueMessage and AfterEnqueueMessage.
|
|
98
|
+
</summary>
|
|
99
|
+
</member>
|
|
100
|
+
<member name="M:bbv.Common.AsyncModule.Events.EnqueueMessageEventArgs.#ctor(System.Object,System.Object)">
|
|
101
|
+
<summary>
|
|
102
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.Events.EnqueueMessageEventArgs"/> class.
|
|
103
|
+
</summary>
|
|
104
|
+
<param name="module">The module, which consumes the message.</param>
|
|
105
|
+
<param name="message">The message to be consumed.</param>
|
|
106
|
+
</member>
|
|
107
|
+
<member name="P:bbv.Common.AsyncModule.Events.EnqueueMessageEventArgs.Module">
|
|
108
|
+
<summary>
|
|
109
|
+
Gets the module, which consumes the message.
|
|
110
|
+
</summary>
|
|
111
|
+
</member>
|
|
112
|
+
<member name="P:bbv.Common.AsyncModule.Events.EnqueueMessageEventArgs.Message">
|
|
113
|
+
<summary>
|
|
114
|
+
Gets the message to be consumed.
|
|
115
|
+
</summary>
|
|
116
|
+
</member>
|
|
117
|
+
<member name="T:bbv.Common.AsyncModule.Events.UnhandledModuleExceptionEventArgs">
|
|
118
|
+
<summary>
|
|
119
|
+
The event arguments of the UnhandledExceptionOccurred event
|
|
120
|
+
of the module coordinator.
|
|
121
|
+
</summary>
|
|
122
|
+
</member>
|
|
123
|
+
<member name="M:bbv.Common.AsyncModule.Events.UnhandledModuleExceptionEventArgs.#ctor(System.Object,System.Object,System.Exception)">
|
|
124
|
+
<summary>
|
|
125
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.Events.UnhandledModuleExceptionEventArgs"/> class.
|
|
126
|
+
</summary>
|
|
127
|
+
<param name="module">The module, where the unhandled exception occurred.</param>
|
|
128
|
+
<param name="message">The message causing the exception. Null if not a message is causing the exception.</param>
|
|
129
|
+
<param name="unhandledException">The unhandled exception.</param>
|
|
130
|
+
</member>
|
|
131
|
+
<member name="P:bbv.Common.AsyncModule.Events.UnhandledModuleExceptionEventArgs.Module">
|
|
132
|
+
<summary>
|
|
133
|
+
Gets the module, where the unhandled exception occurred.
|
|
134
|
+
</summary>
|
|
135
|
+
</member>
|
|
136
|
+
<member name="P:bbv.Common.AsyncModule.Events.UnhandledModuleExceptionEventArgs.UnhandledException">
|
|
137
|
+
<summary>
|
|
138
|
+
Gets the exception.
|
|
139
|
+
</summary>
|
|
140
|
+
</member>
|
|
141
|
+
<member name="P:bbv.Common.AsyncModule.Events.UnhandledModuleExceptionEventArgs.Message">
|
|
142
|
+
<summary>
|
|
143
|
+
Gets the message causing the exception. Null if not a message is causing the exception.
|
|
144
|
+
</summary>
|
|
145
|
+
</member>
|
|
146
|
+
<member name="T:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension">
|
|
147
|
+
<summary>
|
|
148
|
+
This extension consums all pending messages before stopping the
|
|
149
|
+
module controller.
|
|
150
|
+
</summary>
|
|
151
|
+
</member>
|
|
152
|
+
<member name="T:bbv.Common.AsyncModule.Extensions.IModuleExtension">
|
|
153
|
+
<summary>
|
|
154
|
+
If a module needs to add eventhandlers to the
|
|
155
|
+
events of the module controller, it has to implement
|
|
156
|
+
this interface, so that the module controller can
|
|
157
|
+
call Attach and Detach.
|
|
158
|
+
</summary>
|
|
159
|
+
</member>
|
|
160
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.IModuleExtension.Attach">
|
|
161
|
+
<summary>
|
|
162
|
+
Called by the module controller to allow the extension
|
|
163
|
+
to register itself for events.
|
|
164
|
+
</summary>
|
|
165
|
+
</member>
|
|
166
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.IModuleExtension.Detach">
|
|
167
|
+
<summary>
|
|
168
|
+
Called by the module controller to allow the extension
|
|
169
|
+
to remove its event handlers.
|
|
170
|
+
</summary>
|
|
171
|
+
</member>
|
|
172
|
+
<member name="P:bbv.Common.AsyncModule.Extensions.IModuleExtension.ModuleController">
|
|
173
|
+
<summary>
|
|
174
|
+
Sets the controller this extension belongs to.
|
|
175
|
+
</summary>
|
|
176
|
+
<value>The controller.</value>
|
|
177
|
+
</member>
|
|
178
|
+
<member name="F:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.pendingMessagesWaitTime">
|
|
179
|
+
<summary>
|
|
180
|
+
Time to wait (ms) for pending messages before the module controller is stopped.
|
|
181
|
+
</summary>
|
|
182
|
+
</member>
|
|
183
|
+
<member name="F:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.pendingMessagesCheckInterval">
|
|
184
|
+
<summary>
|
|
185
|
+
In this interval it is checked if there are pending messages.
|
|
186
|
+
</summary>
|
|
187
|
+
</member>
|
|
188
|
+
<member name="F:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.controllerIsStopping">
|
|
189
|
+
<summary>
|
|
190
|
+
True if the module controller of this extension is stopping.
|
|
191
|
+
</summary>
|
|
192
|
+
</member>
|
|
193
|
+
<member name="F:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.moduleController">
|
|
194
|
+
<summary>
|
|
195
|
+
The module controller the extension belongs to. This
|
|
196
|
+
field is set through the property ModuleController with
|
|
197
|
+
dependency injection.
|
|
198
|
+
</summary>
|
|
199
|
+
</member>
|
|
200
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.#ctor(System.Int32,System.Int32)">
|
|
201
|
+
<summary>
|
|
202
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension"/> class.
|
|
203
|
+
</summary>
|
|
204
|
+
<param name="pendingMessagesWaitTime">Time to wait (ms) for pending messages before the module controller is stopped.</param>
|
|
205
|
+
<param name="pendingMessagesCheckInterval">In this interval it is checked if there are pending messages.</param>
|
|
206
|
+
</member>
|
|
207
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.Attach">
|
|
208
|
+
<summary>
|
|
209
|
+
Attaches the extension to the module controller.
|
|
210
|
+
</summary>
|
|
211
|
+
</member>
|
|
212
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.Detach">
|
|
213
|
+
<summary>
|
|
214
|
+
Removes the connection to the module controller.
|
|
215
|
+
</summary>
|
|
216
|
+
</member>
|
|
217
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.OnBeforeEnqueueMessage(System.Object,bbv.Common.AsyncModule.Events.EnqueueMessageEventArgs)">
|
|
218
|
+
<summary>
|
|
219
|
+
If the module controller is stopping and messages are still enqueue, we ignore them.
|
|
220
|
+
</summary>
|
|
221
|
+
<param name="sender">Sender is ignored.</param>
|
|
222
|
+
<param name="e">Used to prevent the message from being enqueued.</param>
|
|
223
|
+
</member>
|
|
224
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.OnBeforeModuleStop(System.Object,System.EventArgs)">
|
|
225
|
+
<summary>
|
|
226
|
+
Waits until all messages are consumed or until the PendingMessageWaitTime has passed.
|
|
227
|
+
</summary>
|
|
228
|
+
<param name="sender">Sender is ignored.</param>
|
|
229
|
+
<param name="e">Event args are ignored.</param>
|
|
230
|
+
</member>
|
|
231
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.OnAfterModuleStop(System.Object,System.EventArgs)">
|
|
232
|
+
<summary>
|
|
233
|
+
Resets the flag, which indicates that the module controller is stopping.
|
|
234
|
+
</summary>
|
|
235
|
+
<param name="sender">Sender is ignored.</param>
|
|
236
|
+
<param name="e">Event args are ignored.</param>
|
|
237
|
+
</member>
|
|
238
|
+
<member name="P:bbv.Common.AsyncModule.Extensions.ConsumePendingMessagesBeforeStopExtension.ModuleController">
|
|
239
|
+
<summary>
|
|
240
|
+
Sets the module controller this extension belongs to.
|
|
241
|
+
</summary>
|
|
242
|
+
</member>
|
|
243
|
+
<member name="T:bbv.Common.AsyncModule.Extensions.ModuleExtensionCollection">
|
|
244
|
+
<summary>
|
|
245
|
+
This collection contains module extensions.
|
|
246
|
+
</summary>
|
|
247
|
+
</member>
|
|
248
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ModuleExtensionCollection.Add(System.Object,System.Object)">
|
|
249
|
+
<summary>
|
|
250
|
+
Adds the call to Attach to the standard behavior of the method Add.
|
|
251
|
+
</summary>
|
|
252
|
+
<param name="key">The key of the element to add.</param>
|
|
253
|
+
<param name="value">The value of the element to add. The value can be null.</param>
|
|
254
|
+
<exception cref="T:System.ArgumentNullException">
|
|
255
|
+
<paramref name="key"/> is null.
|
|
256
|
+
</exception>
|
|
257
|
+
<exception cref="T:System.ArgumentException">
|
|
258
|
+
An element with the same key already exists in the <see cref="T:System.Collections.Hashtable"/>.
|
|
259
|
+
</exception>
|
|
260
|
+
<exception cref="T:System.NotSupportedException">
|
|
261
|
+
The <see cref="T:System.Collections.Hashtable"/> is read-only.
|
|
262
|
+
-or-
|
|
263
|
+
The <see cref="T:System.Collections.Hashtable"/> has a fixed size.
|
|
264
|
+
</exception>
|
|
265
|
+
</member>
|
|
266
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ModuleExtensionCollection.Remove(System.Object)">
|
|
267
|
+
<summary>
|
|
268
|
+
Adds the call to Detach and the tolerance for not existing keys to
|
|
269
|
+
the standard behavior of the method Remove.
|
|
270
|
+
</summary>
|
|
271
|
+
<param name="key">The key of the element to remove.</param>
|
|
272
|
+
<exception cref="T:System.ArgumentNullException">
|
|
273
|
+
<paramref name="key"/> is null.
|
|
274
|
+
</exception>
|
|
275
|
+
<exception cref="T:System.NotSupportedException">
|
|
276
|
+
The <see cref="T:System.Collections.Hashtable"/> is read-only.
|
|
277
|
+
-or-
|
|
278
|
+
The <see cref="T:System.Collections.Hashtable"/> has a fixed size.
|
|
279
|
+
</exception>
|
|
280
|
+
</member>
|
|
281
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ModuleExtensionCollection.Add``1(System.Object)">
|
|
282
|
+
<summary>
|
|
283
|
+
Adds a new extension.
|
|
284
|
+
</summary>
|
|
285
|
+
<typeparam name="TExtension">
|
|
286
|
+
With this type the extension is retrieved by GetExtension().
|
|
287
|
+
</typeparam>
|
|
288
|
+
<param name="extensionInstance">
|
|
289
|
+
The actual extension instance.
|
|
290
|
+
</param>
|
|
291
|
+
</member>
|
|
292
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ModuleExtensionCollection.Get``1">
|
|
293
|
+
<summary>
|
|
294
|
+
Gets the extension from the module which was registered
|
|
295
|
+
with the type TExtensionType.
|
|
296
|
+
</summary>
|
|
297
|
+
<typeparam name="TExtension">
|
|
298
|
+
The type identifying the extension to get.
|
|
299
|
+
</typeparam>
|
|
300
|
+
<returns>
|
|
301
|
+
See above.
|
|
302
|
+
</returns>
|
|
303
|
+
</member>
|
|
304
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ModuleExtensionCollection.RemoveAndDetach(System.Object)">
|
|
305
|
+
<summary>
|
|
306
|
+
Removes and detaches an extension.
|
|
307
|
+
</summary>
|
|
308
|
+
<param name="extensionType">
|
|
309
|
+
The type of the extension to remove.
|
|
310
|
+
</param>
|
|
311
|
+
</member>
|
|
312
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.ModuleExtensionCollection.AddAndAttach(System.Object,System.Object)">
|
|
313
|
+
<summary>
|
|
314
|
+
Add the extension to the dictionary. If the extension is of the
|
|
315
|
+
type IModuleExtension, the Attach method of the extension is called,
|
|
316
|
+
so that the extension can add event handlers to the extension points.
|
|
317
|
+
</summary>
|
|
318
|
+
<param name="extensionType">
|
|
319
|
+
Extension type to add.
|
|
320
|
+
</param>
|
|
321
|
+
<param name="extensionInstance">
|
|
322
|
+
The actual extension.
|
|
323
|
+
</param>
|
|
324
|
+
</member>
|
|
325
|
+
<member name="T:bbv.Common.AsyncModule.Extensions.SkipIfDuplicateInQueueModuleExtension">
|
|
326
|
+
<summary>
|
|
327
|
+
Extension that cancels the consumation of a message if there is a message in the queue that is equal to it.
|
|
328
|
+
</summary>
|
|
329
|
+
</member>
|
|
330
|
+
<member name="F:bbv.Common.AsyncModule.Extensions.SkipIfDuplicateInQueueModuleExtension.moduleController">
|
|
331
|
+
<summary>
|
|
332
|
+
Module controller this extension is registered to.
|
|
333
|
+
</summary>
|
|
334
|
+
</member>
|
|
335
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.SkipIfDuplicateInQueueModuleExtension.Attach">
|
|
336
|
+
<summary>
|
|
337
|
+
Called by the module controller to allow the extension
|
|
338
|
+
to register itself for events.
|
|
339
|
+
</summary>
|
|
340
|
+
</member>
|
|
341
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.SkipIfDuplicateInQueueModuleExtension.Detach">
|
|
342
|
+
<summary>
|
|
343
|
+
Called by the module controller to allow the extension
|
|
344
|
+
to remove its event handlers.
|
|
345
|
+
</summary>
|
|
346
|
+
</member>
|
|
347
|
+
<member name="M:bbv.Common.AsyncModule.Extensions.SkipIfDuplicateInQueueModuleExtension.ModuleController_BeforeConsumeMessage(System.Object,bbv.Common.AsyncModule.Events.BeforeConsumeMessageEventArgs)">
|
|
348
|
+
<summary>
|
|
349
|
+
Handles the BeforeConsumeMessage event of the ModuleController.
|
|
350
|
+
</summary>
|
|
351
|
+
<param name="sender">The source of the event.</param>
|
|
352
|
+
<param name="e">The <see cref="T:bbv.Common.AsyncModule.Events.BeforeConsumeMessageEventArgs"/> instance containing the event data.</param>
|
|
353
|
+
</member>
|
|
354
|
+
<member name="P:bbv.Common.AsyncModule.Extensions.SkipIfDuplicateInQueueModuleExtension.ModuleController">
|
|
355
|
+
<summary>
|
|
356
|
+
Sets the controller this extension belongs to.
|
|
357
|
+
</summary>
|
|
358
|
+
<value>The controller this extension was added to.</value>
|
|
359
|
+
</member>
|
|
360
|
+
<member name="T:bbv.Common.AsyncModule.IModuleController">
|
|
361
|
+
<summary>
|
|
362
|
+
The module controller is accessed through this interface.
|
|
363
|
+
</summary>
|
|
364
|
+
</member>
|
|
365
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.EnqueueMessage(System.Object)">
|
|
366
|
+
<summary>
|
|
367
|
+
Called by the coordinator to send a message to the module
|
|
368
|
+
managed by the controller.
|
|
369
|
+
</summary>
|
|
370
|
+
<param name="message">
|
|
371
|
+
The message can be of any type as long as the sender and
|
|
372
|
+
the receiver both know it.
|
|
373
|
+
</param>
|
|
374
|
+
</member>
|
|
375
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.EnqueuePriorityMessage(System.Object)">
|
|
376
|
+
<summary>
|
|
377
|
+
Puts a message to the front of the message queue of the module managed
|
|
378
|
+
by this controller.
|
|
379
|
+
</summary>
|
|
380
|
+
<param name="message">
|
|
381
|
+
The message to be enqueued.
|
|
382
|
+
</param>
|
|
383
|
+
</member>
|
|
384
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.ClearMessages">
|
|
385
|
+
<summary>
|
|
386
|
+
Clears all messages still in the queue and returns them.
|
|
387
|
+
</summary>
|
|
388
|
+
<returns>All messages that were cleared from the queue.</returns>
|
|
389
|
+
</member>
|
|
390
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.Start">
|
|
391
|
+
<summary>
|
|
392
|
+
Starts the message consumer thread(s). If the thread(s) is/are already
|
|
393
|
+
started this method returns immediately.
|
|
394
|
+
</summary>
|
|
395
|
+
</member>
|
|
396
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.Stop">
|
|
397
|
+
<summary>
|
|
398
|
+
Stops the message consumer thread(s).
|
|
399
|
+
</summary>
|
|
400
|
+
</member>
|
|
401
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.Stop(System.TimeSpan)">
|
|
402
|
+
<summary>
|
|
403
|
+
Stops the message consumer thread(s) after finshing
|
|
404
|
+
an message currently processed. If the thread is
|
|
405
|
+
not responding anymore it is killed.
|
|
406
|
+
</summary>
|
|
407
|
+
<param name="timeout">The timeout that defines how long we will wait until the worker threads are killed, i.e. how long a currently
|
|
408
|
+
processing message is tolerated.</param>
|
|
409
|
+
</member>
|
|
410
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.StopAsync">
|
|
411
|
+
<summary>
|
|
412
|
+
Stops the message consumer threads. This method can be called from a message consumer thread.
|
|
413
|
+
</summary>
|
|
414
|
+
</member>
|
|
415
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.AddExtension``1(``0)">
|
|
416
|
+
<summary>
|
|
417
|
+
Adds an extension to this controller.
|
|
418
|
+
</summary>
|
|
419
|
+
<typeparam name="TExtension">The type of the extension.</typeparam>
|
|
420
|
+
<param name="extension">The extension.</param>
|
|
421
|
+
</member>
|
|
422
|
+
<member name="M:bbv.Common.AsyncModule.IModuleController.GetExtension``1">
|
|
423
|
+
<summary>
|
|
424
|
+
Gets the extension with the specified type.
|
|
425
|
+
</summary>
|
|
426
|
+
<typeparam name="TExtension">The type of the extension.</typeparam>
|
|
427
|
+
<returns>The extension with the specified type.</returns>
|
|
428
|
+
</member>
|
|
429
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.BeforeModuleStart">
|
|
430
|
+
<summary>
|
|
431
|
+
This event is raised before the module is started. Extensions
|
|
432
|
+
use this event to insert actions before the module starts.
|
|
433
|
+
</summary>
|
|
434
|
+
</member>
|
|
435
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.AfterModuleStart">
|
|
436
|
+
<summary>
|
|
437
|
+
This event is raised after the module has been started. Extensions
|
|
438
|
+
use this event to insert actions after the module starts.
|
|
439
|
+
</summary>
|
|
440
|
+
</member>
|
|
441
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.BeforeModuleStop">
|
|
442
|
+
<summary>
|
|
443
|
+
This event is raised before the module is stopped. Extensions
|
|
444
|
+
use this event to insert actions before the module stops.
|
|
445
|
+
</summary>
|
|
446
|
+
</member>
|
|
447
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.AfterModuleStop">
|
|
448
|
+
<summary>
|
|
449
|
+
This event is raised after the module has been stopped. Extensions
|
|
450
|
+
use this event to insert actions after the module stops.
|
|
451
|
+
</summary>
|
|
452
|
+
</member>
|
|
453
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.BeforeConsumeMessage">
|
|
454
|
+
<summary>
|
|
455
|
+
This event is raised before a call to the message consumer. Extensions
|
|
456
|
+
use this event to insert actions before the message is consumed.
|
|
457
|
+
</summary>
|
|
458
|
+
</member>
|
|
459
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.AfterConsumeMessage">
|
|
460
|
+
<summary>
|
|
461
|
+
This event is raised after a call to the message consumer. Extensions
|
|
462
|
+
use this event to insert actions after the message has been consumed.
|
|
463
|
+
</summary>
|
|
464
|
+
</member>
|
|
465
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.BeforeEnqueueMessage">
|
|
466
|
+
<summary>
|
|
467
|
+
This event is raised before the message is enqueued. Extensions
|
|
468
|
+
use this event to insert actions before the message is enqueued.
|
|
469
|
+
</summary>
|
|
470
|
+
</member>
|
|
471
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.AfterEnqueueMessage">
|
|
472
|
+
<summary>
|
|
473
|
+
This event is raised after a message was enqueued. Extensions
|
|
474
|
+
use this event to insert actions after the message is enqueued.
|
|
475
|
+
</summary>
|
|
476
|
+
</member>
|
|
477
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.ConsumeMessageExceptionOccurred">
|
|
478
|
+
<summary>
|
|
479
|
+
This event is raised when an excpetion is thrown during consuming a message.
|
|
480
|
+
This event is used to react meaningful to exceptions like a retrying mechanism.
|
|
481
|
+
The event handler can return a value indicating whether the exception was handled.
|
|
482
|
+
</summary>
|
|
483
|
+
</member>
|
|
484
|
+
<member name="E:bbv.Common.AsyncModule.IModuleController.UnhandledModuleExceptionOccured">
|
|
485
|
+
<summary>
|
|
486
|
+
This event is raised when an unhandled exception in a module occured that was not handled
|
|
487
|
+
by the <see cref="E:bbv.Common.AsyncModule.IModuleController.ConsumeMessageExceptionOccurred"/> event.
|
|
488
|
+
This event is just for notification, afterwards the module will continue with the next message.
|
|
489
|
+
</summary>
|
|
490
|
+
</member>
|
|
491
|
+
<member name="P:bbv.Common.AsyncModule.IModuleController.MessageCount">
|
|
492
|
+
<summary>
|
|
493
|
+
Gets the number of messages in the message queue.
|
|
494
|
+
</summary>
|
|
495
|
+
</member>
|
|
496
|
+
<member name="P:bbv.Common.AsyncModule.IModuleController.Messages">
|
|
497
|
+
<summary>
|
|
498
|
+
Gets the messages in the message queue.
|
|
499
|
+
</summary>
|
|
500
|
+
<value>The messages.</value>
|
|
501
|
+
</member>
|
|
502
|
+
<member name="P:bbv.Common.AsyncModule.IModuleController.IsAlive">
|
|
503
|
+
<summary>
|
|
504
|
+
Gets a value indicating whether the thread(s) managed by the module controller is/are
|
|
505
|
+
alive.
|
|
506
|
+
</summary>
|
|
507
|
+
<value><c>true</c> if this instance is alive; otherwise, <c>false</c>.</value>
|
|
508
|
+
</member>
|
|
509
|
+
<member name="T:bbv.Common.AsyncModule.MessageConsumerAttribute">
|
|
510
|
+
<summary>
|
|
511
|
+
If a method is marked with this attribute, it is
|
|
512
|
+
recoginzed by the ModuleCoordinator as sink for
|
|
513
|
+
messages.
|
|
514
|
+
</summary>
|
|
515
|
+
</member>
|
|
516
|
+
<member name="T:bbv.Common.AsyncModule.ModuleController">
|
|
517
|
+
<summary>
|
|
518
|
+
The module coordinator adds a message queue and a message
|
|
519
|
+
consumer thread to the controlled object.
|
|
520
|
+
</summary>
|
|
521
|
+
</member>
|
|
522
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.DefaultNumberOfThreads">
|
|
523
|
+
<summary>
|
|
524
|
+
Default number of threads used to consume messages.
|
|
525
|
+
</summary>
|
|
526
|
+
</member>
|
|
527
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.log">
|
|
528
|
+
<summary>
|
|
529
|
+
Holds a reference to the logger.
|
|
530
|
+
</summary>
|
|
531
|
+
</member>
|
|
532
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.threadStoppingLock">
|
|
533
|
+
<summary>
|
|
534
|
+
Lock object the access <see cref="F:bbv.Common.AsyncModule.ModuleController.threadStopping"/> field.
|
|
535
|
+
</summary>
|
|
536
|
+
</member>
|
|
537
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.lockingObject">
|
|
538
|
+
<summary>
|
|
539
|
+
Lock object which synchronizes producer and consumer.
|
|
540
|
+
</summary>
|
|
541
|
+
</member>
|
|
542
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.DefaultTimeOut">
|
|
543
|
+
<summary>
|
|
544
|
+
Default timeout that defines how long the controller waits for a consuming message
|
|
545
|
+
before killing the worker thread.
|
|
546
|
+
</summary>
|
|
547
|
+
</member>
|
|
548
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.controlledModule">
|
|
549
|
+
<summary>
|
|
550
|
+
The module controlled by the controller.
|
|
551
|
+
</summary>
|
|
552
|
+
</member>
|
|
553
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.extensions">
|
|
554
|
+
<summary>
|
|
555
|
+
The extensions of the module.
|
|
556
|
+
</summary>
|
|
557
|
+
</member>
|
|
558
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.runWithBackgroundThread">
|
|
559
|
+
<summary>
|
|
560
|
+
Whether the worker threads are background threads or not.
|
|
561
|
+
</summary>
|
|
562
|
+
</member>
|
|
563
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.numberOfThreads">
|
|
564
|
+
<summary>
|
|
565
|
+
Number of threads used to consume messages.
|
|
566
|
+
</summary>
|
|
567
|
+
</member>
|
|
568
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.messageQueue">
|
|
569
|
+
<summary>
|
|
570
|
+
Message queue. Is filled through the PostMessage method
|
|
571
|
+
of the ModuleCoordinator. The messages are consumed by
|
|
572
|
+
the configured consumer delegate.
|
|
573
|
+
</summary>
|
|
574
|
+
</member>
|
|
575
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.messageConsumerThreads">
|
|
576
|
+
<summary>
|
|
577
|
+
This threads listen to messages which are placed in
|
|
578
|
+
the message queue.
|
|
579
|
+
</summary>
|
|
580
|
+
</member>
|
|
581
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.consumeMessageMethodInfos">
|
|
582
|
+
<summary>
|
|
583
|
+
A list of message consumer methods.
|
|
584
|
+
</summary>
|
|
585
|
+
</member>
|
|
586
|
+
<member name="F:bbv.Common.AsyncModule.ModuleController.threadStopping">
|
|
587
|
+
<summary>
|
|
588
|
+
Indicates whether we are stopping worker threads.
|
|
589
|
+
</summary>
|
|
590
|
+
</member>
|
|
591
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.#ctor(System.Object,System.Boolean)">
|
|
592
|
+
<summary>
|
|
593
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.ModuleController"/> class with one single worker thread.
|
|
594
|
+
</summary>
|
|
595
|
+
<param name="module">The module.</param>
|
|
596
|
+
<param name="runWithBackgroundThread">Whether the worker thread should be a background thread.</param>
|
|
597
|
+
</member>
|
|
598
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.#ctor(System.Object)">
|
|
599
|
+
<summary>
|
|
600
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.ModuleController"/> class with one single (foreground) worker thread.
|
|
601
|
+
</summary>
|
|
602
|
+
<param name="module">The module to be controlled by this controller.</param>
|
|
603
|
+
</member>
|
|
604
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.#ctor(System.Object,System.Int32)">
|
|
605
|
+
<summary>
|
|
606
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.ModuleController"/> class with <paramref name="numberOfThreads"/> (foreground) worker threads.
|
|
607
|
+
</summary>
|
|
608
|
+
<param name="module">The module.</param>
|
|
609
|
+
<param name="numberOfThreads">The number of threads.</param>
|
|
610
|
+
</member>
|
|
611
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.#ctor(System.Object,System.Int32,System.Boolean,System.String)">
|
|
612
|
+
<summary>
|
|
613
|
+
Initializes a new instance of the <see cref="T:bbv.Common.AsyncModule.ModuleController"/> class.
|
|
614
|
+
</summary>
|
|
615
|
+
<param name="module">The module to be controlled by this controller.</param>
|
|
616
|
+
<param name="numberOfThreads">The number of threads used to consume messages.</param>
|
|
617
|
+
<param name="runWithBackgroundThread">Whether the worker thread(s) should be a background thread(s).</param>
|
|
618
|
+
<param name="logger">The logger used for log messages. If null then the standard logger of this class is used.</param>
|
|
619
|
+
</member>
|
|
620
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.AddExtension``1(``0)">
|
|
621
|
+
<summary>
|
|
622
|
+
Adds an extension to this controller.
|
|
623
|
+
</summary>
|
|
624
|
+
<typeparam name="TExtension">The type of the extension.</typeparam>
|
|
625
|
+
<param name="extension">The extension.</param>
|
|
626
|
+
</member>
|
|
627
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.GetExtension``1">
|
|
628
|
+
<summary>
|
|
629
|
+
Gets the extension with the specified type.
|
|
630
|
+
</summary>
|
|
631
|
+
<typeparam name="TExtension">The type of the extension.</typeparam>
|
|
632
|
+
<returns>The extension with the specified type.</returns>
|
|
633
|
+
</member>
|
|
634
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.EnqueueMessage(System.Object)">
|
|
635
|
+
<summary>
|
|
636
|
+
Puts a message into the message queue of the module managed
|
|
637
|
+
by this controller.
|
|
638
|
+
</summary>
|
|
639
|
+
<param name="message">
|
|
640
|
+
The message to be enqueued.
|
|
641
|
+
</param>
|
|
642
|
+
</member>
|
|
643
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.EnqueuePriorityMessage(System.Object)">
|
|
644
|
+
<summary>
|
|
645
|
+
Puts a message to the front of the message queue of the module managed
|
|
646
|
+
by this controller.
|
|
647
|
+
</summary>
|
|
648
|
+
<param name="message">
|
|
649
|
+
The message to be enqueued.
|
|
650
|
+
</param>
|
|
651
|
+
</member>
|
|
652
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.ClearMessages">
|
|
653
|
+
<summary>
|
|
654
|
+
Clears all messages still in the queue and returns them.
|
|
655
|
+
</summary>
|
|
656
|
+
<returns>
|
|
657
|
+
All messages that were cleared from the queue.
|
|
658
|
+
</returns>
|
|
659
|
+
</member>
|
|
660
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.Start">
|
|
661
|
+
<summary>
|
|
662
|
+
Starts the message consumer thread.
|
|
663
|
+
</summary>
|
|
664
|
+
</member>
|
|
665
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.StopAsync">
|
|
666
|
+
<summary>
|
|
667
|
+
Stops the message consumer thread. If a message is currently processed, this is finished first.
|
|
668
|
+
If the thread does not response in a given time, it is aborted.
|
|
669
|
+
If the thread is not started then nothing happens but a log entry.
|
|
670
|
+
</summary>
|
|
671
|
+
</member>
|
|
672
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.Stop">
|
|
673
|
+
<summary>
|
|
674
|
+
Stops the message consumer thread(s) with default timeout.
|
|
675
|
+
This method must not be called on the worker thread of the module.
|
|
676
|
+
</summary>
|
|
677
|
+
<exception cref="T:System.InvalidOperationException">
|
|
678
|
+
Thrown when this method is called from the worker thread itself. This would lead to a <see cref="T:System.Threading.ThreadAbortException"/>.
|
|
679
|
+
</exception>
|
|
680
|
+
</member>
|
|
681
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.Stop(System.TimeSpan)">
|
|
682
|
+
<summary>
|
|
683
|
+
Stops the message consumer thread(s) after finishing
|
|
684
|
+
an message currently processed. If the thread is
|
|
685
|
+
not responding anymore it is killed.
|
|
686
|
+
This method must not be called on the worker thread of the module.
|
|
687
|
+
</summary>
|
|
688
|
+
<param name="timeout">The timeout that defines how long we will wait until the worker threads are killed, i.e. how long a currently
|
|
689
|
+
processing message is tolerated.</param>
|
|
690
|
+
<exception cref="T:System.InvalidOperationException">
|
|
691
|
+
Thrown when this method is called from the worker thread itself. This would lead to a <see cref="T:System.Threading.ThreadAbortException"/>.
|
|
692
|
+
</exception>
|
|
693
|
+
</member>
|
|
694
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.GetConsumeMessageMethodInfos(System.Object)">
|
|
695
|
+
<summary>
|
|
696
|
+
Checks the module for MessageConsumer attributes with reflection.
|
|
697
|
+
The corresponding methods are added to the list of message consumer
|
|
698
|
+
methods. If there are no valid MessageConsumer attributes, an exception is thrown.
|
|
699
|
+
</summary>
|
|
700
|
+
<param name="module">
|
|
701
|
+
The module to inspect.
|
|
702
|
+
</param>
|
|
703
|
+
<returns>
|
|
704
|
+
A list of methods which are marked with the MessageConsumer attribute.
|
|
705
|
+
</returns>
|
|
706
|
+
<exception cref="T:System.ArgumentException">Thrown if no message handle method is found.</exception>
|
|
707
|
+
</member>
|
|
708
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.EnqueueMessage(System.Object,System.Boolean)">
|
|
709
|
+
<summary>
|
|
710
|
+
Enqueues the message.
|
|
711
|
+
</summary>
|
|
712
|
+
<param name="message">The message.</param>
|
|
713
|
+
<param name="priority">if set to <c>true</c> then the message is enqueued at the front; otherwise at the end of the queue.</param>
|
|
714
|
+
</member>
|
|
715
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnBeforeModuleStart">
|
|
716
|
+
<summary>
|
|
717
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.BeforeModuleStart"/> event.
|
|
718
|
+
</summary>
|
|
719
|
+
</member>
|
|
720
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnAfterModuleStart">
|
|
721
|
+
<summary>
|
|
722
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.AfterModuleStart"/> event.
|
|
723
|
+
</summary>
|
|
724
|
+
</member>
|
|
725
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnBeforeModuleStop">
|
|
726
|
+
<summary>
|
|
727
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.BeforeModuleStop"/> event.
|
|
728
|
+
</summary>
|
|
729
|
+
</member>
|
|
730
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnAfterModuleStop">
|
|
731
|
+
<summary>
|
|
732
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.AfterModuleStop"/> event.
|
|
733
|
+
</summary>
|
|
734
|
+
</member>
|
|
735
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnBeforeConsumeMessage(System.Object)">
|
|
736
|
+
<summary>
|
|
737
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.BeforeConsumeMessage"/> event.
|
|
738
|
+
</summary>
|
|
739
|
+
<param name="message">The message that will be consumed.</param>
|
|
740
|
+
<returns>False if the handler canceled to consume of the message.</returns>
|
|
741
|
+
</member>
|
|
742
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnAfterConsumeMessage(System.Object,System.Boolean)">
|
|
743
|
+
<summary>
|
|
744
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.AfterConsumeMessage"/> event.
|
|
745
|
+
</summary>
|
|
746
|
+
<param name="message">The message that was consumed.</param>
|
|
747
|
+
<param name="notSkipped">True if message was not skipped (<see cref="P:bbv.Common.AsyncModule.Events.BeforeConsumeMessageEventArgs.Cancel"/> was false.), otherwise false (message not not passed to handler).</param>
|
|
748
|
+
</member>
|
|
749
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnBeforeEnqueueMessage(System.Object,System.Boolean@)">
|
|
750
|
+
<summary>
|
|
751
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.BeforeEnqueueMessage"/> event.
|
|
752
|
+
</summary>
|
|
753
|
+
<param name="message">The message that wants to be enqueued.</param>
|
|
754
|
+
<param name="cancel"><c>true</c> to cancel enqueuing of message (message will not be enqueued).</param>
|
|
755
|
+
</member>
|
|
756
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnAfterEnqueueMessage(System.Object)">
|
|
757
|
+
<summary>
|
|
758
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.AfterEnqueueMessage"/> event.
|
|
759
|
+
</summary>
|
|
760
|
+
<param name="message">The message that was enqueued.</param>
|
|
761
|
+
</member>
|
|
762
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnConsumeMessageExceptionOccurred(System.Object,System.Exception)">
|
|
763
|
+
<summary>
|
|
764
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.ConsumeMessageExceptionOccurred"/> event.
|
|
765
|
+
</summary>
|
|
766
|
+
<param name="message">The message that caused the exception.</param>
|
|
767
|
+
<param name="exception">The exception that was thrown while consuming the message.</param>
|
|
768
|
+
<returns>Whether the exception was handled.</returns>
|
|
769
|
+
</member>
|
|
770
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.OnUnhandledModuleExceptionOccured(System.Object,System.Exception)">
|
|
771
|
+
<summary>
|
|
772
|
+
Fires the <see cref="E:bbv.Common.AsyncModule.ModuleController.UnhandledModuleExceptionOccured"/> event.
|
|
773
|
+
</summary>
|
|
774
|
+
<param name="message">The message.</param>
|
|
775
|
+
<param name="exception">The exception.</param>
|
|
776
|
+
</member>
|
|
777
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.IsCurrentThreadAWorkerThread">
|
|
778
|
+
<summary>
|
|
779
|
+
Determines whether the current thread is a worker thread of this module controller.
|
|
780
|
+
</summary>
|
|
781
|
+
<returns>
|
|
782
|
+
<c>true</c> if the current thread is a worker thread of this module controller; otherwise, <c>false</c>.
|
|
783
|
+
</returns>
|
|
784
|
+
</member>
|
|
785
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.WaitUntilAllThreadHaveStopped">
|
|
786
|
+
<summary>
|
|
787
|
+
Waits until all worker thread have stopped.
|
|
788
|
+
</summary>
|
|
789
|
+
</member>
|
|
790
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.NotifyStopped">
|
|
791
|
+
<summary>
|
|
792
|
+
Notifies the module controller that all worker threads are stopped.
|
|
793
|
+
</summary>
|
|
794
|
+
</member>
|
|
795
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.Run(System.Object)">
|
|
796
|
+
<summary>
|
|
797
|
+
The main method of the message consumer thread.
|
|
798
|
+
</summary>
|
|
799
|
+
<param name="o">The exit signal that </param>
|
|
800
|
+
</member>
|
|
801
|
+
<member name="M:bbv.Common.AsyncModule.ModuleController.ConsumeMessage(System.Object)">
|
|
802
|
+
<summary>
|
|
803
|
+
Calls the method marked with the MessageConsumer attribute, which match
|
|
804
|
+
the type of the message.
|
|
805
|
+
</summary>
|
|
806
|
+
<param name="message">
|
|
807
|
+
Message to be consumed.
|
|
808
|
+
</param>
|
|
809
|
+
</member>
|
|
810
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.UnhandledModuleExceptionOccured">
|
|
811
|
+
<summary>
|
|
812
|
+
This event is raised when an unhandled exception in a module occurred.
|
|
813
|
+
</summary>
|
|
814
|
+
</member>
|
|
815
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.BeforeModuleStart">
|
|
816
|
+
<summary>
|
|
817
|
+
This event is raised before the module is started. Extensions
|
|
818
|
+
use this event to insert actions before the module starts.
|
|
819
|
+
</summary>
|
|
820
|
+
</member>
|
|
821
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.AfterModuleStart">
|
|
822
|
+
<summary>
|
|
823
|
+
This event is raised after the module has been started. Extensions
|
|
824
|
+
use this event to insert actions after the module starts.
|
|
825
|
+
</summary>
|
|
826
|
+
</member>
|
|
827
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.BeforeModuleStop">
|
|
828
|
+
<summary>
|
|
829
|
+
This event is raised before the module is stopped. Extensions
|
|
830
|
+
use this event to insert actions before the module stops.
|
|
831
|
+
</summary>
|
|
832
|
+
</member>
|
|
833
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.AfterModuleStop">
|
|
834
|
+
<summary>
|
|
835
|
+
This event is raised after the module has been stopped. Extensions
|
|
836
|
+
use this event to insert actions after the module stops.
|
|
837
|
+
</summary>
|
|
838
|
+
</member>
|
|
839
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.BeforeConsumeMessage">
|
|
840
|
+
<summary>
|
|
841
|
+
This event is raised before a call to the message consumer. Extensions
|
|
842
|
+
use this event to insert actions before the message is consumed.
|
|
843
|
+
</summary>
|
|
844
|
+
</member>
|
|
845
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.AfterConsumeMessage">
|
|
846
|
+
<summary>
|
|
847
|
+
This event is raised after a call to the message consumer. Extensions
|
|
848
|
+
use this event to insert actions after the message has been consumed.
|
|
849
|
+
</summary>
|
|
850
|
+
</member>
|
|
851
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.BeforeEnqueueMessage">
|
|
852
|
+
<summary>
|
|
853
|
+
This event is raised before the message is enqueued. Extensions
|
|
854
|
+
use this event to insert actions after before the message is enqueued.
|
|
855
|
+
</summary>
|
|
856
|
+
</member>
|
|
857
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.AfterEnqueueMessage">
|
|
858
|
+
<summary>
|
|
859
|
+
This event is raised after the message is enqueued. Extensions
|
|
860
|
+
use this event to insert actions after before the message is enqueued.
|
|
861
|
+
</summary>
|
|
862
|
+
</member>
|
|
863
|
+
<member name="E:bbv.Common.AsyncModule.ModuleController.ConsumeMessageExceptionOccurred">
|
|
864
|
+
<summary>
|
|
865
|
+
This event is raised when an exception is thrown during consuming a message.
|
|
866
|
+
This event is used to react meaningful to exceptions like a retrying mechanism.
|
|
867
|
+
The event handler can return a value indicating whether the exception was handled.
|
|
868
|
+
</summary>
|
|
869
|
+
</member>
|
|
870
|
+
<member name="P:bbv.Common.AsyncModule.ModuleController.MessageCount">
|
|
871
|
+
<summary>
|
|
872
|
+
Gets the number of messages in the message queue.
|
|
873
|
+
</summary>
|
|
874
|
+
</member>
|
|
875
|
+
<member name="P:bbv.Common.AsyncModule.ModuleController.Messages">
|
|
876
|
+
<summary>
|
|
877
|
+
Gets the messages currently in the queue.
|
|
878
|
+
</summary>
|
|
879
|
+
<value>The messages.</value>
|
|
880
|
+
</member>
|
|
881
|
+
<member name="P:bbv.Common.AsyncModule.ModuleController.IsAlive">
|
|
882
|
+
<summary>
|
|
883
|
+
Gets a value indicating whether the message consumer thread(s) is/are alive.
|
|
884
|
+
</summary>
|
|
885
|
+
</member>
|
|
886
|
+
<member name="P:bbv.Common.AsyncModule.ModuleController.ThreadStopping">
|
|
887
|
+
<summary>
|
|
888
|
+
Gets or sets a value indicating whether we are stopping the worker threads.
|
|
889
|
+
</summary>
|
|
890
|
+
<value><c>true</c> if threads are stopping; otherwise, <c>false</c>.</value>
|
|
891
|
+
</member>
|
|
892
|
+
</members>
|
|
893
|
+
</doc>
|