12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403 |
- // Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.
- using System.Reactive.Concurrency;
- using System.Threading;
- namespace System.Reactive.Linq
- {
- public static partial class Observable
- {
- #region + FromEventPattern +
- #region Strongly typed
- #region Action<EventHandler>
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on <see cref="EventHandler"/>, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- #if !NO_EVENTARGS_CONSTRAINT
- public static IObservable<EventPattern<EventArgs>> FromEventPattern(Action<EventHandler> addHandler, Action<EventHandler> removeHandler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEventPattern(addHandler, removeHandler);
- }
- #else
- public static IObservable<EventPattern<object>> FromEventPattern(Action<EventHandler> addHandler, Action<EventHandler> removeHandler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEventPattern(addHandler, removeHandler);
- }
- #endif
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on <see cref="EventHandler"/>, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> or <paramref name="scheduler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- #if !NO_EVENTARGS_CONSTRAINT
- public static IObservable<EventPattern<EventArgs>> FromEventPattern(Action<EventHandler> addHandler, Action<EventHandler> removeHandler, IScheduler scheduler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern(addHandler, removeHandler, scheduler);
- }
- #else
- public static IObservable<EventPattern<object>> FromEventPattern(Action<EventHandler> addHandler, Action<EventHandler> removeHandler, IScheduler scheduler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern(addHandler, removeHandler, scheduler);
- }
- #endif
- #endregion
- #region Action<TDelegate>
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TDelegate, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEventPattern<TDelegate, TEventArgs>(addHandler, removeHandler);
- }
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> or <paramref name="scheduler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TDelegate, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler, IScheduler scheduler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern<TDelegate, TEventArgs>(addHandler, removeHandler, scheduler);
- }
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on <see cref="EventHandler<TEventArgs>"/>, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="conversion">A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters.</param>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="conversion"/> or <paramref name="addHandler"/> or <paramref name="removeHandler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TDelegate, TEventArgs>(Func<EventHandler<TEventArgs>, TDelegate> conversion, Action<TDelegate> addHandler, Action<TDelegate> removeHandler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (conversion == null)
- throw new ArgumentNullException("conversion");
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEventPattern<TDelegate, TEventArgs>(conversion, addHandler, removeHandler);
- }
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on <see cref="EventHandler<TEventArgs>"/>, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="conversion">A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters.</param>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="conversion"/> or <paramref name="addHandler"/> or <paramref name="removeHandler"/> or <paramref name="scheduler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TDelegate, TEventArgs>(Func<EventHandler<TEventArgs>, TDelegate> conversion, Action<TDelegate> addHandler, Action<TDelegate> removeHandler, IScheduler scheduler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (conversion == null)
- throw new ArgumentNullException("conversion");
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern<TDelegate, TEventArgs>(conversion, addHandler, removeHandler, scheduler);
- }
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type with a strongly typed sender parameter, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TSender">The type of the sender that raises the event.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TDelegate, TSender, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEventPattern<TDelegate, TSender, TEventArgs>(addHandler, removeHandler);
- }
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on a supplied event delegate type with a strongly typed sender parameter, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TSender">The type of the sender that raises the event.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> or <paramref name="scheduler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TDelegate, TSender, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler, IScheduler scheduler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern<TDelegate, TSender, TEventArgs>(addHandler, removeHandler, scheduler);
- }
- #endregion
- #region Action<EventHandler<TEventArgs>>
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on <see cref="EventHandler<TEventArgs>"/>, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(Action<EventHandler<TEventArgs>> addHandler, Action<EventHandler<TEventArgs>> removeHandler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEventPattern<TEventArgs>(addHandler, removeHandler);
- }
- /// <summary>
- /// Converts a .NET event, conforming to the standard .NET event pattern based on <see cref="EventHandler<TEventArgs>"/>, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(Action<EventHandler<TEventArgs>> addHandler, Action<EventHandler<TEventArgs>> removeHandler, IScheduler scheduler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern<TEventArgs>(addHandler, removeHandler, scheduler);
- }
- #endregion
- #endregion
- #region Reflection
- #region Instance events
- /// <summary>
- /// Converts an instance .NET event, conforming to the standard .NET event pattern with an <see cref="EventArgs"/> parameter, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the target object type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <param name="target">Object instance that exposes the event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="target"/> or <paramref name="eventName"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- #if !NO_EVENTARGS_CONSTRAINT
- public static IObservable<EventPattern<EventArgs>> FromEventPattern(object target, string eventName)
- {
- if (target == null)
- throw new ArgumentNullException("target");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- return s_impl.FromEventPattern(target, eventName);
- }
- #else
- public static IObservable<EventPattern<object>> FromEventPattern(object target, string eventName)
- {
- if (target == null)
- throw new ArgumentNullException("target");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- return s_impl.FromEventPattern(target, eventName);
- }
- #endif
- /// <summary>
- /// Converts an instance .NET event, conforming to the standard .NET event pattern with an <see cref="EventArgs"/> parameter, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the target object type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <param name="target">Object instance that exposes the event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="target"/> or <paramref name="eventName"/> or <paramref name="scheduler"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- #if !NO_EVENTARGS_CONSTRAINT
- public static IObservable<EventPattern<EventArgs>> FromEventPattern(object target, string eventName, IScheduler scheduler)
- {
- if (target == null)
- throw new ArgumentNullException("target");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern(target, eventName, scheduler);
- }
- #else
- public static IObservable<EventPattern<object>> FromEventPattern(object target, string eventName, IScheduler scheduler)
- {
- if (target == null)
- throw new ArgumentNullException("target");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
-
- return s_impl.FromEventPattern(target, eventName, scheduler);
- }
- #endif
- /// <summary>
- /// Converts an instance .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the target object type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="target">Object instance that exposes the event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="target"/> or <paramref name="eventName"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(object target, string eventName)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (target == null)
- throw new ArgumentNullException("target");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- return s_impl.FromEventPattern<TEventArgs>(target, eventName);
- }
- /// <summary>
- /// Converts an instance .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the target object type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="target">Object instance that exposes the event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="target"/> or <paramref name="eventName"/> or <paramref name="scheduler"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(object target, string eventName, IScheduler scheduler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (target == null)
- throw new ArgumentNullException("target");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern<TEventArgs>(target, eventName, scheduler);
- }
- /// <summary>
- /// Converts an instance .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the target object type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TSender">The type of the sender that raises the event.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="target">Object instance that exposes the event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="target"/> or <paramref name="eventName"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TSender, TEventArgs>(object target, string eventName)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (target == null)
- throw new ArgumentNullException("target");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- return s_impl.FromEventPattern<TSender, TEventArgs>(target, eventName);
- }
- /// <summary>
- /// Converts an instance .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the target object type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TSender">The type of the sender that raises the event.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="target">Object instance that exposes the event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="target"/> or <paramref name="eventName"/> or <paramref name="scheduler"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TSender, TEventArgs>(object target, string eventName, IScheduler scheduler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (target == null)
- throw new ArgumentNullException("target");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern<TSender, TEventArgs>(target, eventName, scheduler);
- }
- #endregion
- #region Static events
- /// <summary>
- /// Converts a static .NET event, conforming to the standard .NET event pattern with an <see cref="EventArgs"/> parameter, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the specified type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <param name="type">Type that exposes the static event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="type"/> or <paramref name="eventName"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- #if !NO_EVENTARGS_CONSTRAINT
- public static IObservable<EventPattern<EventArgs>> FromEventPattern(Type type, string eventName)
- {
- if (type == null)
- throw new ArgumentNullException("type");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- return s_impl.FromEventPattern(type, eventName);
- }
- #else
- public static IObservable<EventPattern<object>> FromEventPattern(Type type, string eventName)
- {
- if (type == null)
- throw new ArgumentNullException("type");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- return s_impl.FromEventPattern(type, eventName);
- }
- #endif
- /// <summary>
- /// Converts a static .NET event, conforming to the standard .NET event pattern with an <see cref="EventArgs"/> parameter, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the specified type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <param name="type">Type that exposes the static event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="type"/> or <paramref name="eventName"/> or <paramref name="scheduler"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- #if !NO_EVENTARGS_CONSTRAINT
- public static IObservable<EventPattern<EventArgs>> FromEventPattern(Type type, string eventName, IScheduler scheduler)
- {
- if (type == null)
- throw new ArgumentNullException("type");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern(type, eventName, scheduler);
- }
- #else
- public static IObservable<EventPattern<object>> FromEventPattern(Type type, string eventName, IScheduler scheduler)
- {
- if (type == null)
- throw new ArgumentNullException("type");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern(type, eventName, scheduler);
- }
- #endif
- /// <summary>
- /// Converts a static .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the specified type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="type">Type that exposes the static event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="type"/> or <paramref name="eventName"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(Type type, string eventName)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (type == null)
- throw new ArgumentNullException("type");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- return s_impl.FromEventPattern<TEventArgs>(type, eventName);
- }
- /// <summary>
- /// Converts a static .NET event, conforming to the standard .NET event pattern with strongly typed event arguments, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the specified type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="type">Type that exposes the static event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="type"/> or <paramref name="eventName"/> or <paramref name="scheduler"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's second argument type is not assignable to TEventArgs.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TEventArgs>> FromEventPattern<TEventArgs>(Type type, string eventName, IScheduler scheduler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (type == null)
- throw new ArgumentNullException("type");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern<TEventArgs>(type, eventName, scheduler);
- }
- /// <summary>
- /// Converts a static .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the specified type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TSender">The type of the sender that raises the event.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="type">Type that exposes the static event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="type"/> or <paramref name="eventName"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEventPattern, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEventPattern, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TSender, TEventArgs>(Type type, string eventName)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (type == null)
- throw new ArgumentNullException("type");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- return s_impl.FromEventPattern<TSender, TEventArgs>(type, eventName);
- }
- /// <summary>
- /// Converts a static .NET event, conforming to the standard .NET event pattern with a strongly typed sender and strongly typed event arguments, to an observable sequence.
- /// Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// Reflection is used to discover the event based on the specified type and the specified event name.
- /// For conversion of events that don't conform to the standard .NET event pattern, use any of the FromEvent overloads instead.
- /// </summary>
- /// <typeparam name="TSender">The type of the sender that raises the event.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="type">Type that exposes the static event to convert.</param>
- /// <param name="eventName">Name of the event to convert.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains data representations of invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="type"/> or <paramref name="eventName"/> or <paramref name="scheduler"/> is null.</exception>
- /// <exception cref="InvalidOperationException">The event could not be found. -or- The event does not conform to the standard .NET event pattern. -or- The event's first argument type is not assignable to TSender. -or- The event's second argument type is not assignable to TEventArgs.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEventPattern calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEventPattern that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEventPattern"/>
- public static IObservable<EventPattern<TSender, TEventArgs>> FromEventPattern<TSender, TEventArgs>(Type type, string eventName, IScheduler scheduler)
- #if !NO_EVENTARGS_CONSTRAINT
- where TEventArgs : EventArgs
- #endif
- {
- if (type == null)
- throw new ArgumentNullException("type");
- if (eventName == null)
- throw new ArgumentNullException("eventName");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEventPattern<TSender, TEventArgs>(type, eventName, scheduler);
- }
- #endregion
- #endregion
- #endregion
- #region + FromEvent +
- #region Action<TDelegate>
- /// <summary>
- /// Converts a .NET event to an observable sequence, using a conversion function to obtain the event delegate. Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="conversion">A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters.</param>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="conversion"/> or <paramref name="addHandler"/> or <paramref name="removeHandler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEvent, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEvent"/>
- public static IObservable<TEventArgs> FromEvent<TDelegate, TEventArgs>(Func<Action<TEventArgs>, TDelegate> conversion, Action<TDelegate> addHandler, Action<TDelegate> removeHandler)
- {
- if (conversion == null)
- throw new ArgumentNullException("conversion");
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEvent<TDelegate, TEventArgs>(conversion, addHandler, removeHandler);
- }
- /// <summary>
- /// Converts a .NET event to an observable sequence, using a conversion function to obtain the event delegate. Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="conversion">A function used to convert the given event handler to a delegate compatible with the underlying .NET event. The resulting delegate is used in calls to the addHandler and removeHandler action parameters.</param>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="conversion"/> or <paramref name="addHandler"/> or <paramref name="removeHandler"/> or <paramref name="scheduler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEvent"/>
- public static IObservable<TEventArgs> FromEvent<TDelegate, TEventArgs>(Func<Action<TEventArgs>, TDelegate> conversion, Action<TDelegate> addHandler, Action<TDelegate> removeHandler, IScheduler scheduler)
- {
- if (conversion == null)
- throw new ArgumentNullException("conversion");
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEvent<TDelegate, TEventArgs>(conversion, addHandler, removeHandler, scheduler);
- }
- /// <summary>
- /// Converts a .NET event to an observable sequence, using a supplied event delegate type. Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEvent, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEvent"/>
- public static IObservable<TEventArgs> FromEvent<TDelegate, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEvent<TDelegate, TEventArgs>(addHandler, removeHandler);
- }
- /// <summary>
- /// Converts a .NET event to an observable sequence, using a supplied event delegate type. Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead.
- /// </summary>
- /// <typeparam name="TDelegate">The delegate type of the event to be converted.</typeparam>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> or <paramref name="scheduler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEvent"/>
- public static IObservable<TEventArgs> FromEvent<TDelegate, TEventArgs>(Action<TDelegate> addHandler, Action<TDelegate> removeHandler, IScheduler scheduler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEvent<TDelegate, TEventArgs>(addHandler, removeHandler, scheduler);
- }
- #endregion
- #region Action<Action<TEventArgs>>
- /// <summary>
- /// Converts a generic Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead.
- /// </summary>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEvent, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEvent"/>
- public static IObservable<TEventArgs> FromEvent<TEventArgs>(Action<Action<TEventArgs>> addHandler, Action<Action<TEventArgs>> removeHandler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEvent<TEventArgs>(addHandler, removeHandler);
- }
- /// <summary>
- /// Converts a generic Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead.
- /// </summary>
- /// <typeparam name="TEventArgs">The type of the event data generated by the event.</typeparam>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> or <paramref name="scheduler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEvent"/>
- public static IObservable<TEventArgs> FromEvent<TEventArgs>(Action<Action<TEventArgs>> addHandler, Action<Action<TEventArgs>> removeHandler, IScheduler scheduler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEvent<TEventArgs>(addHandler, removeHandler, scheduler);
- }
- #endregion
- #region Action<Action>
- /// <summary>
- /// Converts an Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead.
- /// </summary>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <returns>The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// The current <see cref="SynchronizationContext"/> is captured during the call to FromEvent, and is used to post add and remove handler invocations.
- /// This behavior ensures add and remove handler operations for thread-affine events are accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// If no SynchronizationContext is present at the point of calling FromEvent, add and remove handler invocations are made synchronously on the thread
- /// making the Subscribe or Dispose call, respectively.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEvent calls outside event stream query expressions due to the free-threaded nature of Reactive Extensions. Doing so
- /// makes the captured SynchronizationContext predictable. This best practice also reduces clutter of bridging code inside queries, making the query expressions
- /// more concise and easier to understand.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEvent"/>
- public static IObservable<Unit> FromEvent(Action<Action> addHandler, Action<Action> removeHandler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- return s_impl.FromEvent(addHandler, removeHandler);
- }
- /// <summary>
- /// Converts an Action-based .NET event to an observable sequence. Each event invocation is surfaced through an OnNext message in the resulting sequence.
- /// For conversion of events conforming to the standard .NET event pattern, use any of the FromEventPattern overloads instead.
- /// </summary>
- /// <param name="addHandler">Action that attaches the given event handler to the underlying .NET event.</param>
- /// <param name="removeHandler">Action that detaches the given event handler from the underlying .NET event.</param>
- /// <param name="scheduler">The scheduler to run the add and remove event handler logic on.</param>
- /// <returns>The observable sequence that contains the event argument objects passed to the invocations of the underlying .NET event.</returns>
- /// <exception cref="ArgumentNullException"><paramref name="addHandler"/> or <paramref name="removeHandler"/> or <paramref name="scheduler"/> is null.</exception>
- /// <remarks>
- /// <para>
- /// Add and remove handler invocations are made whenever the number of observers grows beyond zero.
- /// As such, an event handler may be shared by multiple simultaneously active observers, using a subject for multicasting.
- /// </para>
- /// <para>
- /// Add and remove handler invocations are run on the specified scheduler. This behavior allows add and remove handler operations for thread-affine events to be
- /// accessed from the same context, as required by some UI frameworks.
- /// </para>
- /// <para>
- /// It's recommended to lift FromEvent calls outside event stream query expressions. This best practice reduces clutter of bridging code inside queries,
- /// making the query expressions more concise and easier to understand. This has additional benefits for overloads of FromEvent that omit the IScheduler
- /// parameter. For more information, see the remarks section on those overloads.
- /// </para>
- /// </remarks>
- /// <seealso cref="Observable.ToEvent"/>
- public static IObservable<Unit> FromEvent(Action<Action> addHandler, Action<Action> removeHandler, IScheduler scheduler)
- {
- if (addHandler == null)
- throw new ArgumentNullException("addHandler");
- if (removeHandler == null)
- throw new ArgumentNullException("removeHandler");
- if (scheduler == null)
- throw new ArgumentNullException("scheduler");
- return s_impl.FromEvent(addHandler, removeHandler, scheduler);
- }
- #endregion
- #endregion
- }
- }
|