Azure SignalR Service SDK for .NET
Permalink
Failed to load latest commit information.
build update aspnet signalr version to latest (#213) Sep 21, 2018
docs Add internals for ASP.NET SignalR (#225) Oct 11, 2018
samples/ChatSample Add client IP address in Context.HttpContext (#207) Sep 18, 2018
specs New service protocol(#21) Apr 22, 2018
src Upgrade sdk version, for ASP.NET signalR, stick to 1.0.0 preview (#228) Oct 15, 2018
test Add custom roletype and nametype to claims (#224) Oct 11, 2018
.gitignore Merge AspNet related changes to dev branch (#209) Sep 20, 2018
.travis.yml Merge AspNet related changes to dev branch (#209) Sep 20, 2018
AzureSignalR.sln Merge AspNet related changes to dev branch (#209) Sep 20, 2018
Directory.Build.props add required metadata for nuget package (#117) Jun 5, 2018
Directory.Build.targets initial commit of Azure SignalR SDK Feb 27, 2018
LICENSE Initial commit Feb 27, 2018
NuGet.config initial commit of Azure SignalR SDK Feb 27, 2018
README.md Update readme.md to include preview version (#229) Oct 17, 2018
appveyor.yml Merge AspNet related changes to dev branch (#209) Sep 20, 2018
build.cmd build scripts (#61) Apr 28, 2018
build.sh Some updates to korebuild usage (#64) Apr 28, 2018
korebuild-lock.txt fix issue #99 (#100) May 17, 2018
korebuild.json Some updates to korebuild usage (#64) Apr 28, 2018
publish.cmd build scripts (#61) Apr 28, 2018
run.cmd build scripts (#61) Apr 28, 2018
run.ps1 build scripts (#61) Apr 28, 2018
run.sh Some updates to korebuild usage (#64) Apr 28, 2018
version.props Upgrade sdk version, for ASP.NET signalR, stick to 1.0.0 preview (#228) Oct 15, 2018

README.md

Azure SignalR Service SDK for .NET

Azure SignalR Service SDK for .NET helps you to instantly build Azure applications with real-time messaging functionality, taking advantage of scalable cloud computing resources.

This repository contains the open source subset of the .NET SDK.

Build Status

Travis build status AppVeyor build status

Nuget Packages

Package Name Target Framework NuGet MyGet
Microsoft.Azure.SignalR .NET Standard 2.0 NuGet MyGet
Microsoft.Azure.SignalR.Protocols .NET Standard 2.0 NuGet MyGet
Microsoft.Azure.SignalR.AspNet .NET Standard 2.0 NuGet MyGet

Getting Started

Azure SignalR Service is based on ASP.NET Core SignalR framework, and it supports both ASP.NET Core SignalR and ASP.NET SignalR applications. The support for ASP.NET Core SignalR is generally available, while the support for ASP.NET SignalR is in preview stage at this time.

ASP.NET Core SignalR

Package Microsoft.Azure.SignalR is the one to use when you are using ASP.NET Core SignalR. If you are not familiar with ASP.NET Core SignalR yet, we recommend you to read ASP.NET Core SignalR's documentation first.

Follow the tutorial at here to get started with Azure SignalR Service.

More samples on how to use Azure SignalR Service can be found here.

Note

There're two versions of SignalR: ASP.NET SignalR and ASP.NET Core SignalR. The ASP.NET Core version is not a simple .NET Core port of the original SignalR, but a rewrite of the original version. As a result, ASP.NET Core SignalR is not backward compatible with ASP.NET SignalR (API interfaces and behaviors are different). If it is the first time you try SignalR, we recommend you to use the ASP.NET Core SignalR, it is simpler, more reliable, and easier to use.

ASP.NET SignalR

Package Microsoft.Azure.SignalR.AspNet is the one to use when you are using ASP.NET SignalR. If you are not familiar with ASP.NET SignalR yet, we recommend you to read ASP.NET SignalR's documentation first.

Samples on how to use Azure SignalR Service can be found here

Next Steps

The following documents describe more details about Azure SignalR Service.

Contributions are highly welcome. Keep reading if you want to contribute to our repository.

Building from source

Run build.cmd or build.sh without arguments for a complete build including tests. See Building documents for more details.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.