Wiki

Clone wiki

Proligence.SignalR-git / Home

Proligence SignalR Module

Module enables to utilize all the functionality that SignalR provides in your custom Orchard modules without having to deal with plugging in SignalR on your own. If you haven't got familiar with SignalR yet, it's a great opportunity to do so!:)

Installation package for Orchard is available through Orchard Gallery

Current stable version is 2.1.2 and it runs the latest SignalR 2.1.2-pre.

The latest version requires Orchard >= 1.8 and .NET >= 4.5 to run. Gallery package is not yet available.

Contents

Module contains two features:

  • SignalR Core (Proligence.SignalR). Provides a core SignalR functionality.
  • SignalR Samples (Proligence.SignalR.Samples). Some samples showcasing SignalR features in action.

Creating hubs and persistent connections

You don't need to register your custom hubs and connections anywhere. Just place them in your module and they will get discovered automatically.

If you want to customize a name and/or URL of your persistent connection, mark it's class with [Connection] attribute and provide necessary Name and/or Url arguments. Otherwise, the default name and/or URL will be used.

Samples

In order to run the contained samples, enable the SignalR Samples feature. Right now it contains four original SignalR samples:

  • Hub Benchmark (/Samples/Benchmark)
  • Chat (/Samples/Chat). Altered to show the ability to interact with Orchard-provided features, in this case accessing the current application user. You must be logged in to view this sample.
  • Raw Connection (/Samples/Raw).
  • Drawing Pad (/Samples/DrawingPad).

Hope it's enough to let you start getting hands dirty with SignalR and Orchard. We'll try to port all other samples, as well as provide more in-depth documentation soon.

Updated