Class NCacheDependencyInjectionExtensions

This class acts as the registration point for the clients against the ASP.NET Core SignalR implementation.

Inheritance
System.Object
NCacheDependencyInjectionExtensions
Assembly: Alachisoft.NCache.AspNetCore.SignalR.dll
Syntax
public static class NCacheDependencyInjectionExtensions : object

Methods

AddNCache(ISignalRServerBuilder, Action<NCacheConfiguration>)

Adds scale-out to a ISignalRServerBuilder with NCache options provided through NCacheConfiguration.

Declaration
public static ISignalRServerBuilder AddNCache(this ISignalRServerBuilder signalrBuilder, Action<NCacheConfiguration> configure)
Parameters
Type Name Description
ISignalRServerBuilder signalrBuilder

A builder abstraction for configuring SignalR servers.
Action<NCacheConfiguration> configure

A callback to NCacheConfiguration options.
Returns
Type Description
ISignalRServerBuilder

The same instance of the ISignalRServerBuilder for chaining.

AddNCache(ISignalRServerBuilder, String, String)

Adds scale-out to a ISignalRServerBuilder, using NCache server.

Declaration
public static ISignalRServerBuilder AddNCache(this ISignalRServerBuilder signalRBuilder, string cacheName, string eventKey)
Parameters
Type Name Description
ISignalRServerBuilder signalRBuilder

A builder abstraction for configuring SignalR servers.
System.String cacheName

Name of the cache in NCache which will store the respective item for the client.
System.String eventKey

Unique, user specified key attribute for the item added to NCache on client registration.
Returns
Type Description
ISignalRServerBuilder

The same instance of the ISignalRServerBuilder for chaining.

AddNCache(ISignalRServerBuilder, String, String, String, String)

Adds scale-out to a ISignalRServerBuilder with credentials used when NCache security is enabled.

Declaration
public static ISignalRServerBuilder AddNCache(this ISignalRServerBuilder signalRBuilder, string cacheName, string eventKey, string userId, string password)
Parameters
Type Name Description
ISignalRServerBuilder signalRBuilder

A builder abstraction for configuring SignalR servers.
System.String cacheName

Name of the cache in NCache which will store the respective item for the client.
System.String eventKey

Unique, user specified key attribute for the item added to NCache on client registration.
System.String userId

Specifies the username of authorized user required when security is enabled on Cache Server.
System.String password

Specifies the password of authorized user required when security is enabled on Cache Server
Returns
Type Description
ISignalRServerBuilder

The same instance of the ISignalRServerBuilder for chaining.