Skip to content

geniussportsgroup/SignalR.ProxyGenerator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build status

SignalR.ProxyGenerator

Small wrapper over the SignalR Proxy Generator to allow you to create the proxies at build time. This will generate the normal proxy for any assmblies loaded into the app domain. All the comments are stripped out from the top. You an then prepend any text lines into the top of the proxy using the metadata array, this allows you to specify your own dependency path comments for things like jQuery.

https://www.nuget.org/packages/SignalR.ProxyGenerator

Usage

SignalR.ProxyGenerator

The utility library is simple to use, load any assemblies required and then create a SignalRProxyGenerator and call Generate. It returns the JavaScript as a string. We can't pick a specific assembly to scan because we are using the SignalR DefaultHubManager which looks in all loaded assemblies.

/// <summary>
/// Returns the JavaScript proxy for any hubs found in any assemblies loaded into the AppDomain
/// </summary>
/// <param name="signalRUrlPath">The service URL used by the connection. Defaults to "/signalr". When created dynamically this would generate at the running address, for example if you had an IIS app called "MyApp" it would generate "http://localhost:port/MyApp/signalr".</param>
/// <param name="metaData">An array of lines to prepend into the file. This can be useful if you want to specify a path in your build system to a dependency such as jQuery</param>
/// <returns>JavaScript proxy code</returns>
string Generate(string signalRUrlPath = "/signalr", params string[] metaData);

SignalR.ProxyGenerator.Console

This will output the JavaScript to the specified file path

.\SignalR.ProxyGenerator.Console.exe -a "c:\etc\path-to-myassembly.dll" -o "C:\temp\hubs.js" -m "// Some metadata I want,// Other metadata"

# ONLY COMBATIBLE WITH SIGNALR VERSIONS AT 2.2.1.0 OR EARLIER #

We have compiled this at verison 2.2.1.0 so in order for the HubManager to recognise your hubs we are using an assembly redirect. If Microsoft release a new version we will need to update this.

<dependentAssembly>
    <assemblyIdentity name="Microsoft.AspNet.SignalR.Core" publicKeyToken="31bf3856ad364e35" culture="neutral" />
    <bindingRedirect oldVersion="0.0.0.0-2.2.1.0" newVersion="2.2.1.0" />
  </dependentAssembly>

If the output file is not specified the result is written to standard out.

About

A command line tool to generate SignalR hub proxies

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published