Resolver - Revision history

Kevin Reid: rename Ref (object) for capitalization unambiguity

2009-01-14T00:26:54Z

rename Ref (object) for capitalization unambiguity

New page

A '''resolver''' is an object providing the ability to ''resolve'' a [[promise]].

A resolver does not allow retrieving the reference to which a promise has been resolved; in E (but not in [[ref_send]]), a resolver allows observing whether resolution has occurred.

== Protocol ==

{{instance msgdoc|resolve|1|<var>resolution</var>|void}}

Resolves the promise to <var>resolution</var>, or [[throws]] if it is already resolved.

{{instance msgdoc|resolveRace|1|_|[[Boolean]]}}

Resolves the promise to <var>resolution</var> and returns [[true]], or returns [[false]] if it is already resolved.

{{instance msgdoc|smash|1|<var>problem</var>|[[Boolean]]}}

Equivalent to resolveRace([[Object Ref#broken/1|Ref.broken]](<var>problem</var>)).

{{instance msgdoc|resolve|2|<var>resolution</var>, <var>strict</var> :[[Boolean]]|[[Boolean]]}}

(Deprecated as of 2007-05-30: [[User:Markm]], [[User:Kevin Reid]], and Dean Tribble agree this interface is inferior to resolve/1 and resolveRace/1.)

Resolves the promise to <var>resolution</var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.

{{instance msgdoc|isDone|0||[[Boolean]]}}

Returns whether the promise is already resolved.

{{instance msgdoc|gettingCloser|0||[[void]]}}

Has no visible effect; used by [[Causeway|causality tracing]]. Claims that something happened such that this resolver is closer to getting resolved.

[[Category:ELib specification]]
[[Category:Protocols]]

Kevin Reid: document gettingCloser

2008-08-01T23:21:48Z

document gettingCloser

←Older revision		Revision as of 23:21, 1 August 2008
Line 29:		Line 29:
	{{instance msgdoc\|gettingCloser\|0\|\|[[void]]}}		{{instance msgdoc\|gettingCloser\|0\|\|[[void]]}}

-	~~{{unspecified message}}~~	+	Has no visible effect; used by [[Causeway\|causality tracing]]. Claims that something happened such that this resolver is closer to getting resolved.

	[[Category:ELib specification]]		[[Category:ELib specification]]
	[[Category:Protocols]]		[[Category:Protocols]]

Kevin Reid: use new message doc template

2008-07-02T02:19:24Z

use new message doc template

←Older revision		Revision as of 02:19, 2 July 2008
Line 5:		Line 5:
	== Protocol ==		== Protocol ==

-	~~===~~ resolve/1 ~~===~~	+	{{instance msgdoc\|resolve\|1\|<var>resolution</var>\|void}}
-	~~resolve(~~<var>resolution</var>~~) :~~void	+

	Resolves the promise to <var>resolution</var>, or [[throws]] if it is already resolved.		Resolves the promise to <var>resolution</var>, or [[throws]] if it is already resolved.

-	~~===~~ resolveRace/1 ~~===~~	+	{{instance msgdoc\|resolveRace\|1\|_\|[[Boolean]]}}
-	~~resolveRace(~~_~~) :~~[[Boolean]]	+

	Resolves the promise to <var>resolution</var> and returns [[true]], or returns [[false]] if it is already resolved.		Resolves the promise to <var>resolution</var> and returns [[true]], or returns [[false]] if it is already resolved.

-	~~===~~ smash/1 ~~===~~	+	{{instance msgdoc\|smash\|1\|<var>problem</var>\|[[Boolean]]}}
-	~~smash(~~<var>problem</var>~~) :~~[[Boolean]]	+

	Equivalent to resolveRace([[Ref (object)#broken/1\|Ref.broken]](<var>problem</var>)).		Equivalent to resolveRace([[Ref (object)#broken/1\|Ref.broken]](<var>problem</var>)).

-	~~===~~ resolve/2 ~~===~~	+	{{instance msgdoc\|resolve\|2\|<var>resolution</var>, <var>strict</var> :[[Boolean]]\|[[Boolean]]}}
-	~~resolve(~~<var>resolution</var>, <var>strict</var> :[[Boolean]]~~) :~~[[Boolean]]	+

	(Deprecated as of 2007-05-30: [[User:Markm]], [[User:Kevin Reid]], and Dean Tribble agree this interface is inferior to resolve/1 and resolveRace/1.)		(Deprecated as of 2007-05-30: [[User:Markm]], [[User:Kevin Reid]], and Dean Tribble agree this interface is inferior to resolve/1 and resolveRace/1.)
Line 27:		Line 23:
	Resolves the promise to <var>resolution</var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.		Resolves the promise to <var>resolution</var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.

-	~~===~~ isDone/0 ~~===~~	+	{{instance msgdoc\|isDone\|0\|\|[[Boolean]]}}
-	~~isDone() :~~Boolean	+

	Returns whether the promise is already resolved.		Returns whether the promise is already resolved.

-	~~===~~ gettingCloser/0 ~~===~~	+	{{instance msgdoc\|gettingCloser\|0\|\|[[void]]}}
-	~~gettingCloser() :~~void	+

	{{unspecified message}}		{{unspecified message}}

Kevin Reid: add elib category

2008-06-20T18:42:52Z

add elib category

←Older revision		Revision as of 18:42, 20 June 2008
Line 37:		Line 37:
	{{unspecified message}}		{{unspecified message}}

		+	[[Category:ELib specification]]
	[[Category:Protocols]]		[[Category:Protocols]]

Kevin Reid: add protocols category

2008-03-23T20:46:01Z

add protocols category

←Older revision		Revision as of 20:46, 23 March 2008
Line 36:		Line 36:

	{{unspecified message}}		{{unspecified message}}
		+
		+	[[Category:Protocols]]

Markm: /* resolve/2 */

2007-06-01T06:33:58Z

resolve/2

←Older revision		Revision as of 06:33, 1 June 2007
Line 23:		Line 23:
	resolve(<var>resolution</var>, <var>strict</var> :[[Boolean]]) :[[Boolean]]		resolve(<var>resolution</var>, <var>strict</var> :[[Boolean]]) :[[Boolean]]

-	(Deprecated as of 2007-05-30: [[User:Markm]], [[User:Kevin Reid]], and Dean Tribble agree this interface is inferior to resolve/1 and resolveRace/2.)	+	(Deprecated as of 2007-05-30: [[User:Markm]], [[User:Kevin Reid]], and Dean Tribble agree this interface is inferior to resolve/1 and resolveRace/1.)

	Resolves the promise to <var>resolution</var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.		Resolves the promise to <var>resolution</var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.

Kevin Reid: deprecate resolve/2

2007-05-31T18:34:23Z

deprecate resolve/2

←Older revision		Revision as of 18:34, 31 May 2007
Line 9:		Line 9:

	Resolves the promise to <var>resolution</var>, or [[throws]] if it is already resolved.		Resolves the promise to <var>resolution</var>, or [[throws]] if it is already resolved.
-
-	~~=== resolve/2 ===~~
-	~~resolve(<var>resolution</var>, <var>strict</var> :[[Boolean]]) :[[Boolean]]~~
-
-	~~Resolves the promise to <var>resolution</var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.~~

	=== resolveRace/1 ===		=== resolveRace/1 ===
Line 24:		Line 19:

	Equivalent to resolveRace([[Ref (object)#broken/1\|Ref.broken]](<var>problem</var>)).		Equivalent to resolveRace([[Ref (object)#broken/1\|Ref.broken]](<var>problem</var>)).
		+
		+	=== resolve/2 ===
		+	resolve(<var>resolution</var>, <var>strict</var> :[[Boolean]]) :[[Boolean]]
		+
		+	(Deprecated as of 2007-05-30: [[User:Markm]], [[User:Kevin Reid]], and Dean Tribble agree this interface is inferior to resolve/1 and resolveRace/2.)
		+
		+	Resolves the promise to <var>resolution</var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.

	=== isDone/0 ===		=== isDone/0 ===

Kevin Reid: "undocumented method" -> "unspecified message"

2007-04-21T15:20:39Z

"undocumented method" -> "unspecified message"

←Older revision		Revision as of 15:20, 21 April 2007
Line 33:		Line 33:
	gettingCloser() :void		gettingCloser() :void

-	{{~~undocumented method~~}}	+	{{unspecified message}}

Kevin Reid at 15:10, 21 April 2007

2007-04-21T15:10:58Z

←Older revision		Revision as of 15:10, 21 April 2007
Line 5:		Line 5:
	== Protocol ==		== Protocol ==

-	~~{{instance msgdoc\|~~resolve\|1\|<var>resolution</var>\|void}}	+	=== resolve/1 ===
		+	resolve(<var>resolution</var>) :void

	Resolves the promise to <var>resolution</var>, or [[throws]] if it is already resolved.		Resolves the promise to <var>resolution</var>, or [[throws]] if it is already resolved.

-	~~{{instance msgdoc\|resolveRace\|1\|_\|~~[[Boolean]]}}	+	=== resolve/2 ===
		+	resolve(<var>resolution</var>, <var>strict</var> :[[Boolean]]) :[[Boolean]]

-	Resolves the promise to <var>resolution</var> and returns [[true]], or returns [[false]] if it is ~~already resolved~~.	+	Resolves the promise to <var>resolution</var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.

-	~~{{instance msgdoc\|smash\|1\|<var>problem<~~/~~var>\|~~[[Boolean]]}}	+	=== resolveRace/1 ===
		+	resolveRace(_) :[[Boolean]]

-	~~Equivalent~~ to ~~resolveRace([[Object Ref#broken/1\|Ref.broken]](~~<var>~~problem~~</var>)).	+	Resolves the promise to <var>resolution</var> and returns [[true]], or returns [[false]] if it is already resolved.

-	~~{{instance msgdoc\|resolve\|2\|<var>resolution<~~/~~var>,~~ <var>~~strict~~</var> :[[Boolean]]~~\|[[Boolean]]}}~~	+	=== smash/1 ===
		+	smash(<var>problem</var>) :[[Boolean]]

-	(~~Deprecated as of 2007-05-30:~~ [[~~User:Markm]], [[User:Kevin Reid]], and Dean Tribble agree this interface is inferior to resolve/1 and resolveRace~~/1.)	+	Equivalent to resolveRace([[Ref (object)#broken/1\|Ref.broken]](<var>problem</var>)).

-	~~Resolves the promise to <var>resolution<~~/~~var> and returns [[true]], or if it is already resolved, returns [[false]] if <var>strict</var> is false or [[throws]] if it is true.~~	+	=== isDone/0 ===
-		+	isDone() :Boolean
-	~~{{instance msgdoc\|~~isDone~~\|0\|\|[[~~Boolean~~]]}}~~	+

	Returns whether the promise is already resolved.		Returns whether the promise is already resolved.

-	~~{{instance msgdoc\|~~gettingCloser\|0~~\|\|[[void]]}}~~	+	=== gettingCloser/0 ===
-		+	gettingCloser() :void
-	~~Has no visible effect; used by [[Causeway\|causality tracing]]. Claims that something happened such that this resolver is closer to getting resolved.~~	+

-	~~[[Category:ELib specification]]~~	+	{{undocumented method}}
-	~~[[Category:Protocols]]~~	+