AppBuilderExtensions.UseHangfireServer Method (IAppBuilder, BackgroundJobServerOptions, IBackgroundProcess[])

AppBuilderExtensionsUseHangfireServer Method (IAppBuilder, BackgroundJobServerOptions, IBackgroundProcess)

Creates a new instance of the BackgroundJobServer class with the specified options, given collection of background processes and Current storage, and registers its disposal on application shutdown.

Namespace: Hangfire
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0

Syntax

Copy

public static IAppBuilder UseHangfireServer(
	[NotNullAttribute] this IAppBuilder builder,
	[NotNullAttribute] BackgroundJobServerOptions options,
	[NotNullAttribute] params IBackgroundProcess[] additionalProcesses
)

<ExtensionAttribute>
Public Shared Function UseHangfireServer ( 
	<NotNullAttribute> builder As IAppBuilder,
	<NotNullAttribute> options As BackgroundJobServerOptions,
	<NotNullAttribute> ParamArray additionalProcesses As IBackgroundProcess()
) As IAppBuilder

Parameters

builder: Type: IAppBuilder
OWIN application builder.
options: Type: HangfireBackgroundJobServerOptions
Options for background job server.
additionalProcesses: Type: Hangfire.ServerIBackgroundProcess
Collection of additional background processes.

Return Value

Type: IAppBuilder

Usage 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	options is null.
ArgumentNullException	additionalProcesses is null.
InvalidOperationException	OWIN environment does not contain the application shutdown cancellation token.

Remarks

Please see AppBuilderExtensions for details and examples.

Reference

AppBuilderExtensions Class

UseHangfireServer Overload

Hangfire Namespace