Mercurial > pub > ImplabNet
changeset 6:dfa21d507bc5
*refactoring: Promise.Then now returns a new chained promise
*fixed bug with animations when multiple events fired simultaneously
author | cin |
---|---|
date | Mon, 21 Oct 2013 02:34:31 +0400 |
parents | f2559580b481 |
children | 7ea9363fef6c 0c924dff5498 |
files | Implab.Fx/Animation.cs Implab.suo Implab/Promise.cs |
diffstat | 3 files changed, 350 insertions(+), 308 deletions(-) [+] |
line wrap: on
line diff
--- a/Implab.Fx/Animation.cs Tue Sep 24 03:31:24 2013 +0400 +++ b/Implab.Fx/Animation.cs Mon Oct 21 02:34:31 2013 +0400 @@ -51,7 +51,7 @@ { var timer = new Timer(m_delay); - timer.AutoReset = true; + timer.AutoReset = false; timer.SynchronizingObject = m_syncronizationObject; timer.Elapsed += new ElapsedEventHandler(timer_Elapsed);
--- a/Implab/Promise.cs Tue Sep 24 03:31:24 2013 +0400 +++ b/Implab/Promise.cs Mon Oct 21 02:34:31 2013 +0400 @@ -8,348 +8,390 @@ namespace Implab { - public delegate void ErrorHandler(Exception e); + public delegate void ErrorHandler(Exception e); + + public delegate void ResultHandler<T>(T result); + public delegate TNew ResultMapper<TSrc, TNew>(TSrc result); + public delegate Promise<TNew> ChainedOperation<TSrc, TNew>(TSrc result); - public delegate void ResultHandler<T>(T result); - public delegate TNew ResultMapper<TSrc,TNew>(TSrc result); - public delegate Promise<TNew> ChainedOperation<TSrc,TNew>(TSrc result); + /// <summary> + /// Класс для асинхронного получения результатов. Так называемое "обещание". + /// </summary> + /// <typeparam name="T">Тип получаемого результата</typeparam> + /// <remarks> + /// <para>Сервис при обращении к его методу дает обещаиние о выполнении операции, + /// клиент получив такое обещание может установить ряд обратных вызово для получения + /// событий выполнения обещания, тоесть завершения операции и предоставлении результатов.</para> + /// <para> + /// Обещение может быть как выполнено, так и выполнено с ошибкой. Для подписки на + /// данные события клиент должен использовать методы <c>Then</c>. + /// </para> + /// <para> + /// Сервис, в свою очередь, по окончанию выполнения операции (возможно с ошибкой), + /// использует методы <c>Resolve</c> либо <c>Reject</c> для оповещения клиетна о + /// выполнении обещания. + /// </para> + /// <para> + /// Если сервер успел выполнить обещание еще до того, как клиент на него подписался, + /// то в момент подписки клиента будут вызваны соответсвующие события в синхронном + /// режиме и клиент будет оповещен в любом случае. Иначе, обработчики добавляются в + /// список в порядке подписания и в этом же порядке они будут вызваны при выполнении + /// обещания. + /// </para> + /// <para> + /// Обрабатывая результаты обещания можно преобразовывать результаты либо инициировать + /// связанные асинхронные операции, которые также возвращают обещания. Для этого следует + /// использовать соответствующую форму методе <c>Then</c>. + /// </para> + /// <para> + /// Также хорошим правилом является то, что <c>Resolve</c> и <c>Reject</c> должен вызывать + /// только инициатор обещания иначе могут возникнуть противоречия. + /// </para> + /// </remarks> + public class Promise<T> { - /// <summary> - /// Класс для асинхронного получения результатов. Так называемое "обещание". - /// </summary> - /// <typeparam name="T">Тип получаемого результата</typeparam> - /// <remarks> - /// <para>Сервис при обращении к его методу дает обещаиние о выполнении операции, - /// клиент получив такое обещание может установить ряд обратных вызово для получения - /// событий выполнения обещания, тоесть завершения операции и предоставлении результатов.</para> - /// <para> - /// Обещение может быть как выполнено, так и выполнено с ошибкой. Для подписки на - /// данные события клиент должен использовать методы <c>Then</c>. - /// </para> - /// <para> - /// Сервис, в свою очередь, по окончанию выполнения операции (возможно с ошибкой), - /// использует методы <c>Resolve</c> либо <c>Reject</c> для оповещения клиетна о - /// выполнении обещания. - /// </para> - /// <para> - /// Если сервер успел выполнить обещание еще до того, как клиент на него подписался, - /// то в момент подписки клиента будут вызваны соответсвующие события в синхронном - /// режиме и клиент будет оповещен в любом случае. Иначе, обработчики добавляются в - /// список в порядке подписания и в этом же порядке они будут вызваны при выполнении - /// обещания. - /// </para> - /// <para> - /// Обрабатывая результаты обещания можно преобразовывать результаты либо инициировать - /// связанные асинхронные операции, которые также возвращают обещания. Для этого следует - /// использовать соответствующую форму методе <c>Then</c>. - /// </para> - /// <para> - /// Также хорошим правилом является то, что <c>Resolve</c> и <c>Reject</c> должен вызывать - /// только инициатор обещания иначе могут возникнуть противоречия. - /// </para> - /// </remarks> - public class Promise<T> { + struct ResultHandlerInfo { + public ResultHandler<T> resultHandler; + public ErrorHandler errorHandler; + } + + enum State { + Unresolved, + Resolving, + Resolved, + Cancelled + } + + LinkedList<ResultHandlerInfo> m_handlersChain = new LinkedList<ResultHandlerInfo>(); + State m_state; + bool m_cancellable; + T m_result; + Exception m_error; + + public Promise() { + m_cancellable = true; + } - struct ResultHandlerInfo { - public ResultHandler<T> resultHandler; - public ErrorHandler errorHandler; - } - - enum State { - Unresolved, - Resolving, - Resolved, - Cancelled - } + /// <summary> + /// Событие, возникающее при отмене асинхронной операции. + /// </summary> + /// <description> + /// Как правило используется для оповещения объекта, выполняющего асинхронную операцию, о том, что ее следует отменить. + /// </description> + public event EventHandler Cancelled; - LinkedList<ResultHandlerInfo> m_handlersChain = new LinkedList<ResultHandlerInfo>(); - State m_state; - bool m_cancellable; - T m_result; - Exception m_error; + /// <summary> + /// Выполняет обещание, сообщая об успешном выполнении. + /// </summary> + /// <param name="result">Результат выполнения.</param> + /// <exception cref="InvalidOperationException">Данное обещание уже выполнено</exception> + public void Resolve(T result) { + lock (this) { + if (m_state == State.Cancelled) + return; + if (m_state != State.Unresolved) + throw new InvalidOperationException("The promise is already resolved"); + m_result = result; + m_state = State.Resolving; + } - public Promise() { - m_cancellable = true; - } - - /// <summary> - /// Событие, возникающее при отмене асинхронной операции. - /// </summary> - /// <description> - /// Как правило используется для оповещения объекта, выполняющего асинхронную операцию, о том, что ее следует отменить. - /// </description> - public event EventHandler Cancelled; + ResultHandlerInfo handler; + while (FetchNextHandler(out handler)) + InvokeHandler(handler); + } - /// <summary> - /// Выполняет обещание, сообщая об успешном выполнении. - /// </summary> - /// <param name="result">Результат выполнения.</param> - /// <exception cref="InvalidOperationException">Данное обещание уже выполнено</exception> - public void Resolve(T result) { - lock (this) { - if (m_state == State.Cancelled) - return; - if (m_state != State.Unresolved) - throw new InvalidOperationException("The promise is already resolved"); - m_result = result; - m_state = State.Resolving; - } - - ResultHandlerInfo handler; - while (FetchNextHandler(out handler)) - InvokeHandler(handler); - } + /// <summary> + /// Выполняет обещание, сообщая об ошибке + /// </summary> + /// <param name="error">Исключение возникшее при выполнении операции</param> + /// <exception cref="InvalidOperationException">Данное обещание уже выполнено</exception> + public void Reject(Exception error) { + lock (this) { + if (m_state == State.Cancelled) + return; + if (m_state != State.Unresolved) + throw new InvalidOperationException("The promise is already resolved"); + m_error = error; + m_state = State.Resolving; + } - /// <summary> - /// Выполняет обещание, сообщая об ошибке - /// </summary> - /// <param name="error">Исключение возникшее при выполнении операции</param> - /// <exception cref="InvalidOperationException">Данное обещание уже выполнено</exception> - public void Reject(Exception error) { - lock (this) { - if (m_state == State.Cancelled) - return; - if (m_state != State.Unresolved) - throw new InvalidOperationException("The promise is already resolved"); - m_error = error; - m_state = State.Resolving; - } + ResultHandlerInfo handler; + while (FetchNextHandler(out handler)) + InvokeHandler(handler); + } - ResultHandlerInfo handler; - while (FetchNextHandler(out handler)) - InvokeHandler(handler); - } + /// <summary> + /// Отменяет операцию, если это возможно. + /// </summary> + /// <returns><c>true</c> Операция была отменена, обработчики не будут вызваны.<c>false</c> отмена не возможна, поскольку обещание уже выполнено и обработчики отработали.</returns> + public bool Cancel() { + lock (this) { + if (m_state == State.Unresolved && m_cancellable) { + m_state = State.Cancelled; + EventHandler temp = Cancelled; + + if (temp != null) + temp(this, new EventArgs()); + + return true; + } else + return false; + } + } - /// <summary> - /// Отменяет операцию, если это возможно. - /// </summary> - /// <returns><c>true</c> Операция была отменена, обработчики не будут вызваны.<c>false</c> отмена не возможна, поскольку обещание уже выполнено и обработчики отработали.</returns> - public bool Cancel() { - lock(this) { - if (m_state == State.Unresolved && m_cancellable) { - m_state = State.Cancelled; - EventHandler temp = Cancelled; - - if (temp != null) - temp(this,new EventArgs()); - - return true; - } else - return false; - } - } + /// <summary> + /// Добавляет обработчики событий выполнения обещания. + /// </summary> + /// <param name="success">Обработчик успешного выполнения обещания. + /// Данному обработчику будет передан результат выполнения операции.</param> + /// <param name="error">Обработчик ошибки. Данный обработчик получит + /// исключение возникшее при выполнении операции.</param> + /// <returns>Само обещание</returns> + public Promise<T> Then(ResultHandler<T> success, ErrorHandler error) { + if (success == null && error == null) + return this; + + var medium = new Promise<T>(); + + var handlerInfo = new ResultHandlerInfo(); + + if (success != null) + handlerInfo.resultHandler = x => { + try { + success(x); + medium.Resolve(x); + } catch (Exception e) { + medium.Reject(e); + } + }; + else + handlerInfo.resultHandler = x => medium.Resolve(x); - /// <summary> - /// Добавляет обработчики событий выполнения обещания. - /// </summary> - /// <param name="success">Обработчик успешного выполнения обещания. - /// Данному обработчику будет передан результат выполнения операции.</param> - /// <param name="error">Обработчик ошибки. Данный обработчик получит - /// исключение возникшее при выполнении операции.</param> - /// <returns>Само обещание</returns> - public Promise<T> Then(ResultHandler<T> success, ErrorHandler error) { - if (success == null && error == null) - return this; + if (error != null) + handlerInfo.errorHandler = x => { + try { + error(x); + } catch { } + medium.Reject(x); + }; + else + handlerInfo.errorHandler = x => medium.Reject(x); - AddHandler(new ResultHandlerInfo() { - resultHandler = success, - errorHandler = error - }); + AddHandler(handlerInfo); - return this; - } + return medium; + } - public Promise<T> Then(ResultHandler<T> success) { - return Then (success, null); - } + public Promise<T> Then(ResultHandler<T> success) { + return Then(success, null); + } - public Promise<T> Anyway(Action handler) { - if (handler == null) - return this; - AddHandler(new ResultHandlerInfo { - resultHandler = x => handler(), - errorHandler = x => handler() - }); + public Promise<T> Error(ErrorHandler error) { + return Then(null, error); + } - return this; - } + public Promise<T> Anyway(Action handler) { + if (handler == null) + return this; + + var medium = new Promise<T>(); - /// <summary> - /// Позволяет преобразовать результат выполения операции к новому типу. - /// </summary> - /// <typeparam name="TNew">Новый тип результата.</typeparam> - /// <param name="mapper">Преобразование результата к новому типу.</param> - /// <param name="error">Обработчик ошибки. Данный обработчик получит - /// исключение возникшее при выполнении операции.</param> - /// <returns>Новое обещание, которое будет выполнено при выполнении исходного обещания.</returns> - public Promise<TNew> Map<TNew>(ResultMapper<T, TNew> mapper, ErrorHandler error) { - if (mapper == null) - throw new ArgumentNullException("mapper"); - - // создаем прицепленное обещание - Promise<TNew> chained = new Promise<TNew>(); + AddHandler(new ResultHandlerInfo { + resultHandler = x => { + try { + handler(); + medium.Resolve(x); + } catch (Exception e) { + medium.Reject(e); + } + }, + errorHandler = x => { + try { + handler(); + } catch { } + medium.Reject(x); + } + }); - AddHandler(new ResultHandlerInfo() { - resultHandler = delegate(T result) { - try { - // если преобразование выдаст исключение, то сработает reject сцепленного deferred - chained.Resolve(mapper(result)); - } catch (Exception e) { - chained.Reject(e); - } - }, - errorHandler = delegate(Exception e) { - if (error != null) - error(e); - // в случае ошибки нужно передать исключение дальше по цепочке - chained.Reject(e); - } - }); + return medium; + } - return chained; - } + /// <summary> + /// Позволяет преобразовать результат выполения операции к новому типу. + /// </summary> + /// <typeparam name="TNew">Новый тип результата.</typeparam> + /// <param name="mapper">Преобразование результата к новому типу.</param> + /// <param name="error">Обработчик ошибки. Данный обработчик получит + /// исключение возникшее при выполнении операции.</param> + /// <returns>Новое обещание, которое будет выполнено при выполнении исходного обещания.</returns> + public Promise<TNew> Map<TNew>(ResultMapper<T, TNew> mapper, ErrorHandler error) { + if (mapper == null) + throw new ArgumentNullException("mapper"); - public Promise<TNew> Map<TNew>(ResultMapper<T, TNew> mapper) { - return Map (mapper, null); - } + // создаем прицепленное обещание + Promise<TNew> chained = new Promise<TNew>(); - /// <summary> - /// Сцепляет несколько аснхронных операций. Указанная асинхронная операция будет вызвана после - /// выполнения текущей, а результат текущей операции может быть использован для инициализации - /// новой операции. - /// </summary> - /// <typeparam name="TNew">Тип результата указанной асинхронной операции.</typeparam> - /// <param name="chained">Асинхронная операция, которая должна будет начаться после выполнения текущей.</param> - /// <param name="error">Обработчик ошибки. Данный обработчик получит - /// исключение возникшее при выполнении текуещй операции.</param> - /// <returns>Новое обещание, которое будет выполнено по окончанию указанной аснхронной операции.</returns> - public Promise<TNew> Chain<TNew>(ChainedOperation<T, TNew> chained, ErrorHandler error) { + AddHandler(new ResultHandlerInfo() { + resultHandler = delegate(T result) { + try { + // если преобразование выдаст исключение, то сработает reject сцепленного deferred + chained.Resolve(mapper(result)); + } catch (Exception e) { + chained.Reject(e); + } + }, + errorHandler = delegate(Exception e) { + if (error != null) + error(e); + // в случае ошибки нужно передать исключение дальше по цепочке + chained.Reject(e); + } + }); - // проблема в том, что на момент связывания еще не начата асинхронная операция, поэтому нужно - // создать посредника, к которому будут подвызяваться следующие обработчики. - // когда будет выполнена реальная асинхронная операция, она обратиться к посреднику, чтобы - // передать через него результаты работы. - Promise<TNew> medium = new Promise<TNew>(); + return chained; + } + + public Promise<TNew> Map<TNew>(ResultMapper<T, TNew> mapper) { + return Map(mapper, null); + } - AddHandler(new ResultHandlerInfo() { - resultHandler = delegate(T result) { - try { - chained(result).Then( - x => medium.Resolve(x), - e => medium.Reject(e) - ); - } catch(Exception e) { - // если сцепленное действие выдало исключение вместо обещания, то передаем ошибку по цепочке - medium.Reject(e); - } - }, - errorHandler = delegate(Exception e) { - if (error != null) - error(e); - // в случае ошибки нужно передать исключение дальше по цепочке - medium.Reject(e); - } - }); + /// <summary> + /// Сцепляет несколько аснхронных операций. Указанная асинхронная операция будет вызвана после + /// выполнения текущей, а результат текущей операции может быть использован для инициализации + /// новой операции. + /// </summary> + /// <typeparam name="TNew">Тип результата указанной асинхронной операции.</typeparam> + /// <param name="chained">Асинхронная операция, которая должна будет начаться после выполнения текущей.</param> + /// <param name="error">Обработчик ошибки. Данный обработчик получит + /// исключение возникшее при выполнении текуещй операции.</param> + /// <returns>Новое обещание, которое будет выполнено по окончанию указанной аснхронной операции.</returns> + public Promise<TNew> Chain<TNew>(ChainedOperation<T, TNew> chained, ErrorHandler error) { + + // проблема в том, что на момент связывания еще не начата асинхронная операция, поэтому нужно + // создать посредника, к которому будут подвызяваться следующие обработчики. + // когда будет выполнена реальная асинхронная операция, она обратиться к посреднику, чтобы + // передать через него результаты работы. + Promise<TNew> medium = new Promise<TNew>(); - return medium; - } - - public Promise<TNew> Chain<TNew>(ChainedOperation<T, TNew> chained) { - return Chain (chained, null); - } + AddHandler(new ResultHandlerInfo() { + resultHandler = delegate(T result) { + try { + chained(result).Then( + x => medium.Resolve(x), + e => medium.Reject(e) + ); + } catch (Exception e) { + // если сцепленное действие выдало исключение вместо обещания, то передаем ошибку по цепочке + medium.Reject(e); + } + }, + errorHandler = delegate(Exception e) { + if (error != null) + error(e); + // в случае ошибки нужно передать исключение дальше по цепочке + medium.Reject(e); + } + }); - /// <summary> - /// Дожидается отложенного обещания и в случае успеха, возвращает - /// его, результат, в противном случае бросает исключение. - /// </summary> - /// <remarks> - /// <para> - /// Если ожидание обещания было прервано по таймауту, это не значит, - /// что обещание было отменено или что-то в этом роде, это только - /// означает, что мы его не дождались, однако все зарегистрированные - /// обработчики, как были так остались и они будут вызваны, когда - /// обещание будет выполнено. - /// </para> - /// <para> - /// Такое поведение вполне оправдано поскольку таймаут может истечь - /// в тот момент, когда началась обработка цепочки обработчиков, и - /// к тому же текущее обещание может стоять в цепочке обещаний и его - /// отклонение может привести к непрогнозируемому результату. - /// </para> - /// </remarks> - /// <param name="timeout">Время ожидания</param> - /// <returns>Результат выполнения обещания</returns> - public T Join(int timeout) { - ManualResetEvent evt = new ManualResetEvent(false); - Anyway(() => evt.Set()); + return medium; + } + + public Promise<TNew> Chain<TNew>(ChainedOperation<T, TNew> chained) { + return Chain(chained, null); + } - if (!evt.WaitOne(timeout, true)) - throw new TimeoutException(); + /// <summary> + /// Дожидается отложенного обещания и в случае успеха, возвращает + /// его, результат, в противном случае бросает исключение. + /// </summary> + /// <remarks> + /// <para> + /// Если ожидание обещания было прервано по таймауту, это не значит, + /// что обещание было отменено или что-то в этом роде, это только + /// означает, что мы его не дождались, однако все зарегистрированные + /// обработчики, как были так остались и они будут вызваны, когда + /// обещание будет выполнено. + /// </para> + /// <para> + /// Такое поведение вполне оправдано поскольку таймаут может истечь + /// в тот момент, когда началась обработка цепочки обработчиков, и + /// к тому же текущее обещание может стоять в цепочке обещаний и его + /// отклонение может привести к непрогнозируемому результату. + /// </para> + /// </remarks> + /// <param name="timeout">Время ожидания</param> + /// <returns>Результат выполнения обещания</returns> + public T Join(int timeout) { + ManualResetEvent evt = new ManualResetEvent(false); + Anyway(() => evt.Set()); - if (m_error != null) - throw new TargetInvocationException( m_error ); - else - return m_result; - } + if (!evt.WaitOne(timeout, true)) + throw new TimeoutException(); - public T Join() { - return Join(Timeout.Infinite); - } + if (m_error != null) + throw new TargetInvocationException(m_error); + else + return m_result; + } + + public T Join() { + return Join(Timeout.Infinite); + } - /// <summary> - /// Данный метод последовательно извлекает обработчики обещания и когда - /// их больше не осталось - ставит состояние "разрешено". - /// </summary> - /// <param name="handler">Информация об обработчике</param> - /// <returns>Признак того, что еще остались обработчики в очереди</returns> - bool FetchNextHandler(out ResultHandlerInfo handler) { - handler = default(ResultHandlerInfo); + /// <summary> + /// Данный метод последовательно извлекает обработчики обещания и когда + /// их больше не осталось - ставит состояние "разрешено". + /// </summary> + /// <param name="handler">Информация об обработчике</param> + /// <returns>Признак того, что еще остались обработчики в очереди</returns> + bool FetchNextHandler(out ResultHandlerInfo handler) { + handler = default(ResultHandlerInfo); - lock (this) { - Debug.Assert(m_state == State.Resolving); + lock (this) { + Debug.Assert(m_state == State.Resolving); - if (m_handlersChain.Count > 0) { - handler = m_handlersChain.First.Value; - m_handlersChain.RemoveFirst(); - return true; - } else { - m_state = State.Resolved; - return false; - } - } - } + if (m_handlersChain.Count > 0) { + handler = m_handlersChain.First.Value; + m_handlersChain.RemoveFirst(); + return true; + } else { + m_state = State.Resolved; + return false; + } + } + } - void AddHandler(ResultHandlerInfo handler) { - bool invokeRequired = false; + void AddHandler(ResultHandlerInfo handler) { + bool invokeRequired = false; - lock (this) { - if (m_state != State.Resolved) - m_handlersChain.AddLast(handler); - else - invokeRequired = true; - } + lock (this) { + if (m_state != State.Resolved) + m_handlersChain.AddLast(handler); + else + invokeRequired = true; + } - // обработчики не должны блокировать сам объект - if (invokeRequired) - InvokeHandler(handler); - } + // обработчики не должны блокировать сам объект + if (invokeRequired) + InvokeHandler(handler); + } - void InvokeHandler(ResultHandlerInfo handler) { - if (m_error == null) { - try { - if (handler.resultHandler != null) - handler.resultHandler(m_result); - } catch { } - } + void InvokeHandler(ResultHandlerInfo handler) { + if (m_error == null) { + try { + if (handler.resultHandler != null) + handler.resultHandler(m_result); + } catch { } + } - if (m_error != null) { - try { - if (handler.errorHandler !=null) - handler.errorHandler(m_error); - } catch { } - } - } + if (m_error != null) { + try { + if (handler.errorHandler != null) + handler.errorHandler(m_error); + } catch { } + } + } - } + } }