Tests/ABPCMS.Tests/bin/Debug/Hangfire.Core.xml

这里只显示每个文件的开头 60 行。登录后可以解锁完整代码。

微信扫码关注公众号，代码整理好后第一时间通知你。

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Hangfire.Core</name>
    </assembly>
    <members>
        <member name="T:Hangfire.AppBuilderExtensions">
            <summary>
            Provides extension methods for the <c>IAppBuilder</c> interface
            defined in the <see href="https://www.nuget.org/packages/Owin/">Owin</see> 
            NuGet package to simplify the integration with OWIN applications.
            </summary>
            
            <remarks>
            
            <para>This class simplifies Hangfire configuration in OWIN applications,
            please read <see href="http://www.asp.net/aspnet/overview/owin-and-katana/getting-started-with-owin-and-katana">
            Getting Started with OWIN and Katana</see> if you aren't familiar with OWIN
            and/or don't know what is the <c>Startup</c> class.
            </para>
            
            <para>The methods of this class should be called from OWIN's <c>Startup</c> 
            class.</para>
            
            <h3>UseHangfireDashboard</h3>
            <para>Dashboard UI contains pages that allow you to monitor almost every
            aspect of background processing. It is exposed as an OWIN middleware that 
            intercepts requests to the given path.</para>
            <para>OWIN implementation of Dashboard UI allows to use it outside of web
            applications, including console applications and Windows Services.</para>
            <note type="important">
            By default, an access to the Dashboard UI is restricted <b>only to local
            requests</b> for security reasons. Before publishing a project to
            production, make sure you still have access to the Dashboard UI by using the
            <see href="https://www.nuget.org/packages/Hangfire.Dashboard.Authorization/">
            Hangfire.Dashboard.Authorization</see> package.</note>
            
            <h3>UseHangfireServer</h3>
            <para>In addition to creation of a new instance of the <see cref="T:Hangfire.BackgroundJobServer"/> 
            class, these methods also register the call to its <see cref="M:Hangfire.BackgroundJobServer.Dispose"/> 
            method on application shutdown. This is done via registering a callback on the corresponding 
            <see cref="T:System.Threading.CancellationToken"/> from OWIN environment (<c>"host.OnAppDisposing"</c> or 
            <c>"server.OnDispose"</c> keys).</para>
            <para>This enables <i>graceful shutdown</i> feature for background jobs and background processes
            without any additional configuration.</para>
            <para>Please see <see cref="T:Hangfire.BackgroundJobServer"/> for more details regarding
            background processing.</para>
            </remarks>
            
            <example>
            <h3>Basic Configuration</h3> 
            <para>Basic setup in an OWIN application looks like the following example. Please note
            that job storage should be configured before using the methods of this class.</para>
            
            <code lang="cs" source="..\Samples\AppBuilderExtensions.cs" region="Basic Setup" />
            
            <h3>Adding Dashboard Only</h3>
            <para>If you want to install dashboard without starting a background job server, for example,
            to process background jobs outside of your web application, call only the
            <see cref="O:Hangfire.AppBuilderExtensions.UseHangfireDashboard"/>.</para>