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