Equivalent of StaticServiceHubContextStore in Isolated function app

Question

Equivalent of StaticServiceHubContextStore in Isolated function app

Muralidharan Deenathayalan 41

Hello,

I hope you are doing well. We have been using the StaticServiceHubContextStore class in in-proc Azure functions, and it works fine. Recently, we decided to switch to the Isolated function app, and we would like to know the equivalent class for 'StaticServiceHubContextStore' in the Isolated function app.

Kindly assist us with any relevant documentation links.

Thank you, Murali.

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2024-01-04T13:52:02.8333333+00:00

Muralidharan Deenathayalan Just a follow up to see if it helps or still have any questions. Feel free to reach out for any question and any info on use case with code snippet would be helpful to understand your scenario.

1 answer

Your answer

MuthuKumaranMurugaachari-MSFT 22,441 Reputation points Moderator

2024-01-04T13:52:02.8333333+00:00

Muralidharan Deenathayalan Just a follow up to see if it helps or still have any questions. Feel free to reach out for any question and any info on use case with code snippet would be helpful to understand your scenario.

Answer 1

MuthuKumaranMurugaachari-MSFT 22,441 Moderator

Muralidharan Deenathayalan Thanks for posting your question in Microsoft Q&A. StaticServiceHubContextStore is part of Microsoft.Azure.WebJobs.Extensions.SignalRService which is only used in In-Process model. However, in isolated model, you use Worker.Extensions.SignalRService and full implementation including ServerlessHub, InvocationContext etc. can be found here and refer to doc: https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-signalr-service-output?tabs=isolated-process&pivots=programming-language-csharp for sending messages or broad a message to all connected clients. Check out SignalR samples for full sample code for different scenarios.

If you are looking for similar experience to in-process, consider ServerlessHub with a class-based model approach.

I hope this helps and feel free to reach out if any questions.

If you found the answer to your question helpful, please take a moment to mark it as Yes for others to benefit from your experience. Or simply add a comment tagging me and would be happy to answer your questions.

Masa Komazec 0

Hi, sorry for jumping in, but is there an example of how to access clients from outside the function class?

In in-process model, I used this and it worked:

var ctx = await StaticServiceHubContextStore
    .Get(ConnectionString)
    .GetAsync(hubName);

await ctx.Clients.Users(audience ?? new()).SendAsync(
    method: DefaultMethodName,
    arg1: @event.EventName,
    arg2: @event);

For isolated worker I can only find examples of unicast/multicast/broadcast sent from a hub (a class that inherits ServerlessHub). So is there a way to access Clients list from another class/namespace completely?

This is the azure functions:

using System;
using System.Linq;
using System.Threading.Tasks;
using CryingOnion.IamAuthorization;
using Microsoft.AspNetCore.SignalR;
using Microsoft.Extensions.Logging;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Azure.SignalR.Management;
using Microsoft.Azure.Functions.Worker.Http;
using Microsoft.Azure.Functions.Worker.SignalRService;

namespace Notifications.AzureFunctions.API.Async;
[SignalRConnection("SignalrPrimaryConnectionString")]
public class RealTimeUpdatesSignalR : ServerlessHub<IClientProxy>
{
    private const string OrganizationCodeClaim = "organizationCode";
    private const string OrganizationalNodeClaim = "organizationalNodeId";
    private const string GroupClaims = "groupId";

    private readonly ILogger<RealTimeUpdatesSignalR> _logger;

    public RealTimeUpdatesSignalR(IServiceProvider serviceProvider, ILogger<RealTimeUpdatesSignalR> logger) : base(serviceProvider)
    {
        _logger = logger;
    }

    [Function("real-time-updates-negotiate")]
    public async Task<HttpResponseData> Negotiate([HttpTrigger(AuthorizationLevel.Anonymous, "post", Route = "real-time-updates/negotiate")] HttpRequestData httpRequest, IamTokenProvider tokenProvider)
    {
        var response = httpRequest.CreateResponse();

        var token = tokenProvider.GetToken();

        _logger.LogInformation($"User: {token.ObjectId} has negotiated connection");

        var options = new NegotiationOptions
        {
            UserId = token.ObjectId,
            Claims = token.GetClaims()
        };

        var negotiateResult = await NegotiateAsync(options: options);

        await response.WriteBytesAsync(negotiateResult.ToArray());

        return response;
    }

    [Function("real-time-updates-on-connected")]
    public async Task OnConnected([SignalRTrigger(nameof(RealTimeUpdatesSignalR), "connections", "connected", ConnectionStringSetting = "SignalrPrimaryConnectionString")] SignalRInvocationContext invocationContext)
    {
        var claims = invocationContext.Claims
            .Where(x => x.Key == OrganizationCodeClaim || x.Key == OrganizationalNodeClaim || x.Key.StartsWith(GroupClaims))
            .Select(x => x.Value);

        foreach (var claim in claims)
        {
            await Groups.AddToGroupAsync(
                connectionId: invocationContext.ConnectionId,
                groupName: claim);
        }

        _logger.LogInformation($"{invocationContext.ConnectionId} has connected with claims: {string.Join(" * ", invocationContext.Claims)}");
    }

    [Function("real-time-updates-on-disconnected")]
    public async Task OnDisconnected([SignalRTrigger(nameof(RealTimeUpdatesSignalR), "connections", "disconnected", ConnectionStringSetting = "SignalrPrimaryConnectionString")] SignalRInvocationContext invocationContext)
    {
        var claims = invocationContext.Claims
            .Where(x => x.Key == OrganizationCodeClaim || x.Key == OrganizationalNodeClaim || x.Key.StartsWith(GroupClaims))
            .Select(x => x.Value);

        foreach (var claim in claims)
        {
            await Groups.RemoveFromGroupAsync(
                connectionId: invocationContext.ConnectionId,
                groupName: claim);
        }

        _logger.LogInformation($"{invocationContext.ConnectionId} has disconnected with claims: {string.Join(" * ", invocationContext.Claims)}");
    }
}

In Program.cs I registered the hub:

services.AddServerlessHub<RealTimeUpdatesSignalR>();

I would really appreciate any input!

Share via

Equivalent of StaticServiceHubContextStore in Isolated function app

1 answer

Your answer