9654f72016-04-12Henrik Grubbström (Grubba) //! Module for handling multiple concurrent events.
31dd442016-06-15Henrik Grubbström (Grubba) //! //! The @[Future] and @[Promise] API was inspired by //! @url{https://github.com/couchdeveloper/FutureLib@}.
c60ad22016-04-13Henrik Grubbström (Grubba) 
9654f72016-04-12Henrik Grubbström (Grubba) protected enum State { STATE_PENDING = 0, STATE_FULFILLED, STATE_REJECTED, }; protected Thread.Mutex mux = Thread.Mutex(); protected Thread.Condition cond = Thread.Condition(); //! Value that will be provided asynchronously //! sometime in the future. //! //! @seealso //! @[Promise] class Future { mixed result = UNDEFINED; State state;
bf700d2016-10-26Henrik Grubbström (Grubba)  protected array(array(function(mixed, mixed ...: void)|array(mixed))) success_cbs = ({}); protected array(array(function(mixed, mixed ...: void)|array(mixed))) failure_cbs = ({});
9654f72016-04-12Henrik Grubbström (Grubba)  //! Wait for fullfillment and return the value. //! //! @throws //! Throws on rejection. mixed get() { State s = state; mixed res = result; if (!s) { object key = mux->lock(); while (!state) { cond->wait(key); } s = state; res = result; key = 0; } if (s == STATE_REJECTED) { throw(res); } return res; } //! Register a callback that is to be called on fulfillment.
bf700d2016-10-26Henrik Grubbström (Grubba)  //! //! @param cb //! Function to be called. The first argument will be the //! result of the @[Future]. //! //! @param extra //! Any extra context needed for @[cb]. They will be provided //! as arguments two and onwards when @[cb] is called. //! //! @note //! @[cb] will always be called from the main backend. //! //! @seealso //! @[on_failure()]
47c3112016-05-10Pontus Östlund  this_program on_success(function(mixed, mixed ... : void) cb, mixed ... extra)
9654f72016-04-12Henrik Grubbström (Grubba)  { object key = mux->lock();
bf700d2016-10-26Henrik Grubbström (Grubba)  if (state == STATE_FULFILLED) { call_out(cb, 0, result, @extra); key = 0; return this;
9654f72016-04-12Henrik Grubbström (Grubba)  }
47c3112016-05-10Pontus Östlund 
bf700d2016-10-26Henrik Grubbström (Grubba)  success_cbs += ({ ({ cb, extra }) }); key = 0;
47c3112016-05-10Pontus Östlund  return this;
9654f72016-04-12Henrik Grubbström (Grubba)  } //! Register a callback that is to be called on failure.
bf700d2016-10-26Henrik Grubbström (Grubba)  //! //! @param cb //! Function to be called. The first argument will be the //! failure result of the @[Future]. //! //! @param extra //! Any extra context needed for @[cb]. They will be provided //! as arguments two and onwards when @[cb] is called. //! //! @note //! @[cb] will always be called from the main backend. //! //! @seealso //! @[on_success()]
47c3112016-05-10Pontus Östlund  this_program on_failure(function(mixed, mixed ... : void) cb, mixed ... extra)
9654f72016-04-12Henrik Grubbström (Grubba)  { object key = mux->lock();
bf700d2016-10-26Henrik Grubbström (Grubba)  if (state == STATE_REJECTED) { call_out(cb, 0, result, @extra); key = 0; return this;
9654f72016-04-12Henrik Grubbström (Grubba)  }
bf700d2016-10-26Henrik Grubbström (Grubba)  failure_cbs += ({ ({ cb, extra }) }); key = 0;
47c3112016-05-10Pontus Östlund  return this;
9654f72016-04-12Henrik Grubbström (Grubba)  }
c60ad22016-04-13Henrik Grubbström (Grubba)  //! Apply @[fun] with @[val] followed by the contents of @[ctx], //! and update @[p] with the result. protected void apply(mixed val, Promise p, function(mixed, mixed ... : mixed) fun, array(mixed) ctx) { mixed err = catch { p->success(fun(val, @ctx)); return; }; p->failure(err); } //! Apply @[fun] with @[val] followed by the contents of @[ctx], //! and update @[p] with the eventual result. protected void apply_flat(mixed val, Promise p, function(mixed, mixed ... : Future) fun, array(mixed) ctx) { mixed err = catch { Future f = fun(val, @ctx); if (!objectp(f) || !f->on_failure || !f->on_success) { error("Expected %O to return a Future. Got: %O.\n", fun, f); } f->on_failure(p->failure); f->on_success(p->success); return; }; p->failure(err); } //! Apply @[fun] with @[val] followed by the contents of @[ctx], //! and update @[p] with @[val] if @[fun] didn't return false. //! If @[fun] returned false fail @[p] with @[UNDEFINED]. protected void apply_filter(mixed val, Promise p, function(mixed, mixed ... : int(0..1)) fun, array(mixed) ctx) { mixed err = catch { if (fun(val, @ctx)) { p->success(val); } else { p->failure(UNDEFINED); } return; }; p->failure(err); } //! Return a @[Future] that will be fulfilled with the result //! of applying @[fun] with the fulfilled result of this @[Future] //! followed by @[extra]. this_program map(function(mixed, mixed ... : mixed) fun, mixed ... extra) { Promise p = Promise(); on_failure(p->failure); on_success(apply, p, fun, extra); return p->future(); } //! Return a @[Future] that will be fulfilled with the fulfilled result //! of applying @[fun] with the fulfilled result of this @[Future] //! followed by @[extra]. this_program flat_map(function(mixed, mixed ... : this_program) fun, mixed ... extra) { Promise p = Promise(); on_failure(p->failure); on_success(apply_flat, p, fun, extra); return p->future(); } //! Return a @[Future] that will be fulfilled with either
cc178f2016-05-18Henrik Grubbström (Grubba)  //! the fulfilled result of this @[Future], or the result
c60ad22016-04-13Henrik Grubbström (Grubba)  //! of applying @[fun] with the failed result followed //! by @[extra]. this_program recover(function(mixed, mixed ... : mixed) fun, mixed ... extra) { Promise p = Promise(); on_success(p->success); on_failure(apply, p, fun, extra); return p->future(); } //! Return a @[Future] that will be fulfilled with either
cc178f2016-05-18Henrik Grubbström (Grubba)  //! the fulfilled result of this @[Future], or the fulfilled result
c60ad22016-04-13Henrik Grubbström (Grubba)  //! of applying @[fun] with the failed result followed //! by @[extra]. this_program recover_with(function(mixed, mixed ... : this_program) fun, mixed ... extra) { Promise p = Promise(); on_success(p->success); on_failure(apply_flat, p, fun, extra); return p->future(); } //! Return a @[Future] that either will by fulfilled by the //! fulfilled result of this @[Future] if applying @[fun] //! with the result followed by @[extra] returns true, //! or will fail with @[UNDEFINED] if it returns false. this_program filter(function(mixed, mixed ... : int(0..1)) fun, mixed ... extra) { Promise p = Promise(); on_failure(p->failure); on_success(apply_filter, p, fun, extra); return p->future(); } //! Return a @[Future] that will be fulfilled with either //! the result of applying @[success] with the fulfilled result //! followed by @[extra], or the result of applying @[failure] //! with the failed result followed by @[extra]. //! //! @[failure] defaults to @[success]. //! //! @seealso //! @[map] this_program transform(function(mixed, mixed ... : mixed) success, function(mixed, mixed ... : mixed)|void failure, mixed ... extra) { Promise p = Promise(); on_success(apply, p, success, extra); on_failure(apply, p, failure || success, extra); return p->future(); } //! Return a @[Future] that will be fulfilled with either //! the fulfilled result of applying @[success] with the fulfilled result //! followed by @[extra], or the fulfilled result of applying @[failure] //! with the failed result followed by @[extra]. //! //! @[failure] defaults to @[success]. //! //! @seealso //! @[flat_map] this_program transform_with(function(mixed, mixed ... : Future) success, function(mixed, mixed ... : Future)|void failure, mixed ... extra) { Promise p = Promise(); on_success(apply_flat, p, success, extra); on_failure(apply_flat, p, failure || success, extra); return p->future(); }
aa51262016-04-18Henrik Grubbström (Grubba)  //! Return a @[Future] that will be fulfilled with an //! array of the fulfilled result of this object followed //! by the fulfilled results of @[others]. //! //! @seealso //! @[results()] this_program zip(this_program ... others) {
765e832016-04-23Henrik Grubbström (Grubba)  if (!sizeof(others)) return this_program::this; return results(({ this_program::this }) + others);
aa51262016-04-18Henrik Grubbström (Grubba)  }
3bce162016-06-02Henrik Grubbström (Grubba) 
bf700d2016-10-26Henrik Grubbström (Grubba)  //! Return a @[Future] that will either be fulfilled with the fulfilled //! result of this @[Future], or be failed after @[seconds] have expired.
3bce162016-06-02Henrik Grubbström (Grubba)  this_program timeout(int|float seconds) { Promise p = Promise(); on_failure(p->failure); on_success(p->success);
82356b2016-10-26Henrik Grubbström (Grubba)  call_out(p->try_failure, seconds, ({ "Timeout.\n", backtrace() }));
3bce162016-06-02Henrik Grubbström (Grubba)  return p->future(); }
9654f72016-04-12Henrik Grubbström (Grubba) } //! Promise to provide a @[Future] value. //!
c60ad22016-04-13Henrik Grubbström (Grubba) //! Objects of this class are typically kept internal to the //! code that provides the @[Future] value. The only thing //! that is directly returned to the user is the return //! value from @[future()]. //!
9654f72016-04-12Henrik Grubbström (Grubba) //! @seealso
c60ad22016-04-13Henrik Grubbström (Grubba) //! @[Future], @[future()]
9654f72016-04-12Henrik Grubbström (Grubba) class Promise { inherit Future; //! The future value that we promise. Future future() { return Future::this; }
dd2f1a2016-05-31Henrik Grubbström (Grubba)  protected void unlocked_success(mixed value)
9654f72016-04-12Henrik Grubbström (Grubba)  { if (state < STATE_REJECTED) { result = value; state = STATE_FULFILLED; cond->broadcast();
bf700d2016-10-26Henrik Grubbström (Grubba)  foreach(success_cbs, [function(mixed, mixed ...: void) cb, array(mixed) extra]) { if (cb) { call_out(cb, 0, value, @extra); }
9654f72016-04-12Henrik Grubbström (Grubba)  } } }
bf700d2016-10-26Henrik Grubbström (Grubba)  //! Fulfill the @[Future]. //! //! @param value //! Result of the @[Future]. //!
82356b2016-10-26Henrik Grubbström (Grubba)  //! @throws //! Throws an error if the @[Future] already has been fulfilled //! or failed. //! //! Mark the @[Future] as fulfilled, and schedule the @[on_success()] //! callbacks to be called as soon as possible.
bf700d2016-10-26Henrik Grubbström (Grubba)  //! //! @seealso
82356b2016-10-26Henrik Grubbström (Grubba)  //! @[try_success()], @[try_failure()], @[failure()], @[on_success()]
dd2f1a2016-05-31Henrik Grubbström (Grubba)  void success(mixed value)
9654f72016-04-12Henrik Grubbström (Grubba)  {
82356b2016-10-26Henrik Grubbström (Grubba)  if (state) error("Promise has already been finalized.\n"); object key = mux->lock(); if (state) error("Promise has already been finalized.\n"); unlocked_success(value); key = 0; } //! Fulfill the @[Future] if it hasn't been fulfilled or failed already. //! //! @param value //! Result of the @[Future]. //! //! Mark the @[Future] as fulfilled if it hasn't already been fulfilled //! or failed, and in that case schedule the @[on_success()] callbacks //! to be called as soon as possible. //! //! @seealso //! @[success()], @[try_failure()], @[failure()], @[on_success()] void try_success(mixed value) { if (state) return;
9654f72016-04-12Henrik Grubbström (Grubba)  object key = mux->lock();
82356b2016-10-26Henrik Grubbström (Grubba)  if (state) return;
dd2f1a2016-05-31Henrik Grubbström (Grubba)  unlocked_success(value); key = 0; } protected void unlocked_failure(mixed value) {
9654f72016-04-12Henrik Grubbström (Grubba)  state = STATE_REJECTED; result = value; cond->broadcast();
bf700d2016-10-26Henrik Grubbström (Grubba)  foreach(failure_cbs, [function(mixed, mixed ...: void) cb, array(mixed) extra]) { if (cb) { call_out(cb, 0, value, @extra); }
9654f72016-04-12Henrik Grubbström (Grubba)  } }
dd2f1a2016-05-31Henrik Grubbström (Grubba)  //! Reject the @[Future] value.
bf700d2016-10-26Henrik Grubbström (Grubba)  //! //! @param value //! Failure result of the @[Future]. //!
82356b2016-10-26Henrik Grubbström (Grubba)  //! @throws //! Throws an error if the @[Future] already has been fulfilled //! or failed. //!
bf700d2016-10-26Henrik Grubbström (Grubba)  //! Mark the @[Future] as failed, and schedule the @[on_failure()] //! callbacks to be called as soon as possible. //! //! @seealso
82356b2016-10-26Henrik Grubbström (Grubba)  //! @[try_failure()], @[success()], @[on_failure()]
dd2f1a2016-05-31Henrik Grubbström (Grubba)  void failure(mixed value) {
82356b2016-10-26Henrik Grubbström (Grubba)  if (state) error("Promise has already been finalized.\n");
dd2f1a2016-05-31Henrik Grubbström (Grubba)  object key = mux->lock();
82356b2016-10-26Henrik Grubbström (Grubba)  if (state) error("Promise has already been finalized.\n");
dd2f1a2016-05-31Henrik Grubbström (Grubba)  unlocked_failure(value); key = 0; }
bf700d2016-10-26Henrik Grubbström (Grubba)  //! Maybe reject the @[Future] value. //! //! @param value //! Failure result of the @[Future]. //! //! Mark the @[Future] as failed if it hasn't already been fulfilled,
82356b2016-10-26Henrik Grubbström (Grubba)  //! and in that case schedule the @[on_failure()] callbacks to be //! called as soon as possible.
bf700d2016-10-26Henrik Grubbström (Grubba)  //! //! @seealso //! @[failure()], @[success()], @[on_failure()]
82356b2016-10-26Henrik Grubbström (Grubba)  void try_failure(mixed value)
126bb32016-06-01Henrik Grubbström (Grubba)  {
82356b2016-10-26Henrik Grubbström (Grubba)  if (state) return;
126bb32016-06-01Henrik Grubbström (Grubba)  object key = mux->lock();
5e6a6b2016-10-26Henrik Grubbström (Grubba)  if (state) return;
126bb32016-06-01Henrik Grubbström (Grubba)  unlocked_failure(value); }
9654f72016-04-12Henrik Grubbström (Grubba)  protected void destroy() { if (!state) {
31dd442016-06-15Henrik Grubbström (Grubba)  unlocked_failure(({ "Promise broken.\n", backtrace() }));
9654f72016-04-12Henrik Grubbström (Grubba)  } } }
aa51262016-04-18Henrik Grubbström (Grubba)  protected class FirstCompleted { inherit Promise; protected void create(array(Future) futures) { if (!sizeof(futures)) { state = STATE_FULFILLED; return; }
82356b2016-10-26Henrik Grubbström (Grubba)  futures->on_failure(try_failure); futures->on_success(try_success);
aa51262016-04-18Henrik Grubbström (Grubba)  } } //! Return a @[Future] that represents the first //! of the @[futures] that completes. Future first_completed(array(Future) futures) { Promise p = FirstCompleted(futures); return p->future(); } protected class Results { inherit Promise; protected void create(array(Future) futures) { if (!sizeof(futures)) { success(({})); return; }
f108682016-05-05Pontus Östlund  array(mixed) results = allocate(sizeof(futures), UNDEFINED); array(State) states = allocate(sizeof(futures), STATE_PENDING);
aa51262016-04-18Henrik Grubbström (Grubba)  futures->on_failure(failure);
f108682016-05-05Pontus Östlund 
aa51262016-04-18Henrik Grubbström (Grubba)  foreach(futures; int i; Future f) {
f108682016-05-05Pontus Östlund  f->on_success(got_success, i, results, states);
aa51262016-04-18Henrik Grubbström (Grubba)  } } protected void got_success(mixed value, int i, array(mixed) results, array(State) states) {
8e14552016-10-26Henrik Grubbström (Grubba)  if (state || states[i]) return; object key = mux->lock(); if (state || states[i]) return;
aa51262016-04-18Henrik Grubbström (Grubba)  results[i] = value; states[i] = STATE_FULFILLED;
8e14552016-10-26Henrik Grubbström (Grubba)  if (has_value(states, STATE_PENDING)) { return;
aa51262016-04-18Henrik Grubbström (Grubba)  }
8e14552016-10-26Henrik Grubbström (Grubba)  key = 0;
aa51262016-04-18Henrik Grubbström (Grubba)  success(results); } } //! Return a @[Future] that represents the array of all //! the completed @[futures]. Future results(array(Future) futures) { Promise p = Results(futures); return p->future(); } //! Return a @[Future] that represents the array of mapping @[fun] //! over the results of the competed @[futures]. Future traverse(array(Future) futures, function(mixed, mixed ... : mixed) fun, mixed ... extra) { return results(futures->map(fun, @extra)); } protected class Fold { inherit Promise; protected mixed accumulated; protected void create(array(Future) futures, mixed initial, function(mixed, mixed, mixed ... : mixed) fun, array(mixed) ctx) { if (!sizeof(futures)) { success(initial); return; } accumulated = initial; futures->on_failure(failure); foreach(futures; int i; Future f) { f->on_success(got_success, i, fun, ctx, allocate(sizeof(futures), STATE_PENDING)); } } protected void got_success(mixed val, int i, function(mixed, mixed, mixed ... : mixed) fun, array(mixed) ctx, array(State) states) { if (state || states[i]) return;
8e14552016-10-26Henrik Grubbström (Grubba)  object key = mux->lock(); if (state || states[i]) return;
aa51262016-04-18Henrik Grubbström (Grubba)  states[i] = STATE_FULFILLED; mixed err = catch { // FIXME: What if fun triggers a recursive call? accumulated = fun(val, accumulated, @ctx);
8e14552016-10-26Henrik Grubbström (Grubba)  if (has_value(states, STATE_PENDING)) return;
aa51262016-04-18Henrik Grubbström (Grubba)  success(accumulated); return; }; failure(err); } } //! Return a @[Future] that represents the accumulated results of //! applying @[fun] to the results of the @[futures] in turn. //! //! @param initial //! Initial value of the accumulator. //! //! @param fun //! Function to apply. The first argument is the result of //! one of the @[futures], the second the current accumulated //! value, and any further from @[extra]. //! //! @note
8e14552016-10-26Henrik Grubbström (Grubba) //! If @[fun] throws an error it will fail the @[Future]. //! //! @note //! @[fun] may be called in any order, and will be called //! once for every @[Future] in @[futures], unless one of //! calls fails in which case no further calls will be //! performed.
aa51262016-04-18Henrik Grubbström (Grubba) Future fold(array(Future) futures, mixed initial, function(mixed, mixed, mixed ... : mixed) fun, mixed ... extra) { Promise p = Fold(futures, initial, fun, extra); return p->future(); }