 | AppBuilderExtensionsUseHangfireServer Method (IAppBuilder, BackgroundJobServerOptions, JobStorage) |
Creates a new instance of the BackgroundJobServer class
with the given options and specified storage, and registers its disposal
on application shutdown.
Namespace: Hangfire
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0
Syntaxpublic static IAppBuilder UseHangfireServer( [NotNullAttribute] this IAppBuilder builder, [NotNullAttribute] BackgroundJobServerOptions options, [NotNullAttribute] JobStorage storage )
Parameters
- builder
- Type: IAppBuilder
OWIN application builder. - options
- Type: HangfireBackgroundJobServerOptions
Options for background job server. - storage
- Type: HangfireJobStorage
Storage to use by background job server.
Return Value
Type: IAppBuilderUsage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IAppBuilder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | builder is null. |
| ArgumentNullException | storage is null. |
| ArgumentNullException | options is null. |
| InvalidOperationException | OWIN environment does not contain the application shutdown cancellation token. |
Remarks
Please see AppBuilderExtensions for details and examples.
See Also