nservicebus 2.0.0.1281
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/NServiceBus.Core.dll +0 -0
- data/lib/NServiceBus.Core.xml +93438 -0
- data/lib/NServiceBus.Host.exe +0 -0
- data/lib/NServiceBus.Host.xml +677 -0
- data/lib/NServiceBus.Testing.dll +0 -0
- data/lib/NServiceBus.Testing.xml +5896 -0
- data/lib/NServiceBus.dll +0 -0
- data/lib/NServiceBus.xml +1097 -0
- metadata +97 -0
data/lib/NServiceBus.dll
ADDED
|
Binary file
|
data/lib/NServiceBus.xml
ADDED
|
@@ -0,0 +1,1097 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>NServiceBus</name>
|
|
5
|
+
</assembly>
|
|
6
|
+
<members>
|
|
7
|
+
<member name="T:NServiceBus.CompletionResult">
|
|
8
|
+
<summary>
|
|
9
|
+
The object found in <see cref="T:System.IAsyncResult" />.AsyncState returned by the <see cref="T:System.AsyncCallback" />
|
|
10
|
+
passed to the Send method of the bus.
|
|
11
|
+
</summary>
|
|
12
|
+
</member>
|
|
13
|
+
<member name="P:NServiceBus.CompletionResult.ErrorCode">
|
|
14
|
+
<summary>
|
|
15
|
+
If <see cref="M:NServiceBus.IBus.Return(System.Int32)" /> was called, this contains the value passed to it.
|
|
16
|
+
</summary>
|
|
17
|
+
</member>
|
|
18
|
+
<member name="P:NServiceBus.CompletionResult.Messages">
|
|
19
|
+
<summary>
|
|
20
|
+
If <see cref="M:NServiceBus.IBus.Reply(NServiceBus.IMessage[])" /> was called, this contains the messages passed to it.
|
|
21
|
+
</summary>
|
|
22
|
+
</member>
|
|
23
|
+
<member name="P:NServiceBus.CompletionResult.State">
|
|
24
|
+
<summary>
|
|
25
|
+
An object that can contain state information for the method.
|
|
26
|
+
</summary>
|
|
27
|
+
</member>
|
|
28
|
+
<member name="T:NServiceBus.ExtensionMethods">
|
|
29
|
+
<summary>
|
|
30
|
+
Class containing extension methods for base class libraries for using interface-based messages.
|
|
31
|
+
</summary>
|
|
32
|
+
</member>
|
|
33
|
+
<member name="M:NServiceBus.ExtensionMethods.Add``1(System.Collections.Generic.IList{``0},System.Action{``0})">
|
|
34
|
+
<summary>
|
|
35
|
+
Instantiates an instance of T and adds it to the list.
|
|
36
|
+
</summary>
|
|
37
|
+
<typeparam name="T">The type to instantiate.</typeparam>
|
|
38
|
+
<param name="list">The list to which to add the new element</param>
|
|
39
|
+
<param name="constructor">An action for setting properties of the created instance.</param>
|
|
40
|
+
</member>
|
|
41
|
+
<member name="M:NServiceBus.ExtensionMethods.GetHeader(NServiceBus.IMessage,System.String)">
|
|
42
|
+
<summary>
|
|
43
|
+
Get the header with the given key. Cannot be used to change its value.
|
|
44
|
+
</summary>
|
|
45
|
+
<param name="msg">
|
|
46
|
+
</param>
|
|
47
|
+
<param name="key">
|
|
48
|
+
</param>
|
|
49
|
+
<returns>
|
|
50
|
+
</returns>
|
|
51
|
+
</member>
|
|
52
|
+
<member name="M:NServiceBus.ExtensionMethods.GetHttpFromHeader(NServiceBus.IMessage)">
|
|
53
|
+
<summary>
|
|
54
|
+
If the source of this message was an Http endpoint, returns its address
|
|
55
|
+
otherwise returns null.
|
|
56
|
+
</summary>
|
|
57
|
+
<param name="msg">
|
|
58
|
+
</param>
|
|
59
|
+
<returns>
|
|
60
|
+
</returns>
|
|
61
|
+
</member>
|
|
62
|
+
<member name="M:NServiceBus.ExtensionMethods.GetHttpToHeader(NServiceBus.IMessage)">
|
|
63
|
+
<summary>
|
|
64
|
+
If the target destination of this message is an Http endpoint,
|
|
65
|
+
return the address of that target, otherwise null.
|
|
66
|
+
</summary>
|
|
67
|
+
<param name="msg">
|
|
68
|
+
</param>
|
|
69
|
+
<returns>
|
|
70
|
+
</returns>
|
|
71
|
+
</member>
|
|
72
|
+
<member name="M:NServiceBus.ExtensionMethods.SetHeader(NServiceBus.IMessage,System.String,System.String)">
|
|
73
|
+
<summary>
|
|
74
|
+
Sets the value of the header for the given key.
|
|
75
|
+
</summary>
|
|
76
|
+
<param name="msg">
|
|
77
|
+
</param>
|
|
78
|
+
<param name="key">
|
|
79
|
+
</param>
|
|
80
|
+
<param name="value">
|
|
81
|
+
</param>
|
|
82
|
+
</member>
|
|
83
|
+
<member name="M:NServiceBus.ExtensionMethods.SetHttpFromHeader(NServiceBus.IMessage,System.String)">
|
|
84
|
+
<summary>
|
|
85
|
+
Sets the Http address from which this message was received.
|
|
86
|
+
This method is reserved for the NServiceBus Gateway.
|
|
87
|
+
</summary>
|
|
88
|
+
<param name="msg">
|
|
89
|
+
</param>
|
|
90
|
+
<param name="value">
|
|
91
|
+
</param>
|
|
92
|
+
</member>
|
|
93
|
+
<member name="M:NServiceBus.ExtensionMethods.SetHttpToHeader(NServiceBus.IMessage,System.String)">
|
|
94
|
+
<summary>
|
|
95
|
+
Sets the Http address to which this message should be sent.
|
|
96
|
+
Requires the use of the NServiceBus Gateway.
|
|
97
|
+
</summary>
|
|
98
|
+
<param name="msg">
|
|
99
|
+
</param>
|
|
100
|
+
<param name="value">
|
|
101
|
+
</param>
|
|
102
|
+
</member>
|
|
103
|
+
<member name="M:NServiceBus.ExtensionMethods.CopyHeaderFromRequest(NServiceBus.IMessage,System.String)">
|
|
104
|
+
<summary>
|
|
105
|
+
Gets the value of the header with the given key and sets it for this message.
|
|
106
|
+
</summary>
|
|
107
|
+
<param name="msg">
|
|
108
|
+
</param>
|
|
109
|
+
<param name="key">
|
|
110
|
+
</param>
|
|
111
|
+
</member>
|
|
112
|
+
<member name="P:NServiceBus.ExtensionMethods.MessageCreator">
|
|
113
|
+
<summary>
|
|
114
|
+
The object used by the extention methods to instantiate types.
|
|
115
|
+
</summary>
|
|
116
|
+
</member>
|
|
117
|
+
<member name="P:NServiceBus.ExtensionMethods.Bus">
|
|
118
|
+
<summary>
|
|
119
|
+
The object used by the extension methods for accessing headers.
|
|
120
|
+
</summary>
|
|
121
|
+
</member>
|
|
122
|
+
<member name="P:NServiceBus.ExtensionMethods.CurrentMessageBeingHandled">
|
|
123
|
+
<summary>
|
|
124
|
+
The object used to see whether headers requested are for the handled message.
|
|
125
|
+
</summary>
|
|
126
|
+
</member>
|
|
127
|
+
<member name="T:NServiceBus.Headers">
|
|
128
|
+
<summary>
|
|
129
|
+
Static class containing headers used by NServiceBus.
|
|
130
|
+
</summary>
|
|
131
|
+
</member>
|
|
132
|
+
<member name="F:NServiceBus.Headers.HttpFrom">
|
|
133
|
+
<summary>
|
|
134
|
+
Header for retrieving from which Http endpoint the message arrived.
|
|
135
|
+
</summary>
|
|
136
|
+
</member>
|
|
137
|
+
<member name="F:NServiceBus.Headers.HttpTo">
|
|
138
|
+
<summary>
|
|
139
|
+
Header for specifying to which Http endpoint the message should be delivered.
|
|
140
|
+
</summary>
|
|
141
|
+
</member>
|
|
142
|
+
<member name="T:NServiceBus.IAuthorizeSubscriptions">
|
|
143
|
+
<summary>
|
|
144
|
+
Implementer will be called by the infrastructure in order to authorize
|
|
145
|
+
subscribe and unsubscribe requests from other endpoints.
|
|
146
|
+
|
|
147
|
+
Infrastructure automatically registers one implementing type in the container as a singleton.
|
|
148
|
+
</summary>
|
|
149
|
+
</member>
|
|
150
|
+
<member name="M:NServiceBus.IAuthorizeSubscriptions.AuthorizeSubscribe(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
151
|
+
<summary>
|
|
152
|
+
Return true if the client endpoint is to be allowed to subscribe to the given message type.
|
|
153
|
+
</summary>
|
|
154
|
+
<param name="messageType">
|
|
155
|
+
</param>
|
|
156
|
+
<param name="clientEndpoint">
|
|
157
|
+
</param>
|
|
158
|
+
<param name="clientWindowsIdentity">
|
|
159
|
+
</param>
|
|
160
|
+
<param name="headers">
|
|
161
|
+
</param>
|
|
162
|
+
<returns>
|
|
163
|
+
</returns>
|
|
164
|
+
</member>
|
|
165
|
+
<member name="M:NServiceBus.IAuthorizeSubscriptions.AuthorizeUnsubscribe(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
|
|
166
|
+
<summary>
|
|
167
|
+
Return true if the client endpoint is to be allowed to unsubscribe to the given message type.
|
|
168
|
+
</summary>
|
|
169
|
+
<param name="messageType">
|
|
170
|
+
</param>
|
|
171
|
+
<param name="clientEndpoint">
|
|
172
|
+
</param>
|
|
173
|
+
<param name="clientWindowsIdentity">
|
|
174
|
+
</param>
|
|
175
|
+
<param name="headers">
|
|
176
|
+
</param>
|
|
177
|
+
<returns>
|
|
178
|
+
</returns>
|
|
179
|
+
</member>
|
|
180
|
+
<member name="T:NServiceBus.IMessageCreator">
|
|
181
|
+
<summary>
|
|
182
|
+
The abstraction for creating interface-based messages.
|
|
183
|
+
</summary>
|
|
184
|
+
</member>
|
|
185
|
+
<member name="M:NServiceBus.IMessageCreator.CreateInstance``1">
|
|
186
|
+
<summary>
|
|
187
|
+
Creates an instance of the message type T.
|
|
188
|
+
</summary>
|
|
189
|
+
<typeparam name="T">The type of message interface to instantiate.</typeparam>
|
|
190
|
+
<returns>A message object that implements the interface T.</returns>
|
|
191
|
+
</member>
|
|
192
|
+
<member name="M:NServiceBus.IMessageCreator.CreateInstance``1(System.Action{``0})">
|
|
193
|
+
<summary>
|
|
194
|
+
Creates an instance of the message type T and fills it with data.
|
|
195
|
+
</summary>
|
|
196
|
+
<typeparam name="T">The type of message interface to instantiate.</typeparam>
|
|
197
|
+
<param name="action">An action to set various properties of the instantiated object.</param>
|
|
198
|
+
<returns>A message object that implements the interface T.</returns>
|
|
199
|
+
</member>
|
|
200
|
+
<member name="M:NServiceBus.IMessageCreator.CreateInstance(System.Type)">
|
|
201
|
+
<summary>
|
|
202
|
+
Creates an instance of the given message type.
|
|
203
|
+
</summary>
|
|
204
|
+
<param name="messageType">The type of message to instantiate.</param>
|
|
205
|
+
<returns>A message object that implements the given interface.</returns>
|
|
206
|
+
</member>
|
|
207
|
+
<member name="T:NServiceBus.IBus">
|
|
208
|
+
<summary>
|
|
209
|
+
Defines a bus to be used with NServiceBus.
|
|
210
|
+
</summary>
|
|
211
|
+
</member>
|
|
212
|
+
<member name="M:NServiceBus.IBus.Publish``1(``0[])">
|
|
213
|
+
<summary>
|
|
214
|
+
Publishes the list of messages to subscribers.
|
|
215
|
+
If publishing multiple messages, they should all be of the same type
|
|
216
|
+
since subscribers are identified by the first message in the list.
|
|
217
|
+
</summary>
|
|
218
|
+
<param name="messages">A list of messages. The first message's type
|
|
219
|
+
is used for looking up subscribers.</param>
|
|
220
|
+
</member>
|
|
221
|
+
<member name="M:NServiceBus.IBus.Publish``1(System.Action{``0})">
|
|
222
|
+
<summary>
|
|
223
|
+
Instantiates a message of type T and publishes it.
|
|
224
|
+
</summary>
|
|
225
|
+
<typeparam name="T">The type of message, usually an interface</typeparam>
|
|
226
|
+
<param name="messageConstructor">An action which initializes properties of the message</param>
|
|
227
|
+
</member>
|
|
228
|
+
<member name="M:NServiceBus.IBus.Subscribe(System.Type)">
|
|
229
|
+
<summary>
|
|
230
|
+
Subcribes to recieve published messages of the specified type.
|
|
231
|
+
This method is only necessary if you turned off auto-subscribe.
|
|
232
|
+
</summary>
|
|
233
|
+
<param name="messageType">The type of message to subscribe to.</param>
|
|
234
|
+
</member>
|
|
235
|
+
<member name="M:NServiceBus.IBus.Subscribe``1">
|
|
236
|
+
<summary>
|
|
237
|
+
Subscribes to recieve published messages of type T.
|
|
238
|
+
This method is only necessary if you turned off auto-subscribe.
|
|
239
|
+
</summary>
|
|
240
|
+
<typeparam name="T">The type of message to subscribe to.</typeparam>
|
|
241
|
+
</member>
|
|
242
|
+
<member name="M:NServiceBus.IBus.Subscribe(System.Type,System.Predicate{NServiceBus.IMessage})">
|
|
243
|
+
<summary>
|
|
244
|
+
Subscribes to receive published messages of the specified type.
|
|
245
|
+
When messages arrive, the condition is evaluated to see if they
|
|
246
|
+
should be handled.
|
|
247
|
+
</summary>
|
|
248
|
+
<param name="messageType">The type of message to subscribe to.</param>
|
|
249
|
+
<param name="condition">The condition with which to evaluate messages.</param>
|
|
250
|
+
</member>
|
|
251
|
+
<member name="M:NServiceBus.IBus.Subscribe``1(System.Predicate{``0})">
|
|
252
|
+
<summary>
|
|
253
|
+
Subscribes to receive published messages of the specified type.
|
|
254
|
+
When messages arrive, the condition is evaluated to see if they
|
|
255
|
+
should be handled.
|
|
256
|
+
</summary>
|
|
257
|
+
<typeparam name="T">The type of message to subscribe to.</typeparam>
|
|
258
|
+
<param name="condition">The condition with which to evaluate messages.</param>
|
|
259
|
+
</member>
|
|
260
|
+
<member name="M:NServiceBus.IBus.Unsubscribe(System.Type)">
|
|
261
|
+
<summary>
|
|
262
|
+
Unsubscribes from receiving published messages of the specified type.
|
|
263
|
+
</summary>
|
|
264
|
+
<param name="messageType">
|
|
265
|
+
</param>
|
|
266
|
+
</member>
|
|
267
|
+
<member name="M:NServiceBus.IBus.Unsubscribe``1">
|
|
268
|
+
<summary>
|
|
269
|
+
Unsubscribes from receiving published messages of the specified type.
|
|
270
|
+
</summary>
|
|
271
|
+
<typeparam name="T">The type of message to unsubscribe from.</typeparam>
|
|
272
|
+
</member>
|
|
273
|
+
<member name="M:NServiceBus.IBus.SendLocal(NServiceBus.IMessage[])">
|
|
274
|
+
<summary>
|
|
275
|
+
Sends the list of messages back to the current bus.
|
|
276
|
+
</summary>
|
|
277
|
+
<param name="messages">The messages to send.</param>
|
|
278
|
+
</member>
|
|
279
|
+
<member name="M:NServiceBus.IBus.SendLocal``1(System.Action{``0})">
|
|
280
|
+
<summary>
|
|
281
|
+
Instantiates a message of type T and sends it back to the current bus.
|
|
282
|
+
</summary>
|
|
283
|
+
<typeparam name="T">The type of message, usually an interface.</typeparam>
|
|
284
|
+
<param name="messageConstructor">An action which initializes properties of the message</param>
|
|
285
|
+
</member>
|
|
286
|
+
<member name="M:NServiceBus.IBus.Send(NServiceBus.IMessage[])">
|
|
287
|
+
<summary>
|
|
288
|
+
Sends the list of provided messages.
|
|
289
|
+
</summary>
|
|
290
|
+
<param name="messages">The list of messages to send.</param>
|
|
291
|
+
<remarks>
|
|
292
|
+
All the messages will be sent to the destination configured for the
|
|
293
|
+
first message in the list.
|
|
294
|
+
</remarks>
|
|
295
|
+
</member>
|
|
296
|
+
<member name="M:NServiceBus.IBus.Send``1(System.Action{``0})">
|
|
297
|
+
<summary>
|
|
298
|
+
Instantiates a message of type T and sends it.
|
|
299
|
+
</summary>
|
|
300
|
+
<typeparam name="T">The type of message, usually an interface</typeparam>
|
|
301
|
+
<param name="messageConstructor">An action which initializes properties of the message</param>
|
|
302
|
+
<remarks>
|
|
303
|
+
The message will be sent to the destination configured for T
|
|
304
|
+
</remarks>
|
|
305
|
+
</member>
|
|
306
|
+
<member name="M:NServiceBus.IBus.Send(System.String,NServiceBus.IMessage[])">
|
|
307
|
+
<summary>
|
|
308
|
+
Sends the list of provided messages.
|
|
309
|
+
</summary>
|
|
310
|
+
<param name="destination">
|
|
311
|
+
The address of the destination to which the messages will be sent.
|
|
312
|
+
</param>
|
|
313
|
+
<param name="messages">The list of messages to send.</param>
|
|
314
|
+
</member>
|
|
315
|
+
<member name="M:NServiceBus.IBus.Send``1(System.String,System.Action{``0})">
|
|
316
|
+
<summary>
|
|
317
|
+
Instantiates a message of type T and sends it to the given destination.
|
|
318
|
+
</summary>
|
|
319
|
+
<typeparam name="T">The type of message, usually an interface</typeparam>
|
|
320
|
+
<param name="destination">The destination to which the message will be sent.</param>
|
|
321
|
+
<param name="messageConstructor">An action which initializes properties of the message</param>
|
|
322
|
+
<returns>
|
|
323
|
+
</returns>
|
|
324
|
+
</member>
|
|
325
|
+
<member name="M:NServiceBus.IBus.Send(System.String,System.String,NServiceBus.IMessage[])">
|
|
326
|
+
<summary>
|
|
327
|
+
Sends the messages to the destination as well as identifying this
|
|
328
|
+
as a response to a message containing the Id found in correlationId.
|
|
329
|
+
</summary>
|
|
330
|
+
<param name="destination">
|
|
331
|
+
</param>
|
|
332
|
+
<param name="correlationId">
|
|
333
|
+
</param>
|
|
334
|
+
<param name="messages">
|
|
335
|
+
</param>
|
|
336
|
+
</member>
|
|
337
|
+
<member name="M:NServiceBus.IBus.Send``1(System.String,System.String,System.Action{``0})">
|
|
338
|
+
<summary>
|
|
339
|
+
Instantiates a message of the type T using the given messageConstructor,
|
|
340
|
+
and sends it to the destination identifying it as a response to a message
|
|
341
|
+
containing the Id found in correlationId.
|
|
342
|
+
</summary>
|
|
343
|
+
<typeparam name="T">
|
|
344
|
+
</typeparam>
|
|
345
|
+
<param name="destination">
|
|
346
|
+
</param>
|
|
347
|
+
<param name="correlationId">
|
|
348
|
+
</param>
|
|
349
|
+
<param name="messageConstructor">
|
|
350
|
+
</param>
|
|
351
|
+
</member>
|
|
352
|
+
<member name="M:NServiceBus.IBus.Reply(NServiceBus.IMessage[])">
|
|
353
|
+
<summary>
|
|
354
|
+
Sends all messages to the endpoint which sent the message currently being handled on this thread.
|
|
355
|
+
</summary>
|
|
356
|
+
<param name="messages">The messages to send.</param>
|
|
357
|
+
</member>
|
|
358
|
+
<member name="M:NServiceBus.IBus.Reply``1(System.Action{``0})">
|
|
359
|
+
<summary>
|
|
360
|
+
Instantiates a message of type T and performs a regular <see cref="M:NServiceBus.IBus.Reply(NServiceBus.IMessage[])" />.
|
|
361
|
+
</summary>
|
|
362
|
+
<typeparam name="T">The type of message, usually an interface</typeparam>
|
|
363
|
+
<param name="messageConstructor">An action which initializes properties of the message</param>
|
|
364
|
+
</member>
|
|
365
|
+
<member name="M:NServiceBus.IBus.Return(System.Int32)">
|
|
366
|
+
<summary>
|
|
367
|
+
Returns a completion message with the specified error code to the sender
|
|
368
|
+
of the message being handled.
|
|
369
|
+
</summary>
|
|
370
|
+
<param name="errorCode">A code specifying the result.</param>
|
|
371
|
+
</member>
|
|
372
|
+
<member name="M:NServiceBus.IBus.HandleCurrentMessageLater">
|
|
373
|
+
<summary>
|
|
374
|
+
Moves the message being handled to the back of the list of available
|
|
375
|
+
messages so it can be handled later.
|
|
376
|
+
</summary>
|
|
377
|
+
</member>
|
|
378
|
+
<member name="M:NServiceBus.IBus.ForwardCurrentMessageTo(System.String)">
|
|
379
|
+
<summary>
|
|
380
|
+
Forwards the current message being handled to the destination maintaining
|
|
381
|
+
all of its transport-level properties and headers.
|
|
382
|
+
</summary>
|
|
383
|
+
<param name="destination">
|
|
384
|
+
</param>
|
|
385
|
+
</member>
|
|
386
|
+
<member name="M:NServiceBus.IBus.DoNotContinueDispatchingCurrentMessageToHandlers">
|
|
387
|
+
<summary>
|
|
388
|
+
Tells the bus to stop dispatching the current message to additional
|
|
389
|
+
handlers.
|
|
390
|
+
</summary>
|
|
391
|
+
</member>
|
|
392
|
+
<member name="P:NServiceBus.IBus.OutgoingHeaders">
|
|
393
|
+
<summary>
|
|
394
|
+
Gets the list of key/value pairs that will be in the header of
|
|
395
|
+
messages being sent by the same thread.
|
|
396
|
+
|
|
397
|
+
This value will be cleared when a thread receives a message.
|
|
398
|
+
</summary>
|
|
399
|
+
</member>
|
|
400
|
+
<member name="P:NServiceBus.IBus.CurrentMessageContext">
|
|
401
|
+
<summary>
|
|
402
|
+
Gets the message context containing the Id, return address, and headers
|
|
403
|
+
of the message currently being handled on this thread.
|
|
404
|
+
</summary>
|
|
405
|
+
</member>
|
|
406
|
+
<member name="T:NServiceBus.ICallback">
|
|
407
|
+
<summary>
|
|
408
|
+
Objects of this interface are returned from calling IBus.Send.
|
|
409
|
+
The interface allows the caller to register for a callback when a response
|
|
410
|
+
is received to their original call to IBus.Send.
|
|
411
|
+
</summary>
|
|
412
|
+
</member>
|
|
413
|
+
<member name="M:NServiceBus.ICallback.Register(System.AsyncCallback,System.Object)">
|
|
414
|
+
<summary>
|
|
415
|
+
Registers a callback to be invoked when a response arrives to the message sent.
|
|
416
|
+
</summary>
|
|
417
|
+
<param name="callback">The callback to invoke.</param>
|
|
418
|
+
<param name="state">State that will be passed to the callback method.</param>
|
|
419
|
+
<returns>An IAsyncResult useful for integration with ASP.NET async tasks.</returns>
|
|
420
|
+
</member>
|
|
421
|
+
<member name="M:NServiceBus.ICallback.Register(System.Action{System.Int32})">
|
|
422
|
+
<summary>
|
|
423
|
+
Registers a callback to be invoked when a response arrives to the message sent.
|
|
424
|
+
Not designed for web scenarios.
|
|
425
|
+
</summary>
|
|
426
|
+
<param name="callback">
|
|
427
|
+
</param>
|
|
428
|
+
</member>
|
|
429
|
+
<member name="M:NServiceBus.ICallback.Register``1(System.Action{``0})">
|
|
430
|
+
<summary>
|
|
431
|
+
Registers a callback to be invoked when a response arrives to the message sent.
|
|
432
|
+
The return code is casted to the given enumerated type - T.
|
|
433
|
+
</summary>
|
|
434
|
+
<typeparam name="T">An enumeration type.</typeparam>
|
|
435
|
+
<param name="callback">
|
|
436
|
+
</param>
|
|
437
|
+
</member>
|
|
438
|
+
<member name="M:NServiceBus.ICallback.RegisterWebCallback(System.Action{System.Int32},System.Object)">
|
|
439
|
+
<summary>
|
|
440
|
+
Registers a callback to be invoked when a response arrives to the message sent.
|
|
441
|
+
Designed specifically for web scenarios so that you don't need to write PageAsyncTasks.
|
|
442
|
+
Only works when the callback is on the Page object itself.
|
|
443
|
+
</summary>
|
|
444
|
+
<param name="callback">
|
|
445
|
+
</param>
|
|
446
|
+
<param name="state">
|
|
447
|
+
</param>
|
|
448
|
+
</member>
|
|
449
|
+
<member name="M:NServiceBus.ICallback.RegisterWebCallback(System.Action{System.Int32},System.Object,System.Web.UI.Page)">
|
|
450
|
+
<summary>
|
|
451
|
+
Registers a callback to be invoked when a response arrives to the message sent.
|
|
452
|
+
Designed specifically for web scenarios so that you don't need to write PageAsyncTasks.
|
|
453
|
+
</summary>
|
|
454
|
+
<param name="callback">
|
|
455
|
+
</param>
|
|
456
|
+
<param name="state">
|
|
457
|
+
</param>
|
|
458
|
+
<param name="page">
|
|
459
|
+
</param>
|
|
460
|
+
</member>
|
|
461
|
+
<member name="M:NServiceBus.ICallback.RegisterWebCallback``1(System.Action{``0},System.Object)">
|
|
462
|
+
<summary>
|
|
463
|
+
Registers a callback to be invoked when a response arrives to the message sent.
|
|
464
|
+
Designed specifically for web scenarios so that you don't need to write PageAsyncTasks.
|
|
465
|
+
Only works when the callback is on the Page object itself.
|
|
466
|
+
</summary>
|
|
467
|
+
<typeparam name="T">An enumeration type.</typeparam>
|
|
468
|
+
<param name="callback">
|
|
469
|
+
</param>
|
|
470
|
+
<param name="state">
|
|
471
|
+
</param>
|
|
472
|
+
</member>
|
|
473
|
+
<member name="M:NServiceBus.ICallback.RegisterWebCallback``1(System.Action{``0},System.Object,System.Web.UI.Page)">
|
|
474
|
+
<summary>
|
|
475
|
+
Registers a callback to be invoked when a response arrives to the message sent.
|
|
476
|
+
Designed specifically for web scenarios so that you don't need to write PageAsyncTasks.
|
|
477
|
+
</summary>
|
|
478
|
+
<typeparam name="T">An enumeration type.</typeparam>
|
|
479
|
+
<param name="callback">
|
|
480
|
+
</param>
|
|
481
|
+
<param name="state">
|
|
482
|
+
</param>
|
|
483
|
+
<param name="page">
|
|
484
|
+
</param>
|
|
485
|
+
</member>
|
|
486
|
+
<member name="T:NServiceBus.IMessage">
|
|
487
|
+
<summary>
|
|
488
|
+
Marker interface to indicate that a class is a message suitable
|
|
489
|
+
for transmission and handling by an NServiceBus.
|
|
490
|
+
</summary>
|
|
491
|
+
</member>
|
|
492
|
+
<member name="T:NServiceBus.RecoverableAttribute">
|
|
493
|
+
<summary>
|
|
494
|
+
Attribute to indicate that a message is recoverable - this is now the default.
|
|
495
|
+
</summary>
|
|
496
|
+
<remarks>
|
|
497
|
+
This attribute should be applied to classes that implement <see cref="T:NServiceBus.IMessage" />
|
|
498
|
+
to indicate that they should be treated as a recoverable message. A recoverable
|
|
499
|
+
message is stored locally at every step along the route so that in the event of
|
|
500
|
+
a failure of a machine along the route a copy of the message will be recovered and
|
|
501
|
+
delivery will continue when the machine is brought back online.</remarks>
|
|
502
|
+
</member>
|
|
503
|
+
<member name="T:NServiceBus.ExpressAttribute">
|
|
504
|
+
<summary>
|
|
505
|
+
Attribute to indicate that the message should not be written to disk.
|
|
506
|
+
This will make the message vulnerable to server crashes or restarts.
|
|
507
|
+
</summary>
|
|
508
|
+
</member>
|
|
509
|
+
<member name="T:NServiceBus.TimeToBeReceivedAttribute">
|
|
510
|
+
<summary>
|
|
511
|
+
Attribute to indicate that a message has a period of time
|
|
512
|
+
in which to be received.
|
|
513
|
+
</summary>
|
|
514
|
+
</member>
|
|
515
|
+
<member name="M:NServiceBus.TimeToBeReceivedAttribute.#ctor">
|
|
516
|
+
<summary>
|
|
517
|
+
Sets the time to be received to be unlimited.
|
|
518
|
+
</summary>
|
|
519
|
+
</member>
|
|
520
|
+
<member name="M:NServiceBus.TimeToBeReceivedAttribute.#ctor(System.String)">
|
|
521
|
+
<summary>
|
|
522
|
+
Sets the time to be received.
|
|
523
|
+
</summary>
|
|
524
|
+
<param name="timeSpan">A timespan that can be interpreted by <see cref="M:System.TimeSpan.Parse(System.String)" />.</param>
|
|
525
|
+
</member>
|
|
526
|
+
<member name="P:NServiceBus.TimeToBeReceivedAttribute.TimeToBeReceived">
|
|
527
|
+
<summary>
|
|
528
|
+
Gets the maximum time in which a message must be received.
|
|
529
|
+
</summary>
|
|
530
|
+
<remarks>
|
|
531
|
+
If the interval specified by the TimeToBeReceived property expires before the message
|
|
532
|
+
is received by the destination of the message the message will automatically be cancelled.
|
|
533
|
+
</remarks>
|
|
534
|
+
</member>
|
|
535
|
+
<member name="T:NServiceBus.IMessageContext">
|
|
536
|
+
<summary>
|
|
537
|
+
Contains out-of-band information on the logical message.
|
|
538
|
+
</summary>
|
|
539
|
+
</member>
|
|
540
|
+
<member name="P:NServiceBus.IMessageContext.Id">
|
|
541
|
+
<summary>
|
|
542
|
+
Returns the Id of the message.
|
|
543
|
+
</summary>
|
|
544
|
+
</member>
|
|
545
|
+
<member name="P:NServiceBus.IMessageContext.ReturnAddress">
|
|
546
|
+
<summary>
|
|
547
|
+
Returns the address of the endpoint that sent this message.
|
|
548
|
+
</summary>
|
|
549
|
+
</member>
|
|
550
|
+
<member name="P:NServiceBus.IMessageContext.Headers">
|
|
551
|
+
<summary>
|
|
552
|
+
Gets the list of key/value pairs found in the header of the message.
|
|
553
|
+
</summary>
|
|
554
|
+
</member>
|
|
555
|
+
<member name="T:NServiceBus.IMessageHandler`1">
|
|
556
|
+
<summary>
|
|
557
|
+
Defines a message handler.
|
|
558
|
+
</summary>
|
|
559
|
+
<typeparam name="T">The type of message to be handled.</typeparam>
|
|
560
|
+
</member>
|
|
561
|
+
<member name="M:NServiceBus.IMessageHandler`1.Handle(`0)">
|
|
562
|
+
<summary>
|
|
563
|
+
Handles a message.
|
|
564
|
+
</summary>
|
|
565
|
+
<param name="message">The message to handle.</param>
|
|
566
|
+
<remarks>
|
|
567
|
+
This method will be called when a message arrives on the bus and should contain
|
|
568
|
+
the custom logic to execute when the message is received.</remarks>
|
|
569
|
+
</member>
|
|
570
|
+
<member name="T:NServiceBus.IHandleMessages`1">
|
|
571
|
+
<summary>
|
|
572
|
+
Implement this class to be called when messages of the given type arrive at your endpoint.
|
|
573
|
+
</summary>
|
|
574
|
+
<typeparam name="T">
|
|
575
|
+
</typeparam>
|
|
576
|
+
</member>
|
|
577
|
+
<member name="T:NServiceBus.IMessageModule">
|
|
578
|
+
<summary>
|
|
579
|
+
Implementers will be called before and after all message handlers.
|
|
580
|
+
</summary>
|
|
581
|
+
</member>
|
|
582
|
+
<member name="M:NServiceBus.IMessageModule.HandleBeginMessage">
|
|
583
|
+
<summary>
|
|
584
|
+
This method is called before any message handlers are called.
|
|
585
|
+
</summary>
|
|
586
|
+
</member>
|
|
587
|
+
<member name="M:NServiceBus.IMessageModule.HandleEndMessage">
|
|
588
|
+
<summary>
|
|
589
|
+
This method is called after all message handlers have been called.
|
|
590
|
+
</summary>
|
|
591
|
+
</member>
|
|
592
|
+
<member name="M:NServiceBus.IMessageModule.HandleError">
|
|
593
|
+
<summary>
|
|
594
|
+
This method is called if there was an error in processing the message,
|
|
595
|
+
and may be called after <see cref="M:NServiceBus.IMessageModule.HandleEndMessage" />.
|
|
596
|
+
</summary>
|
|
597
|
+
</member>
|
|
598
|
+
<member name="T:NServiceBus.IStartableBus">
|
|
599
|
+
<summary>
|
|
600
|
+
The interface used for starting and stopping an IBus.
|
|
601
|
+
</summary>
|
|
602
|
+
</member>
|
|
603
|
+
<member name="M:NServiceBus.IStartableBus.Start(System.Action)">
|
|
604
|
+
<summary>
|
|
605
|
+
Performs the given startup action, starts the bus, and returns a reference to it.
|
|
606
|
+
</summary>
|
|
607
|
+
<param name="startupAction">Action to be performed before the bus is started.</param>
|
|
608
|
+
<returns>A reference to the bus.</returns>
|
|
609
|
+
</member>
|
|
610
|
+
<member name="M:NServiceBus.IStartableBus.Start">
|
|
611
|
+
<summary>
|
|
612
|
+
Starts the bus and returns a reference to it.
|
|
613
|
+
</summary>
|
|
614
|
+
<returns>
|
|
615
|
+
</returns>
|
|
616
|
+
</member>
|
|
617
|
+
<member name="E:NServiceBus.IStartableBus.Started">
|
|
618
|
+
<summary>
|
|
619
|
+
Event raised when the bus is started.
|
|
620
|
+
</summary>
|
|
621
|
+
</member>
|
|
622
|
+
<member name="T:NServiceBus.Messages.ReadyMessage">
|
|
623
|
+
<summary>
|
|
624
|
+
Defines a message indicating that a transport is ready to
|
|
625
|
+
receive a message.
|
|
626
|
+
</summary>
|
|
627
|
+
</member>
|
|
628
|
+
<member name="P:NServiceBus.Messages.ReadyMessage.ClearPreviousFromThisAddress">
|
|
629
|
+
<summary>
|
|
630
|
+
Exposes whether or not previous ready messages from the same
|
|
631
|
+
sender should be cleared.
|
|
632
|
+
</summary>
|
|
633
|
+
</member>
|
|
634
|
+
<member name="T:NServiceBus.WireEncryptedString">
|
|
635
|
+
<summary>
|
|
636
|
+
A string whose value will be encrypted when sent over the wire.
|
|
637
|
+
</summary>
|
|
638
|
+
</member>
|
|
639
|
+
<member name="M:NServiceBus.WireEncryptedString.op_Implicit(NServiceBus.WireEncryptedString)~System.String">
|
|
640
|
+
<summary>
|
|
641
|
+
Gets the string value from the WireEncryptedString.
|
|
642
|
+
</summary>
|
|
643
|
+
<param name="s">
|
|
644
|
+
</param>
|
|
645
|
+
<returns>
|
|
646
|
+
</returns>
|
|
647
|
+
</member>
|
|
648
|
+
<member name="M:NServiceBus.WireEncryptedString.op_Implicit(System.String)~NServiceBus.WireEncryptedString">
|
|
649
|
+
<summary>
|
|
650
|
+
Creates a new WireEncryptedString from the given string.
|
|
651
|
+
</summary>
|
|
652
|
+
<param name="s">
|
|
653
|
+
</param>
|
|
654
|
+
<returns>
|
|
655
|
+
</returns>
|
|
656
|
+
</member>
|
|
657
|
+
<member name="P:NServiceBus.WireEncryptedString.Value">
|
|
658
|
+
<summary>
|
|
659
|
+
The unencrypted string.
|
|
660
|
+
</summary>
|
|
661
|
+
</member>
|
|
662
|
+
<member name="T:NServiceBus.Saga.HasCompleted">
|
|
663
|
+
<summary>
|
|
664
|
+
Interface used to query a saga to see if it has completed.
|
|
665
|
+
</summary>
|
|
666
|
+
</member>
|
|
667
|
+
<member name="P:NServiceBus.Saga.HasCompleted.Completed">
|
|
668
|
+
<summary>
|
|
669
|
+
Indicates if the saga has completed.
|
|
670
|
+
</summary>
|
|
671
|
+
</member>
|
|
672
|
+
<member name="T:NServiceBus.Saga.IConfigurable">
|
|
673
|
+
<summary>
|
|
674
|
+
Implementers of ISaga should implement this interface as well if they want
|
|
675
|
+
initialization time configuration.
|
|
676
|
+
</summary>
|
|
677
|
+
</member>
|
|
678
|
+
<member name="M:NServiceBus.Saga.IConfigurable.Configure">
|
|
679
|
+
<summary>
|
|
680
|
+
Called by the infrastructure to give a chance for initialization time configuration of the saga.
|
|
681
|
+
</summary>
|
|
682
|
+
</member>
|
|
683
|
+
<member name="T:NServiceBus.Saga.IConfigureHowToFindSagaWithMessage">
|
|
684
|
+
<summary>
|
|
685
|
+
Implementation provided by the infrastructure - don't implement this
|
|
686
|
+
or register implementations of it in the container unless you intend
|
|
687
|
+
to substantially change the way sagas work in nServiceBus.
|
|
688
|
+
</summary>
|
|
689
|
+
</member>
|
|
690
|
+
<member name="M:NServiceBus.Saga.IConfigureHowToFindSagaWithMessage.ConfigureMapping``2(System.Linq.Expressions.Expression{System.Func{``0,System.Object}},System.Linq.Expressions.Expression{System.Func{``1,System.Object}})">
|
|
691
|
+
<summary>
|
|
692
|
+
Specify that when the infrastructure is handling a message
|
|
693
|
+
of the given type, which message property should be matched to
|
|
694
|
+
which saga entity property in the persistent saga store.
|
|
695
|
+
</summary>
|
|
696
|
+
<typeparam name="TMessage">
|
|
697
|
+
</typeparam>
|
|
698
|
+
<typeparam name="TSagaEntity">
|
|
699
|
+
</typeparam>
|
|
700
|
+
<param name="sagaEntityProperty">
|
|
701
|
+
</param>
|
|
702
|
+
<param name="messageProperty">
|
|
703
|
+
</param>
|
|
704
|
+
</member>
|
|
705
|
+
<member name="T:NServiceBus.Saga.IHandleReplyingToNullOriginator">
|
|
706
|
+
<summary>
|
|
707
|
+
Double-dispatch class.
|
|
708
|
+
</summary>
|
|
709
|
+
</member>
|
|
710
|
+
<member name="M:NServiceBus.Saga.IHandleReplyingToNullOriginator.TriedToReplyToNullOriginator">
|
|
711
|
+
<summary>
|
|
712
|
+
Called when the user has tries to reply to a message with out a originator
|
|
713
|
+
</summary>
|
|
714
|
+
</member>
|
|
715
|
+
<member name="T:NServiceBus.Saga.IFinder">
|
|
716
|
+
<summary>
|
|
717
|
+
Marker interface for <see cref="T:NServiceBus.Saga.IFindSagas`1.Using`1" /></summary>
|
|
718
|
+
</member>
|
|
719
|
+
<member name="T:NServiceBus.Saga.IFindSagas`1">
|
|
720
|
+
<summary>
|
|
721
|
+
Interface indicating that implementers can find sagas of the given type.
|
|
722
|
+
</summary>
|
|
723
|
+
<typeparam name="T">
|
|
724
|
+
</typeparam>
|
|
725
|
+
</member>
|
|
726
|
+
<member name="T:NServiceBus.Saga.IFindSagas`1.Using`1">
|
|
727
|
+
<summary>
|
|
728
|
+
Narrower interface indicating that implementers can find sagas
|
|
729
|
+
of type T using messages of type M.
|
|
730
|
+
</summary>
|
|
731
|
+
<typeparam name="M">
|
|
732
|
+
</typeparam>
|
|
733
|
+
</member>
|
|
734
|
+
<member name="T:NServiceBus.Saga.ITimeoutable">
|
|
735
|
+
<summary>
|
|
736
|
+
Interface used by the saga infrastructure for notifying sagas about a timeout.
|
|
737
|
+
</summary>
|
|
738
|
+
</member>
|
|
739
|
+
<member name="M:NServiceBus.Saga.ITimeoutable.Timeout(System.Object)">
|
|
740
|
+
<summary>
|
|
741
|
+
Indicates to the saga that a timeout has occurred,
|
|
742
|
+
passing in the state object previously received from the saga.
|
|
743
|
+
</summary>
|
|
744
|
+
<param name="state">
|
|
745
|
+
</param>
|
|
746
|
+
</member>
|
|
747
|
+
<member name="T:NServiceBus.Saga.ISaga">
|
|
748
|
+
<summary>
|
|
749
|
+
Implement this interface if you want to write a saga with minimal infrastructure support.
|
|
750
|
+
It is recommended you inherit the abstract class <see cref="T:NServiceBus.Saga.Saga`1" /> to get the most functionality.
|
|
751
|
+
</summary>
|
|
752
|
+
</member>
|
|
753
|
+
<member name="P:NServiceBus.Saga.ISaga.Entity">
|
|
754
|
+
<summary>
|
|
755
|
+
The saga's data.
|
|
756
|
+
</summary>
|
|
757
|
+
</member>
|
|
758
|
+
<member name="P:NServiceBus.Saga.ISaga.Bus">
|
|
759
|
+
<summary>
|
|
760
|
+
Used for retrieving the endpoint which caused the saga to be initiated.
|
|
761
|
+
</summary>
|
|
762
|
+
</member>
|
|
763
|
+
<member name="T:NServiceBus.Saga.ISaga`1">
|
|
764
|
+
<summary>
|
|
765
|
+
A more strongly typed version of ISaga meant to be implemented by application developers
|
|
766
|
+
</summary>
|
|
767
|
+
<typeparam name="T">
|
|
768
|
+
</typeparam>
|
|
769
|
+
</member>
|
|
770
|
+
<member name="P:NServiceBus.Saga.ISaga`1.Data">
|
|
771
|
+
<summary>
|
|
772
|
+
The saga's data.
|
|
773
|
+
</summary>
|
|
774
|
+
</member>
|
|
775
|
+
<member name="T:NServiceBus.Saga.ISagaEntity">
|
|
776
|
+
<summary>
|
|
777
|
+
Defines the basic data used by long-running processes.
|
|
778
|
+
</summary>
|
|
779
|
+
</member>
|
|
780
|
+
<member name="P:NServiceBus.Saga.ISagaEntity.Id">
|
|
781
|
+
<summary>
|
|
782
|
+
Gets/sets the Id of the process. Do NOT generate this value in your code.
|
|
783
|
+
The value of the Id will be generated automatically to provide the
|
|
784
|
+
best performance for saving in a database.
|
|
785
|
+
</summary>
|
|
786
|
+
<remarks>
|
|
787
|
+
The reason Guid is used for process Id is that messages containing this Id need
|
|
788
|
+
to be sent by the process even before it is persisted.
|
|
789
|
+
</remarks>
|
|
790
|
+
</member>
|
|
791
|
+
<member name="P:NServiceBus.Saga.ISagaEntity.Originator">
|
|
792
|
+
<summary>
|
|
793
|
+
Contains the return address of the endpoint that caused the process to run.
|
|
794
|
+
</summary>
|
|
795
|
+
</member>
|
|
796
|
+
<member name="P:NServiceBus.Saga.ISagaEntity.OriginalMessageId">
|
|
797
|
+
<summary>
|
|
798
|
+
Contains the Id of the message which caused the saga to start.
|
|
799
|
+
This is needed so that when we reply to the Originator, any
|
|
800
|
+
registered callbacks will be fired correctly.
|
|
801
|
+
</summary>
|
|
802
|
+
</member>
|
|
803
|
+
<member name="T:NServiceBus.Saga.IContainSagaData">
|
|
804
|
+
<summary>
|
|
805
|
+
The saga data that will be persisted.
|
|
806
|
+
</summary>
|
|
807
|
+
</member>
|
|
808
|
+
<member name="T:NServiceBus.Saga.ISagaMessage">
|
|
809
|
+
<summary>
|
|
810
|
+
An interface used to mark messages as requiring the attention of the
|
|
811
|
+
saga infrastructure.
|
|
812
|
+
</summary>
|
|
813
|
+
</member>
|
|
814
|
+
<member name="P:NServiceBus.Saga.ISagaMessage.SagaId">
|
|
815
|
+
<summary>
|
|
816
|
+
Gets/sets the Id of the saga the message is related to.
|
|
817
|
+
</summary>
|
|
818
|
+
</member>
|
|
819
|
+
<member name="T:NServiceBus.Saga.ISagaPersister">
|
|
820
|
+
<summary>
|
|
821
|
+
Defines the basic functionality of a persister for storing
|
|
822
|
+
and retrieving a saga.
|
|
823
|
+
</summary>
|
|
824
|
+
</member>
|
|
825
|
+
<member name="M:NServiceBus.Saga.ISagaPersister.Save(NServiceBus.Saga.ISagaEntity)">
|
|
826
|
+
<summary>
|
|
827
|
+
Saves the saga entity to the persistence store.
|
|
828
|
+
</summary>
|
|
829
|
+
<param name="saga">The saga entity to save.</param>
|
|
830
|
+
</member>
|
|
831
|
+
<member name="M:NServiceBus.Saga.ISagaPersister.Update(NServiceBus.Saga.ISagaEntity)">
|
|
832
|
+
<summary>
|
|
833
|
+
Updates an existing saga entity in the persistence store.
|
|
834
|
+
</summary>
|
|
835
|
+
<param name="saga">The saga entity to updated.</param>
|
|
836
|
+
</member>
|
|
837
|
+
<member name="M:NServiceBus.Saga.ISagaPersister.Get``1(System.Guid)">
|
|
838
|
+
<summary>
|
|
839
|
+
Gets a saga entity from the persistence store by its Id.
|
|
840
|
+
</summary>
|
|
841
|
+
<param name="sagaId">The Id of the saga entity to get.</param>
|
|
842
|
+
<returns>
|
|
843
|
+
</returns>
|
|
844
|
+
</member>
|
|
845
|
+
<member name="M:NServiceBus.Saga.ISagaPersister.Get``1(System.String,System.Object)">
|
|
846
|
+
<summary>
|
|
847
|
+
Looks up a saga entity by a given property.
|
|
848
|
+
</summary>
|
|
849
|
+
<typeparam name="T">
|
|
850
|
+
</typeparam>
|
|
851
|
+
<param name="property">
|
|
852
|
+
</param>
|
|
853
|
+
<param name="value">
|
|
854
|
+
</param>
|
|
855
|
+
<returns>
|
|
856
|
+
</returns>
|
|
857
|
+
</member>
|
|
858
|
+
<member name="M:NServiceBus.Saga.ISagaPersister.Complete(NServiceBus.Saga.ISagaEntity)">
|
|
859
|
+
<summary>
|
|
860
|
+
Sets a saga as completed and removes it from the active saga list
|
|
861
|
+
in the persistence store.
|
|
862
|
+
</summary>
|
|
863
|
+
<param name="saga">The saga to complete.</param>
|
|
864
|
+
</member>
|
|
865
|
+
<member name="T:NServiceBus.Saga.IPersistSagas">
|
|
866
|
+
<summary>
|
|
867
|
+
Interface responsible for persisting sagas.
|
|
868
|
+
</summary>
|
|
869
|
+
</member>
|
|
870
|
+
<member name="T:NServiceBus.Saga.ISagaStartedBy`1">
|
|
871
|
+
<summary>
|
|
872
|
+
Use this interface to signify that when a message of the given type is
|
|
873
|
+
received, if a saga cannot be found by an <see cref="T:NServiceBus.Saga.IFindSagas`1" />
|
|
874
|
+
the saga will be created.
|
|
875
|
+
</summary>
|
|
876
|
+
<typeparam name="T">
|
|
877
|
+
</typeparam>
|
|
878
|
+
</member>
|
|
879
|
+
<member name="T:NServiceBus.Saga.IAmStartedByMessages`1">
|
|
880
|
+
<summary>
|
|
881
|
+
Use this interface to signify that when a message of the given type is
|
|
882
|
+
received, if a saga cannot be found by an <see cref="T:NServiceBus.Saga.IFindSagas`1" />
|
|
883
|
+
the saga will be created.
|
|
884
|
+
</summary>
|
|
885
|
+
<typeparam name="T">
|
|
886
|
+
</typeparam>
|
|
887
|
+
</member>
|
|
888
|
+
<member name="T:NServiceBus.Saga.Saga`1">
|
|
889
|
+
<summary>
|
|
890
|
+
This class is used to define sagas containing data and handling a message.
|
|
891
|
+
To handle more message types, implement <see cref="T:NServiceBus.IMessageHandler`1" />
|
|
892
|
+
for the relevant types.
|
|
893
|
+
To signify that the receipt of a message should start this saga,
|
|
894
|
+
implement <see cref="T:NServiceBus.Saga.ISagaStartedBy`1" /> for the relevant message type.
|
|
895
|
+
</summary>
|
|
896
|
+
<typeparam name="T">A type that implements <see cref="T:NServiceBus.Saga.ISagaEntity" />.</typeparam>
|
|
897
|
+
</member>
|
|
898
|
+
<member name="M:NServiceBus.Saga.Saga`1.ConfigureHowToFindSaga">
|
|
899
|
+
<summary>
|
|
900
|
+
Override this method in order to configure how this saga's data should be found.
|
|
901
|
+
Call ConfigureMapping<TMessage> for each property of each message you want
|
|
902
|
+
to use for lookup.
|
|
903
|
+
</summary>
|
|
904
|
+
</member>
|
|
905
|
+
<member name="M:NServiceBus.Saga.Saga`1.ConfigureMapping``1(System.Linq.Expressions.Expression{System.Func{`0,System.Object}},System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
|
|
906
|
+
<summary>
|
|
907
|
+
When the infrastructure is handling a message of the given type
|
|
908
|
+
this specifies which message property should be matched to
|
|
909
|
+
which saga entity property in the persistent saga store.
|
|
910
|
+
</summary>
|
|
911
|
+
<typeparam name="TMessage">
|
|
912
|
+
</typeparam>
|
|
913
|
+
<param name="sagaEntityProperty">
|
|
914
|
+
</param>
|
|
915
|
+
<param name="messageProperty">
|
|
916
|
+
</param>
|
|
917
|
+
</member>
|
|
918
|
+
<member name="M:NServiceBus.Saga.Saga`1.RequestTimeout(System.DateTime,System.Object)">
|
|
919
|
+
<summary>
|
|
920
|
+
Request for a timeout to occur at the given time.
|
|
921
|
+
Causes a callback to the <see cref="M:NServiceBus.Saga.Saga`1.Timeout(System.Object)" /> method with the given state.
|
|
922
|
+
</summary>
|
|
923
|
+
<param name="at">
|
|
924
|
+
</param>
|
|
925
|
+
<param name="withState">
|
|
926
|
+
</param>
|
|
927
|
+
</member>
|
|
928
|
+
<member name="M:NServiceBus.Saga.Saga`1.RequestTimeout(System.TimeSpan,System.Object)">
|
|
929
|
+
<summary>
|
|
930
|
+
Request for a timeout to occur at the given time.
|
|
931
|
+
Causes a callback to the <see cref="M:NServiceBus.Saga.Saga`1.Timeout(System.Object)" /> method with the given state.
|
|
932
|
+
</summary>
|
|
933
|
+
<param name="within">
|
|
934
|
+
</param>
|
|
935
|
+
<param name="withState">
|
|
936
|
+
</param>
|
|
937
|
+
</member>
|
|
938
|
+
<member name="M:NServiceBus.Saga.Saga`1.ReplyToOriginator(NServiceBus.IMessage[])">
|
|
939
|
+
<summary>
|
|
940
|
+
Sends the given messages using the bus to the endpoint that caused this saga to start.
|
|
941
|
+
</summary>
|
|
942
|
+
<param name="messages">
|
|
943
|
+
</param>
|
|
944
|
+
</member>
|
|
945
|
+
<member name="M:NServiceBus.Saga.Saga`1.ReplyToOriginator``1(System.Action{``0})">
|
|
946
|
+
<summary>
|
|
947
|
+
Instantiates a message of the given type, setting its properties using the given action,
|
|
948
|
+
and sends it using the bus to the endpoint that caused this saga to start.
|
|
949
|
+
</summary>
|
|
950
|
+
<typeparam name="TMessage">
|
|
951
|
+
</typeparam>
|
|
952
|
+
<param name="messageConstructor">
|
|
953
|
+
</param>
|
|
954
|
+
</member>
|
|
955
|
+
<member name="M:NServiceBus.Saga.Saga`1.MarkAsComplete">
|
|
956
|
+
<summary>
|
|
957
|
+
Marks the saga as complete.
|
|
958
|
+
This may result in the sagas state being deleted by the persister.
|
|
959
|
+
</summary>
|
|
960
|
+
</member>
|
|
961
|
+
<member name="M:NServiceBus.Saga.Saga`1.Timeout(System.Object)">
|
|
962
|
+
<summary>
|
|
963
|
+
Notifies that the timeout it previously requested occurred.
|
|
964
|
+
</summary>
|
|
965
|
+
<param name="state">The object passed as the "withState" parameter to RequestTimeout.</param>
|
|
966
|
+
</member>
|
|
967
|
+
<member name="P:NServiceBus.Saga.Saga`1.Data">
|
|
968
|
+
<summary>
|
|
969
|
+
The saga's strongly typed data.
|
|
970
|
+
</summary>
|
|
971
|
+
</member>
|
|
972
|
+
<member name="P:NServiceBus.Saga.Saga`1.Entity">
|
|
973
|
+
<summary>
|
|
974
|
+
A more generic projection on <see cref="P:NServiceBus.Saga.Saga`1.Data" />.
|
|
975
|
+
</summary>
|
|
976
|
+
</member>
|
|
977
|
+
<member name="P:NServiceBus.Saga.Saga`1.HandleReplyingToNullOriginator">
|
|
978
|
+
<summary>
|
|
979
|
+
Called by saga to notify the infrastructure when attempting to reply to message where the originator is null
|
|
980
|
+
</summary>
|
|
981
|
+
</member>
|
|
982
|
+
<member name="P:NServiceBus.Saga.Saga`1.Bus">
|
|
983
|
+
<summary>
|
|
984
|
+
Bus object used for retrieving the sender endpoint which caused this saga to start.
|
|
985
|
+
Necessary for <see cref="M:NServiceBus.Saga.Saga`1.ReplyToOriginator(NServiceBus.IMessage[])" />.
|
|
986
|
+
</summary>
|
|
987
|
+
</member>
|
|
988
|
+
<member name="P:NServiceBus.Saga.Saga`1.SagaMessageFindingConfiguration">
|
|
989
|
+
<summary>
|
|
990
|
+
Object used to configure mapping between saga properties and message properties
|
|
991
|
+
for the purposes of finding sagas when a message arrives.
|
|
992
|
+
|
|
993
|
+
Do NOT use at runtime (handling messages) - it will be null.
|
|
994
|
+
</summary>
|
|
995
|
+
</member>
|
|
996
|
+
<member name="P:NServiceBus.Saga.Saga`1.Completed">
|
|
997
|
+
<summary>
|
|
998
|
+
Indicates that the saga is complete.
|
|
999
|
+
In order to set this value, use the <see cref="M:NServiceBus.Saga.Saga`1.MarkAsComplete" /> method.
|
|
1000
|
+
</summary>
|
|
1001
|
+
</member>
|
|
1002
|
+
<member name="T:NServiceBus.Saga.TimeoutMessage">
|
|
1003
|
+
<summary>
|
|
1004
|
+
A message to signal a saga that a reminder was set.
|
|
1005
|
+
</summary>
|
|
1006
|
+
</member>
|
|
1007
|
+
<member name="M:NServiceBus.Saga.TimeoutMessage.#ctor">
|
|
1008
|
+
<summary>
|
|
1009
|
+
Default constructor for serialization purposes.
|
|
1010
|
+
</summary>
|
|
1011
|
+
</member>
|
|
1012
|
+
<member name="M:NServiceBus.Saga.TimeoutMessage.#ctor(System.DateTime,NServiceBus.Saga.ISagaEntity,System.Object)">
|
|
1013
|
+
<summary>
|
|
1014
|
+
Indicate a timeout at the expiration time for the given saga maintaining the given state.
|
|
1015
|
+
</summary>
|
|
1016
|
+
<param name="expiration">
|
|
1017
|
+
</param>
|
|
1018
|
+
<param name="saga">
|
|
1019
|
+
</param>
|
|
1020
|
+
<param name="state">
|
|
1021
|
+
</param>
|
|
1022
|
+
</member>
|
|
1023
|
+
<member name="M:NServiceBus.Saga.TimeoutMessage.#ctor(System.TimeSpan,NServiceBus.Saga.ISagaEntity,System.Object)">
|
|
1024
|
+
<summary>
|
|
1025
|
+
Indicate a timeout within the given time for the given saga maintaing the given state.
|
|
1026
|
+
</summary>
|
|
1027
|
+
<param name="expireIn">
|
|
1028
|
+
</param>
|
|
1029
|
+
<param name="saga">
|
|
1030
|
+
</param>
|
|
1031
|
+
<param name="state">
|
|
1032
|
+
</param>
|
|
1033
|
+
</member>
|
|
1034
|
+
<member name="M:NServiceBus.Saga.TimeoutMessage.#ctor(NServiceBus.Saga.ISagaEntity,System.Boolean)">
|
|
1035
|
+
<summary>
|
|
1036
|
+
Signal to the timeout manager that all other <see cref="T:NServiceBus.Saga.TimeoutMessage" />
|
|
1037
|
+
objects can be cleared for the given <see cref="N:NServiceBus.Saga" />.
|
|
1038
|
+
</summary>
|
|
1039
|
+
<param name="saga">
|
|
1040
|
+
</param>
|
|
1041
|
+
<param name="clear">
|
|
1042
|
+
</param>
|
|
1043
|
+
</member>
|
|
1044
|
+
<member name="M:NServiceBus.Saga.TimeoutMessage.HasNotExpired">
|
|
1045
|
+
<summary>
|
|
1046
|
+
Gets whether or not the TimeoutMessage has expired.
|
|
1047
|
+
</summary>
|
|
1048
|
+
<returns>true if the message has expired, otherwise false.</returns>
|
|
1049
|
+
</member>
|
|
1050
|
+
<member name="P:NServiceBus.Saga.TimeoutMessage.Expires">
|
|
1051
|
+
<summary>
|
|
1052
|
+
Gets/sets the date and time at which the timeout message is due to expire.
|
|
1053
|
+
Values are stored as <see cref="F:System.DateTimeKind.Utc" />.
|
|
1054
|
+
</summary>
|
|
1055
|
+
</member>
|
|
1056
|
+
<member name="P:NServiceBus.Saga.TimeoutMessage.SagaId">
|
|
1057
|
+
<summary>
|
|
1058
|
+
Gets/sets the Id of the workflow the TimeoutMessage is connected to.
|
|
1059
|
+
</summary>
|
|
1060
|
+
</member>
|
|
1061
|
+
<member name="P:NServiceBus.Saga.TimeoutMessage.State">
|
|
1062
|
+
<summary>
|
|
1063
|
+
Should be used for data to differentiate between various
|
|
1064
|
+
timeout occurrences.
|
|
1065
|
+
</summary>
|
|
1066
|
+
</member>
|
|
1067
|
+
<member name="P:NServiceBus.Saga.TimeoutMessage.ClearTimeout">
|
|
1068
|
+
<summary>
|
|
1069
|
+
When true, signals to the timeout manager that all other <see cref="T:NServiceBus.Saga.TimeoutMessage" /> objects
|
|
1070
|
+
can be cleared for the given <see cref="P:NServiceBus.Saga.TimeoutMessage.SagaId" />.
|
|
1071
|
+
</summary>
|
|
1072
|
+
</member>
|
|
1073
|
+
<member name="T:NServiceBus.Serialization.IMessageSerializer">
|
|
1074
|
+
<summary>
|
|
1075
|
+
Interface used for serializing and deserializing messages.
|
|
1076
|
+
</summary>
|
|
1077
|
+
</member>
|
|
1078
|
+
<member name="M:NServiceBus.Serialization.IMessageSerializer.Serialize(NServiceBus.IMessage[],System.IO.Stream)">
|
|
1079
|
+
<summary>
|
|
1080
|
+
Serializes the given set of messages into the given stream.
|
|
1081
|
+
</summary>
|
|
1082
|
+
<param name="messages">
|
|
1083
|
+
</param>
|
|
1084
|
+
<param name="stream">
|
|
1085
|
+
</param>
|
|
1086
|
+
</member>
|
|
1087
|
+
<member name="M:NServiceBus.Serialization.IMessageSerializer.Deserialize(System.IO.Stream)">
|
|
1088
|
+
<summary>
|
|
1089
|
+
Deserializes from the given stream a set of messages.
|
|
1090
|
+
</summary>
|
|
1091
|
+
<param name="stream">
|
|
1092
|
+
</param>
|
|
1093
|
+
<returns>
|
|
1094
|
+
</returns>
|
|
1095
|
+
</member>
|
|
1096
|
+
</members>
|
|
1097
|
+
</doc>
|