C# Class Microsoft.AspNetCore.SignalR.GroupManager

The default IGroupManager implementation.
Inheritance: IConnectionGroupManager
Show file Open project: FabianGosebrink/ASPNET-Core-Angular2-SignalR-Typescript Class Usage Examples

Public Methods

Method Description
Add ( string connectionId, string groupName ) : System.Threading.Tasks.Task

Adds a connection to the specified group.
GroupManager ( IConnection connection, string groupPrefix ) : System

Initializes a new instance of the GroupManager class.
Remove ( string connectionId, string groupName ) : System.Threading.Tasks.Task

Removes a connection from the specified group.
Send ( IList groupNames, object value ) : System.Threading.Tasks.Task

Sends a value to the specified group.
Send ( string groupName, object value ) : System.Threading.Tasks.Task

Sends a value to the specified group.

Private Methods

Method Description
CreateQualifiedName ( string groupName ) : string

Method Details

Add() public method

Adds a connection to the specified group.
public Add ( string connectionId, string groupName ) : System.Threading.Tasks.Task
connectionId string The connection id to add to the group.
groupName string The name of the group
return System.Threading.Tasks.Task

GroupManager() public method

Initializes a new instance of the GroupManager class.
public GroupManager ( IConnection connection, string groupPrefix ) : System
connection IConnection The this group resides on.
groupPrefix string The prefix for this group. Either a name or type name.
return System

Remove() public method

Removes a connection from the specified group.
public Remove ( string connectionId, string groupName ) : System.Threading.Tasks.Task
connectionId string The connection id to remove from the group.
groupName string The name of the group
return System.Threading.Tasks.Task

Send() public method

Sends a value to the specified group.
public Send ( IList groupNames, object value ) : System.Threading.Tasks.Task
groupNames IList The names of the groups.
value object The value to send.
return System.Threading.Tasks.Task

Send() public method

Sends a value to the specified group.
public Send ( string groupName, object value ) : System.Threading.Tasks.Task
groupName string The name of the group.
value object The value to send.
return System.Threading.Tasks.Task