Skip to content

Commit

Permalink
Provide Microsoft.AspNetCore.SignalR.Client package README (dotnet#…
Browse files Browse the repository at this point in the history
  • Loading branch information
MackinnonBuck committed Sep 6, 2024
1 parent 46ad888 commit a2fce73
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions src/SignalR/clients/csharp/Client/src/PACKAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
## About

`Microsoft.AspNetCore.SignalR.Client` provides the .NET client for ASP.NET Core SignalR, which simplifies adding real-time web functionality to apps.

## Key Features

SignalR provides the following capabilities:
* Automatic connection management
* Sending messages to all connected clients simultaneously
* Sending messages to specific clients or groups of clients
* Scaling to handle increasing traffic

## How to Use

To use `Microsoft.AspNetCore.SignalR.Client`, follow these steps:

### Installation

```shell
dotnet add package Microsoft.AspNetCore.SignalR.Client
```

### Configuration

See the [ASP.NET Core SignalR docs](https://learn.microsoft.com/aspnet/core/signalr/hubs) for information about how to configure SignalR hubs on the server.

Then, you can configure the client to connect to the hub. For example:

```csharp
var connection = new HubConnectionBuilder()
.WithUrl("http://localhost:53353/Chat")
.Build();

connection.On("ReceiveMessage", (string user, string message) =>
{
Console.WriteLine($"{user}: {message}");
});

await connection.StartAsync();
```

## Main Types

The main types provided by `Microsoft.AspNetCore.SignalR.Client` include:
* `HubConnectionBuilder`: Provides an abstraction to construct new SignalR hub connections
* `HubConnection`: Defines methods for managing a hub connection, including:
* Starting and stopping the connection
* Sending and receiving messages
* Handling disconnects and attempting reconnects
* `HubConnectionOptions`: Provides options for configuring a `HubConnection`

## Additional Documentation

For additional documentation and examples, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/signalr/dotnet-client) on the .NET client for ASP.NET Core SignalR.

## Feedback & Contributing

`Microsoft.AspNetCore.SignalR.Client` is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).

0 comments on commit a2fce73

Please sign in to comment.