| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405 |
- // Licensed to the .NET Foundation under one or more agreements.
- // The .NET Foundation licenses this file to you under the Apache 2.0 License.
- // See the LICENSE file in the project root for more 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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(conversion));
- if (addHandler == null)
- throw new ArgumentNullException(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(conversion));
- if (addHandler == null)
- throw new ArgumentNullException(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(target));
- if (eventName == null)
- throw new ArgumentNullException(nameof(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(nameof(target));
- if (eventName == null)
- throw new ArgumentNullException(nameof(eventName));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(target));
- if (eventName == null)
- throw new ArgumentNullException(nameof(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(nameof(target));
- if (eventName == null)
- throw new ArgumentNullException(nameof(eventName));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(target));
- if (eventName == null)
- throw new ArgumentNullException(nameof(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(nameof(target));
- if (eventName == null)
- throw new ArgumentNullException(nameof(eventName));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(type));
- if (eventName == null)
- throw new ArgumentNullException(nameof(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(nameof(type));
- if (eventName == null)
- throw new ArgumentNullException(nameof(eventName));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(type));
- if (eventName == null)
- throw new ArgumentNullException(nameof(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(nameof(type));
- if (eventName == null)
- throw new ArgumentNullException(nameof(eventName));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(type));
- if (eventName == null)
- throw new ArgumentNullException(nameof(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(nameof(type));
- if (eventName == null)
- throw new ArgumentNullException(nameof(eventName));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(conversion));
- if (addHandler == null)
- throw new ArgumentNullException(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(conversion));
- if (addHandler == null)
- throw new ArgumentNullException(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(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(nameof(addHandler));
- if (removeHandler == null)
- throw new ArgumentNullException(nameof(removeHandler));
- if (scheduler == null)
- throw new ArgumentNullException(nameof(scheduler));
- return s_impl.FromEvent(addHandler, removeHandler, scheduler);
- }
- #endregion
- #endregion
- }
- }
|