using System; using System.Collections.Generic; using System.Reflection; using System.Threading; using Implab.Parallels; namespace Implab { /// /// Класс для асинхронного получения результатов. Так называемое "обещание". /// /// Тип получаемого результата /// /// Сервис при обращении к его методу дает обещаиние о выполнении операции, /// клиент получив такое обещание может установить ряд обратных вызово для получения /// событий выполнения обещания, тоесть завершения операции и предоставлении результатов. /// /// Обещение может быть как выполнено, так и выполнено с ошибкой. Для подписки на /// данные события клиент должен использовать методы Then. /// /// /// Сервис, в свою очередь, по окончанию выполнения операции (возможно с ошибкой), /// использует методы Resolve либо Reject для оповещения клиетна о /// выполнении обещания. /// /// /// Если сервер успел выполнить обещание еще до того, как клиент на него подписался, /// то в момент подписки клиента будут вызваны соответсвующие события в синхронном /// режиме и клиент будет оповещен в любом случае. Иначе, обработчики добавляются в /// список в порядке подписания и в этом же порядке они будут вызваны при выполнении /// обещания. /// /// /// Обрабатывая результаты обещания можно преобразовывать результаты либо инициировать /// связанные асинхронные операции, которые также возвращают обещания. Для этого следует /// использовать соответствующую форму методе Then. /// /// /// Также хорошим правилом является то, что Resolve и Reject должен вызывать /// только инициатор обещания иначе могут возникнуть противоречия. /// /// public class Promise : IPromise { protected struct HandlerDescriptor { public Action resultHandler; public Func errorHandler; public Action cancellHandler; public Promise medium; public void Resolve(T result) { if (resultHandler != null) { try { resultHandler(result); } catch (Exception e) { Reject(e); return; } } if (medium != null) medium.Resolve(result); } public void Reject(Exception err) { if (errorHandler != null) { try { var res = errorHandler(err); if (medium != null) medium.Resolve(res); /*} catch (TransientPromiseException err2) { if (medium != null) medium.Reject(err2.InnerException);*/ } catch (Exception err2) { if (medium != null) medium.Reject(err2); } } else if (medium != null) medium.Reject(err); } public void Cancel() { if (cancellHandler != null) { try { cancellHandler(); } catch (Exception err) { Reject(err); return; } } if (medium != null) medium.Cancel(); } } const int UNRESOLVED_SATE = 0; const int TRANSITIONAL_STATE = 1; const int SUCCEEDED_STATE = 2; const int REJECTED_STATE = 3; const int CANCELLED_STATE = 4; int m_childrenCount; int m_state; T m_result; Exception m_error; readonly MTQueue m_handlers = new MTQueue(); public Promise() { } public Promise(IPromise parent) { if (parent != null) AddHandler( null, null, () => { if (parent.IsExclusive) parent.Cancel(); }, null, false ); } bool BeginTransit() { return UNRESOLVED_SATE == Interlocked.CompareExchange(ref m_state, TRANSITIONAL_STATE, UNRESOLVED_SATE); } void CompleteTransit(int state) { if (TRANSITIONAL_STATE != Interlocked.CompareExchange(ref m_state, state, TRANSITIONAL_STATE)) throw new InvalidOperationException("Can't complete transition when the object isn't in the transitional state"); } void WaitTransition() { while (m_state == TRANSITIONAL_STATE) { Thread.MemoryBarrier(); } } public bool IsResolved { get { Thread.MemoryBarrier(); return m_state > 1; } } public bool IsCancelled { get { Thread.MemoryBarrier(); return m_state == CANCELLED_STATE; } } public Type PromiseType { get { return typeof(T); } } /// /// Выполняет обещание, сообщая об успешном выполнении. /// /// Результат выполнения. /// Данное обещание уже выполнено public void Resolve(T result) { if (BeginTransit()) { m_result = result; CompleteTransit(SUCCEEDED_STATE); OnStateChanged(); } else { WaitTransition(); if (m_state != CANCELLED_STATE) throw new InvalidOperationException("The promise is already resolved"); } } /// /// Выполняет обещание, сообщая об успешном выполнении. Результатом выполнения будет пустое значения. /// /// /// Данный вариант удобен в случаях, когда интересен факт выполнения операции, нежели полученное значение. /// public void Resolve() { Resolve(default(T)); } /// /// Выполняет обещание, сообщая об ошибке /// /// /// Поскольку обещание должно работать в многопточной среде, при его выполнении сразу несколько потоков /// могу вернуть ошибку, при этом только первая будет использована в качестве результата, остальные /// будут проигнорированы. /// /// Исключение возникшее при выполнении операции /// Данное обещание уже выполнено public void Reject(Exception error) { if (BeginTransit()) { m_error = error is TransientPromiseException ? error.InnerException : error; CompleteTransit(REJECTED_STATE); OnStateChanged(); } else { WaitTransition(); if (m_state == SUCCEEDED_STATE) throw new InvalidOperationException("The promise is already resolved"); } } /// /// Отменяет операцию, если это возможно. /// /// Для определения была ли операция отменена следует использовать свойство . public void Cancel() { if (BeginTransit()) { CompleteTransit(CANCELLED_STATE); OnStateChanged(); } } public IPromise Then(Action success, Func error, Action cancel) { if (success == null && error == null && cancel == null) return this; var medium = new Promise(this); AddHandler(success, error, cancel, medium, true); return medium; } /// /// Adds new handlers to this promise. /// /// The handler of the successfully completed operation. /// This handler will recieve an operation result as a parameter. /// Handles an exception that may occur during the operation and returns the value which will be used as the result of the operation. /// The new promise chained to this one. public IPromise Then(Action success, Func error) { if (success == null && error == null) return this; var medium = new Promise(this); AddHandler(success, error, null, medium, true); return medium; } public IPromise Then(Action success) { if (success == null) return this; var medium = new Promise(this); AddHandler(success, null, null, medium, true); return medium; } /// /// Последний обработчик в цепочки обещаний. /// /// /// /// /// /// /// Данный метод не создает связанного с текущим обещания и предназначен для окончания /// фсинхронной цепочки. /// /// /// Если данный метод вызвать несколько раз, либо добавить другие обработчики, то цепочка /// не будет одиночной и, как следствие, будет невозможна отмена /// всей цепи обещаний снизу (с самого последнего обещания). /// /// public void On(Action success, Action error, Action cancel) { if (success == null && error == null && cancel == null) return; Func errorHandler = null; if (error != null) errorHandler = err => { error(err); return default(T); }; AddHandler(success, errorHandler, cancel, null, false); } public void On(Action success, Action error) { On(success, error, null); } public void On(Action success) { On(success, null, null); } public void On(Action handler, PromiseEventType events) { Safe.ArgumentNotNull(handler, "handler"); Action success = events.HasFlag(PromiseEventType.Success) ? new Action(x => handler()) : null; Func error = events.HasFlag(PromiseEventType.Error) ? new Func(e => { handler(); return default(T); }) : null; Action cancel = events.HasFlag(PromiseEventType.Cancelled) ? handler : null; AddHandler(success, error, cancel, null, false); } public IPromise Error(Action error) { if (error == null) return this; var medium = new Promise(this); AddHandler( null, e => { error(e); return default(T); }, null, medium, true ); return medium; } /// /// Handles error and allows to keep the promise. /// /// /// If the specified handler throws an exception, this exception will be used to reject the promise. /// /// The error handler which returns the result of the promise. /// New promise. public IPromise Error(Func handler) { if (handler == null) return this; var medium = new Promise(this); AddHandler(null, handler, null, medium, true); return medium; } /// /// Позволяет преобразовать результат выполения операции к новому типу. /// /// Новый тип результата. /// Преобразование результата к новому типу. /// Обработчик ошибки. Данный обработчик получит /// исключение возникшее при выполнении операции. /// Новое обещание, которое будет выполнено при выполнении исходного обещания. /// public IPromise Then(Func mapper, Func error, Action cancel) { Safe.ArgumentNotNull(mapper, "mapper"); // создаем прицепленное обещание var medium = new Promise(this); Action resultHandler = result => medium.Resolve(mapper(result)); Func errorHandler; if (error != null) errorHandler = e => { try { medium.Resolve(error(e)); } catch (Exception e2) { // в случае ошибки нужно передать исключение дальше по цепочке medium.Reject(e2); } return default(T); }; else errorHandler = e => { medium.Reject(e); return default(T); }; Action cancelHandler; if (cancel != null) cancelHandler = () => { cancel(); medium.Cancel(); }; else cancelHandler = medium.Cancel; AddHandler( resultHandler, errorHandler, cancelHandler, null, true ); return medium; } public IPromise Then(Func mapper, Func error) { return Then(mapper, error, null); } public IPromise Then(Func mapper) { return Then(mapper, null, null); } /// /// Сцепляет несколько аснхронных операций. Указанная асинхронная операция будет вызвана после /// выполнения текущей, а результат текущей операции может быть использован для инициализации /// новой операции. /// /// Тип результата указанной асинхронной операции. /// Асинхронная операция, которая должна будет начаться после выполнения текущей. /// Обработчик ошибки. Данный обработчик получит /// исключение возникшее при выполнении текуещй операции. /// Новое обещание, которое будет выполнено по окончанию указанной аснхронной операции. /// public IPromise Chain(Func> chained, Func> error, Action cancel) { Safe.ArgumentNotNull(chained, "chained"); // проблема в том, что на момент связывания еще не начата асинхронная операция, поэтому нужно // создать посредника, к которому будут подвызяваться следующие обработчики. // когда будет выполнена реальная асинхронная операция, она обратиться к посреднику, чтобы // передать через него результаты работы. var medium = new Promise(this); Action resultHandler = delegate(T result) { if (medium.IsCancelled) return; var promise = chained(result); promise.On( medium.Resolve, medium.Reject, () => medium.Reject(new OperationCanceledException()) // внешняя отмена связанной операции рассматривается как ошибка ); // notify chained operation that it's not needed anymore // порядок вызова Then, Cancelled важен, поскольку от этого // зависит IsExclusive medium.On( null, null, () => { if (promise.IsExclusive) promise.Cancel(); } ); }; Func errorHandler; if (error != null) errorHandler = delegate(Exception e) { try { var promise = error(e); promise.On( medium.Resolve, medium.Reject, () => medium.Reject(new OperationCanceledException()) // внешняя отмена связанной операции рассматривается как ошибка ); // notify chained operation that it's not needed anymore // порядок вызова Then, Cancelled важен, поскольку от этого // зависит IsExclusive medium.Cancelled(() => { if (promise.IsExclusive) promise.Cancel(); }); } catch (Exception e2) { medium.Reject(e2); } return default(T); }; else errorHandler = err => { medium.Reject(err); return default(T); }; Action cancelHandler; if (cancel != null) cancelHandler = () => { if (cancel != null) cancel(); medium.Cancel(); }; else cancelHandler = medium.Cancel; AddHandler( resultHandler, errorHandler, cancelHandler, null, true ); return medium; } public IPromise Chain(Func> chained, Func> error) { return Chain(chained, error, null); } public IPromise Chain(Func> chained) { return Chain(chained, null, null); } public IPromise Cancelled(Action handler) { var medium = new Promise(this); AddHandler(null, null, handler, medium, false); return medium; } /// /// Adds the specified handler for all cases (success, error, cancel) /// /// The handler that will be called anyway /// self public IPromise Anyway(Action handler) { Safe.ArgumentNotNull(handler, "handler"); var medium = new Promise(this); AddHandler( x => handler(), e => { handler(); throw new TransientPromiseException(e); }, handler, medium, true ); return medium; } /// /// Преобразует результат обещания к нужному типу /// /// /// public IPromise Cast() { return Then(x => (T2)(object)x, null); } /// /// Дожидается отложенного обещания и в случае успеха, возвращает /// его, результат, в противном случае бросает исключение. /// /// /// /// Если ожидание обещания было прервано по таймауту, это не значит, /// что обещание было отменено или что-то в этом роде, это только /// означает, что мы его не дождались, однако все зарегистрированные /// обработчики, как были так остались и они будут вызваны, когда /// обещание будет выполнено. /// /// /// Такое поведение вполне оправдано поскольку таймаут может истечь /// в тот момент, когда началась обработка цепочки обработчиков, и /// к тому же текущее обещание может стоять в цепочке обещаний и его /// отклонение может привести к непрогнозируемому результату. /// /// /// Время ожидания /// Результат выполнения обещания public T Join(int timeout) { var evt = new ManualResetEvent(false); Anyway(() => evt.Set()); if (!evt.WaitOne(timeout, true)) throw new TimeoutException(); switch (m_state) { case SUCCEEDED_STATE: return m_result; case CANCELLED_STATE: throw new OperationCanceledException(); case REJECTED_STATE: throw new TargetInvocationException(m_error); default: throw new ApplicationException(String.Format("Invalid promise state {0}", m_state)); } } public T Join() { return Join(Timeout.Infinite); } void AddHandler(Action success, Func error, Action cancel, Promise medium, bool inc) { if (inc) Interlocked.Increment(ref m_childrenCount); var handler = new HandlerDescriptor { resultHandler = success, errorHandler = error, cancellHandler = cancel, medium = medium }; bool queued; if (!IsResolved) { m_handlers.Enqueue(handler); queued = true; } else { // the promise is in resolved state, just invoke the handled with minimum overhead queued = false; InvokeHandler(handler); } if (queued && IsResolved && m_handlers.TryDequeue(out handler)) // if the promise have been resolved while we was adding handler to the queue // we can't guarantee that someone is still processing it // therefore we will fetch a handler from the queue and execute it // note that fetched handler may be not the one that we have added // even we can fetch no handlers at all :) InvokeHandler(handler); } protected virtual void InvokeHandler(HandlerDescriptor handler) { switch (m_state) { case SUCCEEDED_STATE: handler.Resolve(m_result); break; case REJECTED_STATE: handler.Reject(m_error); break; case CANCELLED_STATE: handler.Cancel(); break; default: // do nothing return; } } void OnStateChanged() { HandlerDescriptor handler; while (m_handlers.TryDequeue(out handler)) InvokeHandler(handler); } public bool IsExclusive { get { return m_childrenCount <= 1; } } /// /// Объединяет несколько обещаний в одно, результатом которого является массив результатов других обещаний. /// Если хотябы одно из переданных обещаний не будет выполнено, то новое обещение тоже не будет выполнено. /// При отмене нового обещания, переданные обещания также будут отменены, если никто больше на них не подписан. /// /// Список обещаний. Если список пустой, то результирующее обещание возвращается уже выполненным. /// Обещание объединяющее в себе результат переданных обещаний. /// не может быть null public static IPromise CreateComposite(IList> promises) { if (promises == null) throw new ArgumentNullException(); // создаем аккумулятор для результатов и результирующее обещание var result = new T[promises.Count]; var promise = new Promise(); // special case if (promises.Count == 0) { promise.Resolve(result); return promise; } int pending = promises.Count; for (int i = 0; i < promises.Count; i++) { var dest = i; if (promises[i] != null) { promises[i].Then( x => { result[dest] = x; if (Interlocked.Decrement(ref pending) == 0) promise.Resolve(result); }, e => { promise.Reject(e); return default(T); } ); } else { if (Interlocked.Decrement(ref pending) == 0) promise.Resolve(result); } } promise.Cancelled( () => { foreach (var d in promises) if (d != null && d.IsExclusive) d.Cancel(); } ); return promise; } /// /// Объединяет несколько обещаний в одно. Результирующее обещание будет выполнено при /// выполнении всех указанных обещаний. При этом возвращаемые значения первичных обещаний /// игнорируются. /// /// Коллекция первичных обещаний, которые будут объеденены в одно. /// Новое обещание, объединяющее в себе переданные. /// /// Если в коллекции встречаюься null, то они воспринимаются как выполненные обещания. /// public static IPromise CreateComposite(ICollection promises) { if (promises == null) throw new ArgumentNullException(); if (promises.Count == 0) return Promise.ResultToPromise(null); int countdown = promises.Count; var result = new Promise(); foreach (var d in promises) { if (d == null) { if (Interlocked.Decrement(ref countdown) == 0) result.Resolve(null); } else { d.Then(() => { if (Interlocked.Decrement(ref countdown) == 0) result.Resolve(null); }); } } result.Cancelled(() => { foreach (var d in promises) if (d != null && d.IsExclusive) d.Cancel(); }); return result; } public static Promise ResultToPromise(T result) { var p = new Promise(); p.Resolve(result); return p; } public static Promise ExceptionToPromise(Exception error) { if (error == null) throw new ArgumentNullException(); var p = new Promise(); p.Reject(error); return p; } #region IPromiseBase explicit implementation IPromise IPromise.Then(Action success, Action error, Action cancel) { return Then( success != null ? new Action(x => success()) : null, error != null ? new Func(e => { error(e); return default(T); }) : null, cancel ); } IPromise IPromise.Then(Action success, Action error) { return Then( success != null ? new Action(x => success()) : null, error != null ? new Func(e => { error(e); return default(T); }) : null ); } IPromise IPromise.Then(Action success) { Safe.ArgumentNotNull(success, "success"); return Then(x => success()); } IPromise IPromise.Chain(Func chained, Func error, Action cancel) { return ChainNoResult(chained, error, cancel); } IPromise ChainNoResult(Func chained, Func error, Action cancel) { Safe.ArgumentNotNull(chained, "chained"); var medium = new Promise(this); Action resultHandler = delegate { if (medium.IsCancelled) return; var promise = chained(); promise.On( medium.Resolve, medium.Reject, () => medium.Reject(new OperationCanceledException()) // внешняя отмена связанной операции рассматривается как ошибка ); // notify chained operation that it's not needed anymore // порядок вызова Then, Cancelled важен, поскольку от этого // зависит IsExclusive medium.Cancelled(() => { if (promise.IsExclusive) promise.Cancel(); }); }; Func errorHandler; if (error != null) errorHandler = delegate(Exception e) { try { var promise = error(e); promise.On( medium.Resolve, medium.Reject, () => medium.Reject(new OperationCanceledException()) // внешняя отмена связанной операции рассматривается как ошибка ); // notify chained operation that it's not needed anymore // порядок вызова Then, Cancelled важен, поскольку от этого // зависит IsExclusive medium.Cancelled(() => { if (promise.IsExclusive) promise.Cancel(); }); } catch (Exception e2) { medium.Reject(e2); } return default(T); }; else errorHandler = err => { medium.Reject(err); return default(T); }; Action cancelHandler; if (cancel != null) cancelHandler = () => { if (cancel != null) cancel(); medium.Cancel(); }; else cancelHandler = medium.Cancel; AddHandler( resultHandler, errorHandler, cancelHandler, null, true ); return medium; } IPromise IPromise.Chain(Func chained, Func error) { return ChainNoResult(chained, error, null); } IPromise IPromise.Chain(Func chained) { return ChainNoResult(chained, null, null); } void IPromise.On(Action success, Action error, Action cancel) { On(success != null ? new Action(x => success()) : null, error, cancel); } void IPromise.On(Action success, Action error) { On(x => success(), error, null); } void IPromise.On(Action success) { On(x => success(), null, null); } IPromise IPromise.Error(Action error) { return Error(error); } IPromise IPromise.Anyway(Action handler) { return Anyway(handler); } IPromise IPromise.Cancelled(Action handler) { return Cancelled(handler); } void IPromise.Join() { Join(); } void IPromise.Join(int timeout) { Join(timeout); } #endregion } }