@@ -0,0 +1,19 | |||
|
1 | using System; | |
|
2 | using System.Collections.Generic; | |
|
3 | using System.Linq; | |
|
4 | using System.Text; | |
|
5 | ||
|
6 | namespace Implab | |
|
7 | { | |
|
8 | public static class Safe | |
|
9 | { | |
|
10 | public static void Dispose<T>(ref T obj) where T : IDisposable | |
|
11 | { | |
|
12 | if (obj != null) | |
|
13 | { | |
|
14 | obj.Dispose(); | |
|
15 | obj = default(T); | |
|
16 | } | |
|
17 | } | |
|
18 | } | |
|
19 | } |
@@ -1,350 +1,355 | |||
|
1 | 1 | using System; |
|
2 | 2 | using System.Collections.Generic; |
|
3 | 3 | using System.Linq; |
|
4 | 4 | using System.Reflection; |
|
5 | 5 | using System.Text; |
|
6 | 6 | using System.Diagnostics; |
|
7 | 7 | using System.Threading; |
|
8 | 8 | |
|
9 | 9 | namespace Implab { |
|
10 | 10 | |
|
11 | 11 | public delegate void ErrorHandler(Exception e); |
|
12 | 12 | |
|
13 | 13 | public delegate void ResultHandler<T>(T result); |
|
14 | 14 | public delegate TNew ResultMapper<TSrc,TNew>(TSrc result); |
|
15 | 15 | public delegate Promise<TNew> ChainedOperation<TSrc,TNew>(TSrc result); |
|
16 | 16 | |
|
17 | 17 | /// <summary> |
|
18 | 18 | /// Класс для асинхронного получения результатов. Так называемое "обещание". |
|
19 | 19 | /// </summary> |
|
20 | 20 | /// <typeparam name="T">Тип получаемого результата</typeparam> |
|
21 | 21 | /// <remarks> |
|
22 | 22 | /// <para>Сервис при обращении к его методу дает обещаиние о выполнении операции, |
|
23 | 23 | /// клиент получив такое обещание может установить ряд обратных вызово для получения |
|
24 | 24 | /// событий выполнения обещания, тоесть завершения операции и предоставлении результатов.</para> |
|
25 | 25 | /// <para> |
|
26 | 26 | /// Обещение может быть как выполнено, так и выполнено с ошибкой. Для подписки на |
|
27 | 27 | /// данные события клиент должен использовать методы <c>Then</c>. |
|
28 | 28 | /// </para> |
|
29 | 29 | /// <para> |
|
30 | 30 | /// Сервис, в свою очередь, по окончанию выполнения операции (возможно с ошибкой), |
|
31 | 31 | /// использует методы <c>Resolve</c> либо <c>Reject</c> для оповещения клиетна о |
|
32 | 32 | /// выполнении обещания. |
|
33 | 33 | /// </para> |
|
34 | 34 | /// <para> |
|
35 | 35 | /// Если сервер успел выполнить обещание еще до того, как клиент на него подписался, |
|
36 | 36 | /// то в момент подписки клиента будут вызваны соответсвующие события в синхронном |
|
37 | 37 | /// режиме и клиент будет оповещен в любом случае. Иначе, обработчики добавляются в |
|
38 | 38 | /// список в порядке подписания и в этом же порядке они будут вызваны при выполнении |
|
39 | 39 | /// обещания. |
|
40 | 40 | /// </para> |
|
41 | 41 | /// <para> |
|
42 | 42 | /// Обрабатывая результаты обещания можно преобразовывать результаты либо инициировать |
|
43 | 43 | /// связанные асинхронные операции, которые также возвращают обещания. Для этого следует |
|
44 | 44 | /// использовать соответствующую форму методе <c>Then</c>. |
|
45 | 45 | /// </para> |
|
46 | 46 | /// <para> |
|
47 | 47 | /// Также хорошим правилом является то, что <c>Resolve</c> и <c>Reject</c> должен вызывать |
|
48 | 48 | /// только инициатор обещания иначе могут возникнуть противоречия. |
|
49 | 49 | /// </para> |
|
50 | 50 | /// </remarks> |
|
51 | 51 | public class Promise<T> { |
|
52 | 52 | |
|
53 | 53 | struct ResultHandlerInfo { |
|
54 | 54 | public ResultHandler<T> resultHandler; |
|
55 | 55 | public ErrorHandler errorHandler; |
|
56 | 56 | } |
|
57 | 57 | |
|
58 | 58 | enum State { |
|
59 | 59 | Unresolved, |
|
60 | 60 | Resolving, |
|
61 | 61 | Resolved, |
|
62 | 62 | Cancelled |
|
63 | 63 | } |
|
64 | 64 | |
|
65 | 65 | LinkedList<ResultHandlerInfo> m_handlersChain = new LinkedList<ResultHandlerInfo>(); |
|
66 | 66 | State m_state; |
|
67 | 67 | bool m_cancellable; |
|
68 | 68 | T m_result; |
|
69 | 69 | Exception m_error; |
|
70 | 70 | |
|
71 | 71 | public Promise() { |
|
72 | 72 | m_cancellable = true; |
|
73 | 73 | } |
|
74 | 74 | |
|
75 | 75 | /// <summary> |
|
76 | 76 | /// Событие, возникающее при отмене асинхронной операции. |
|
77 | 77 | /// </summary> |
|
78 | 78 | /// <description> |
|
79 | 79 | /// Как правило используется для оповещения объекта, выполняющего асинхронную операцию, о том, что ее следует отменить. |
|
80 | 80 | /// </description> |
|
81 | 81 | public event EventHandler Cancelled; |
|
82 | 82 | |
|
83 | 83 | /// <summary> |
|
84 | 84 | /// Выполняет обещание, сообщая об успешном выполнении. |
|
85 | 85 | /// </summary> |
|
86 | 86 | /// <param name="result">Результат выполнения.</param> |
|
87 | 87 | /// <exception cref="InvalidOperationException">Данное обещание уже выполнено</exception> |
|
88 | 88 | public void Resolve(T result) { |
|
89 | 89 | lock (this) { |
|
90 | 90 | if (m_state == State.Cancelled) |
|
91 | 91 | return; |
|
92 | 92 | if (m_state != State.Unresolved) |
|
93 | 93 | throw new InvalidOperationException("The promise is already resolved"); |
|
94 | 94 | m_result = result; |
|
95 | 95 | m_state = State.Resolving; |
|
96 | 96 | } |
|
97 | 97 | |
|
98 | 98 | ResultHandlerInfo handler; |
|
99 | 99 | while (FetchNextHandler(out handler)) |
|
100 | 100 | InvokeHandler(handler); |
|
101 | 101 | } |
|
102 | 102 | |
|
103 | 103 | /// <summary> |
|
104 | 104 | /// Выполняет обещание, сообщая об ошибке |
|
105 | 105 | /// </summary> |
|
106 | 106 | /// <param name="error">Исключение возникшее при выполнении операции</param> |
|
107 | 107 | /// <exception cref="InvalidOperationException">Данное обещание уже выполнено</exception> |
|
108 | 108 | public void Reject(Exception error) { |
|
109 | 109 | lock (this) { |
|
110 | 110 | if (m_state == State.Cancelled) |
|
111 | 111 | return; |
|
112 | 112 | if (m_state != State.Unresolved) |
|
113 | 113 | throw new InvalidOperationException("The promise is already resolved"); |
|
114 | 114 | m_error = error; |
|
115 | 115 | m_state = State.Resolving; |
|
116 | 116 | } |
|
117 | 117 | |
|
118 | 118 | ResultHandlerInfo handler; |
|
119 | 119 | while (FetchNextHandler(out handler)) |
|
120 | 120 | InvokeHandler(handler); |
|
121 | 121 | } |
|
122 | 122 | |
|
123 | 123 | /// <summary> |
|
124 | 124 | /// Отменяет операцию, если это возможно. |
|
125 | 125 | /// </summary> |
|
126 | 126 | /// <returns><c>true</c> Операция была отменена, обработчики не будут вызваны.<c>false</c> отмена не возможна, поскольку обещание уже выполнено и обработчики отработали.</returns> |
|
127 | 127 | public bool Cancel() { |
|
128 | 128 | lock(this) { |
|
129 | 129 | if (m_state == State.Unresolved && m_cancellable) { |
|
130 | m_state = State.Cancelled; | |
|
130 | m_state = State.Cancelled; | |
|
131 | EventHandler temp = Cancelled; | |
|
132 | ||
|
133 | if (temp != null) | |
|
134 | temp(this,new EventArgs()); | |
|
135 | ||
|
131 | 136 | return true; |
|
132 | 137 | } else |
|
133 | 138 | return false; |
|
134 | 139 | } |
|
135 | 140 | } |
|
136 | 141 | |
|
137 | 142 | /// <summary> |
|
138 | 143 | /// Добавляет обработчики событий выполнения обещания. |
|
139 | 144 | /// </summary> |
|
140 | 145 | /// <param name="success">Обработчик успешного выполнения обещания. |
|
141 | 146 | /// Данному обработчику будет передан результат выполнения операции.</param> |
|
142 | 147 | /// <param name="error">Обработчик ошибки. Данный обработчик получит |
|
143 | 148 | /// исключение возникшее при выполнении операции.</param> |
|
144 | 149 | /// <returns>Само обещание</returns> |
|
145 | 150 | public Promise<T> Then(ResultHandler<T> success, ErrorHandler error) { |
|
146 | 151 | if (success == null && error == null) |
|
147 | 152 | return this; |
|
148 | 153 | |
|
149 | 154 | AddHandler(new ResultHandlerInfo() { |
|
150 | 155 | resultHandler = success, |
|
151 | 156 | errorHandler = error |
|
152 | 157 | }); |
|
153 | 158 | |
|
154 | 159 | return this; |
|
155 | 160 | } |
|
156 | 161 | |
|
157 | 162 | public Promise<T> Then(ResultHandler<T> success) { |
|
158 | 163 | return Then (success, null); |
|
159 | 164 | } |
|
160 | 165 | |
|
161 | 166 | public Promise<T> Anyway(Action handler) { |
|
162 | 167 | if (handler == null) |
|
163 | 168 | return this; |
|
164 | 169 | AddHandler(new ResultHandlerInfo { |
|
165 | 170 | resultHandler = x => handler(), |
|
166 | 171 | errorHandler = x => handler() |
|
167 | 172 | }); |
|
168 | 173 | |
|
169 | 174 | return this; |
|
170 | 175 | } |
|
171 | 176 | |
|
172 | 177 | /// <summary> |
|
173 | 178 | /// Позволяет преобразовать результат выполения операции к новому типу. |
|
174 | 179 | /// </summary> |
|
175 | 180 | /// <typeparam name="TNew">Новый тип результата.</typeparam> |
|
176 | 181 | /// <param name="mapper">Преобразование результата к новому типу.</param> |
|
177 | 182 | /// <param name="error">Обработчик ошибки. Данный обработчик получит |
|
178 | 183 | /// исключение возникшее при выполнении операции.</param> |
|
179 | 184 | /// <returns>Новое обещание, которое будет выполнено при выполнении исходного обещания.</returns> |
|
180 | 185 | public Promise<TNew> Map<TNew>(ResultMapper<T, TNew> mapper, ErrorHandler error) { |
|
181 | 186 | if (mapper == null) |
|
182 | 187 | throw new ArgumentNullException("mapper"); |
|
183 | 188 | |
|
184 | 189 | // создаем прицепленное обещание |
|
185 | 190 | Promise<TNew> chained = new Promise<TNew>(); |
|
186 | 191 | |
|
187 | 192 | AddHandler(new ResultHandlerInfo() { |
|
188 | 193 | resultHandler = delegate(T result) { |
|
189 | 194 | try { |
|
190 | 195 | // если преобразование выдаст исключение, то сработает reject сцепленного deferred |
|
191 | 196 | chained.Resolve(mapper(result)); |
|
192 | 197 | } catch (Exception e) { |
|
193 | 198 | chained.Reject(e); |
|
194 | 199 | } |
|
195 | 200 | }, |
|
196 | 201 | errorHandler = delegate(Exception e) { |
|
197 | 202 | if (error != null) |
|
198 | 203 | error(e); |
|
199 | 204 | // в случае ошибки нужно передать исключение дальше по цепочке |
|
200 | 205 | chained.Reject(e); |
|
201 | 206 | } |
|
202 | 207 | }); |
|
203 | 208 | |
|
204 | 209 | return chained; |
|
205 | 210 | } |
|
206 | 211 | |
|
207 | 212 | public Promise<TNew> Map<TNew>(ResultMapper<T, TNew> mapper) { |
|
208 | 213 | return Map (mapper, null); |
|
209 | 214 | } |
|
210 | 215 | |
|
211 | 216 | /// <summary> |
|
212 | 217 | /// Сцепляет несколько аснхронных операций. Указанная асинхронная операция будет вызвана после |
|
213 | 218 | /// выполнения текущей, а результат текущей операции может быть использован для инициализации |
|
214 | 219 | /// новой операции. |
|
215 | 220 | /// </summary> |
|
216 | 221 | /// <typeparam name="TNew">Тип результата указанной асинхронной операции.</typeparam> |
|
217 | 222 | /// <param name="chained">Асинхронная операция, которая должна будет начаться после выполнения текущей.</param> |
|
218 | 223 | /// <param name="error">Обработчик ошибки. Данный обработчик получит |
|
219 | 224 | /// исключение возникшее при выполнении текуещй операции.</param> |
|
220 | 225 | /// <returns>Новое обещание, которое будет выполнено по окончанию указанной аснхронной операции.</returns> |
|
221 | 226 | public Promise<TNew> Chain<TNew>(ChainedOperation<T, TNew> chained, ErrorHandler error) { |
|
222 | 227 | |
|
223 | 228 | // проблема в том, что на момент связывания еще не начата асинхронная операция, поэтому нужно |
|
224 | 229 | // создать посредника, к которому будут подвызяваться следующие обработчики. |
|
225 | 230 | // когда будет выполнена реальная асинхронная операция, она обратиться к посреднику, чтобы |
|
226 | 231 | // передать через него результаты работы. |
|
227 | 232 | Promise<TNew> medium = new Promise<TNew>(); |
|
228 | 233 | |
|
229 | 234 | AddHandler(new ResultHandlerInfo() { |
|
230 | 235 | resultHandler = delegate(T result) { |
|
231 | 236 | try { |
|
232 | 237 | chained(result).Then( |
|
233 | 238 | x => medium.Resolve(x), |
|
234 | 239 | e => medium.Reject(e) |
|
235 | 240 | ); |
|
236 | 241 | } catch(Exception e) { |
|
237 | 242 | // если сцепленное действие выдало исключение вместо обещания, то передаем ошибку по цепочке |
|
238 | 243 | medium.Reject(e); |
|
239 | 244 | } |
|
240 | 245 | }, |
|
241 | 246 | errorHandler = delegate(Exception e) { |
|
242 | 247 | if (error != null) |
|
243 | 248 | error(e); |
|
244 | 249 | // в случае ошибки нужно передать исключение дальше по цепочке |
|
245 | 250 | medium.Reject(e); |
|
246 | 251 | } |
|
247 | 252 | }); |
|
248 | 253 | |
|
249 | 254 | return medium; |
|
250 | 255 | } |
|
251 | 256 | |
|
252 | 257 | public Promise<TNew> Chain<TNew>(ChainedOperation<T, TNew> chained) { |
|
253 | 258 | return Chain (chained, null); |
|
254 | 259 | } |
|
255 | 260 | |
|
256 | 261 | /// <summary> |
|
257 | 262 | /// Дожидается отложенного обещания и в случае успеха, возвращает |
|
258 | 263 | /// его, результат, в противном случае бросает исключение. |
|
259 | 264 | /// </summary> |
|
260 | 265 | /// <remarks> |
|
261 | 266 | /// <para> |
|
262 | 267 | /// Если ожидание обещания было прервано по таймауту, это не значит, |
|
263 | 268 | /// что обещание было отменено или что-то в этом роде, это только |
|
264 | 269 | /// означает, что мы его не дождались, однако все зарегистрированные |
|
265 | 270 | /// обработчики, как были так остались и они будут вызваны, когда |
|
266 | 271 | /// обещание будет выполнено. |
|
267 | 272 | /// </para> |
|
268 | 273 | /// <para> |
|
269 | 274 | /// Такое поведение вполне оправдано поскольку таймаут может истечь |
|
270 | 275 | /// в тот момент, когда началась обработка цепочки обработчиков, и |
|
271 | 276 | /// к тому же текущее обещание может стоять в цепочке обещаний и его |
|
272 | 277 | /// отклонение может привести к непрогнозируемому результату. |
|
273 | 278 | /// </para> |
|
274 | 279 | /// </remarks> |
|
275 | 280 | /// <param name="timeout">Время ожидания</param> |
|
276 | 281 | /// <returns>Результат выполнения обещания</returns> |
|
277 | 282 | public T Join(int timeout) { |
|
278 | 283 | ManualResetEvent evt = new ManualResetEvent(false); |
|
279 | 284 | Anyway(() => evt.Set()); |
|
280 | 285 | |
|
281 | 286 | if (!evt.WaitOne(timeout, true)) |
|
282 | 287 | throw new TimeoutException(); |
|
283 | 288 | |
|
284 | 289 | if (m_error != null) |
|
285 | 290 | throw new TargetInvocationException( m_error ); |
|
286 | 291 | else |
|
287 | 292 | return m_result; |
|
288 | 293 | } |
|
289 | 294 | |
|
290 | 295 | public T Join() { |
|
291 | 296 | return Join(Timeout.Infinite); |
|
292 | 297 | } |
|
293 | 298 | |
|
294 | 299 | /// <summary> |
|
295 | 300 | /// Данный метод последовательно извлекает обработчики обещания и когда |
|
296 | 301 | /// их больше не осталось - ставит состояние "разрешено". |
|
297 | 302 | /// </summary> |
|
298 | 303 | /// <param name="handler">Информация об обработчике</param> |
|
299 | 304 | /// <returns>Признак того, что еще остались обработчики в очереди</returns> |
|
300 | 305 | bool FetchNextHandler(out ResultHandlerInfo handler) { |
|
301 | 306 | handler = default(ResultHandlerInfo); |
|
302 | 307 | |
|
303 | 308 | lock (this) { |
|
304 | 309 | Debug.Assert(m_state == State.Resolving); |
|
305 | 310 | |
|
306 | 311 | if (m_handlersChain.Count > 0) { |
|
307 | 312 | handler = m_handlersChain.First.Value; |
|
308 | 313 | m_handlersChain.RemoveFirst(); |
|
309 | 314 | return true; |
|
310 | 315 | } else { |
|
311 | 316 | m_state = State.Resolved; |
|
312 | 317 | return false; |
|
313 | 318 | } |
|
314 | 319 | } |
|
315 | 320 | } |
|
316 | 321 | |
|
317 | 322 | void AddHandler(ResultHandlerInfo handler) { |
|
318 | 323 | bool invokeRequired = false; |
|
319 | 324 | |
|
320 | 325 | lock (this) { |
|
321 | 326 | if (m_state != State.Resolved) |
|
322 | 327 | m_handlersChain.AddLast(handler); |
|
323 | 328 | else |
|
324 | 329 | invokeRequired = true; |
|
325 | 330 | } |
|
326 | 331 | |
|
327 | 332 | // обработчики не должны блокировать сам объект |
|
328 | 333 | if (invokeRequired) |
|
329 | 334 | InvokeHandler(handler); |
|
330 | 335 | } |
|
331 | 336 | |
|
332 | 337 | void InvokeHandler(ResultHandlerInfo handler) { |
|
333 | 338 | if (m_error == null) { |
|
334 | 339 | try { |
|
335 | 340 | if (handler.resultHandler != null) |
|
336 | 341 | handler.resultHandler(m_result); |
|
337 | 342 | } catch { } |
|
338 | 343 | } |
|
339 | 344 | |
|
340 | 345 | if (m_error != null) { |
|
341 | 346 | try { |
|
342 | 347 | if (handler.errorHandler !=null) |
|
343 | 348 | handler.errorHandler(m_error); |
|
344 | 349 | } catch { } |
|
345 | 350 | } |
|
346 | 351 | } |
|
347 | 352 | |
|
348 | 353 | |
|
349 | 354 | } |
|
350 | 355 | } |
General Comments 0
You need to be logged in to leave comments.
Login now