IHubPipeline.AddModule Method

.NET Framework 4

Adds an IHubPipelineModule to the hub pipeline. Modules added to the pipeline first will wrap modules that are added to the pipeline later. All modules must be added to the pipeline before any methods on the IHubPipelineInvoker are invoked.

Namespace:  Microsoft.AspNet.SignalR.Hubs
Assembly:  Microsoft.AspNet.SignalR.Core (in Microsoft.AspNet.SignalR.Core.dll)

Syntax

'Declaration
Function AddModule ( _
    pipelineModule As IHubPipelineModule _
) As IHubPipeline
'Usage
Dim instance As IHubPipeline 
Dim pipelineModule As IHubPipelineModule 
Dim returnValue As IHubPipeline 

returnValue = instance.AddModule(pipelineModule)
IHubPipeline AddModule(
    IHubPipelineModule pipelineModule
)
IHubPipeline^ AddModule(
    IHubPipelineModule^ pipelineModule
)
abstract AddModule : 
        pipelineModule:IHubPipelineModule -> IHubPipeline
function AddModule(
    pipelineModule : IHubPipelineModule
) : IHubPipeline

Parameters

  • pipelineModule
    Type: Microsoft.AspNet.SignalR.Hubs.IHubPipelineModule
    A module that may intercept and customize various stages of hub processing such as connecting, reconnecting, disconnecting, invoking server-side hub methods, invoking client-side hub methods, authorizing hub clients and rejoining hub groups.

Return Value

Type: Microsoft.AspNet.SignalR.Hubs.IHubPipeline
The IHubPipeline itself with the newly added module allowing AddModule(IHubPipelineModule) calls to be chained. This method mutates the pipeline it is invoked on so it is not necessary to store its result.

See Also

Reference

IHubPipeline Interface

Microsoft.AspNet.SignalR.Hubs Namespace