Rx.NET/System.Reactive.PlatformServices/Reactive/EnlightenmentProvider.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.

using System.Reactive.Concurrency;

namespace System.Reactive.PlatformServices
{
    /// <summary>
    /// Provides access to the platform enlightenments used by other Rx libraries to improve system performance and
    /// runtime efficiency. While Rx can run without platform enlightenments loaded, it's recommended to deploy the
    /// System.Reactive.PlatformServices assembly with your application and call <see cref="EnlightenmentProvider.
    /// EnsureLoaded"/> during application startup to ensure enlightenments are properly loaded.
    /// </summary>
    public static class EnlightenmentProvider
    {
        /// <summary>
        /// Ensures that the calling assembly has a reference to the System.Reactive.PlatformServices assembly with
        /// platform enlightenments. If no reference is made from the user code, it's possible for the build process
        /// to drop the deployment of System.Reactive.PlatformServices, preventing its runtime discovery.
        /// </summary>
        /// <returns>
        /// true if the loaded enlightenment provider matches the provided defined in the current assembly; false
        /// otherwise. When a custom enlightenment provider is installed by the host, false will be returned.
        /// </returns>
        public static bool EnsureLoaded()
        {
            return PlatformEnlightenmentProvider.Current is CurrentPlatformEnlightenmentProvider;
        }
    }
}