Konfigurasi ASP.NET Core SignalR

Artikel ini menjelaskan cara mengonfigurasi opsi klien dan server untuk ASP.NET Core SignalR.

Untuk BlazorSignalR panduan, yang menambahkan atau menggantikan panduan dalam artikel ini, lihat panduan ASP.NET CoreBlazorSignalR.

Mengonfigurasi serialisasi untuk mengodekan pesan

ASP.NET Core SignalR mendukung dua protokol untuk mengodekan pesan: JSON dan MessagePack. Setiap protokol memiliki opsi konfigurasi serialisasi.

Opsi serialisasi JSON

Serialisasi JSON dapat dikonfigurasi di server dengan menggunakan AddJsonProtocol metode ekstensi. AddJsonProtocol dapat ditambahkan setelah metode AddSignalR dalam Startup.ConfigureServices. Metode AddJsonProtocol membutuhkan delegat yang menerima objek options. Properti pada objek tersebut PayloadSerializerOptions adalah System.Text.JsonJsonSerializerOptions objek yang dapat digunakan untuk mengonfigurasi serialisasi argumen dan mengembalikan nilai. Untuk informasi selengkapnya, lihat dokumentasi System.Text.Json.

Misalnya, untuk mengonfigurasi serializer agar tidak mengubah kapitalisasi nama properti, alih-alih menggunakan nama camel case bawaan, gunakan kode berikut di file Program.cs:

builder.Services.AddSignalR()
    .AddJsonProtocol(options => {
        options.PayloadSerializerOptions.PropertyNamingPolicy = null;
    });

Di klien .NET, metode ekstensi yang sama AddJsonProtocol ada di HubConnectionBuilder. Namespace Microsoft.Extensions.DependencyInjection harus diimpor untuk menyelesaikan metode ekstensi:

// At the top of the file:
using Microsoft.Extensions.DependencyInjection;

// When constructing your connection:
var connection = new HubConnectionBuilder()
    .AddJsonProtocol(options => {
        options.PayloadSerializerOptions.PropertyNamingPolicy = null;
    })
    .Build();

Nota

Tidak dimungkinkan untuk mengonfigurasi serialisasi JSON di klien JavaScript saat ini.

Beralih ke Newtonsoft.Json

Jika aplikasi Anda memerlukan fitur dalam paket Newtonsoft.Json yang tidak didukung di System.Text.Json, lihat Switch ke Newtonsoft.Json.

Opsi serialisasi MessagePack

Serialisasi MessagePack dapat dikonfigurasi dengan memberikan delegasi untuk panggilan AddMessagePackProtocol. Untuk informasi selengkapnya, lihat MessagePack di SignalR.

Nota

Tidak dimungkinkan untuk mengonfigurasi serialisasi MessagePack di klien JavaScript saat ini.

Konfigurasi pilihan server

Tabel berikut menjelaskan opsi untuk mengonfigurasi SignalR hub.

Opsi	Nilai standar	Deskripsi
ClientTimeoutInterval	30 detik	Server menganggap klien terputus jika tidak menerima pesan (termasuk keep-alive) dalam interval ini. Mungkin diperlukan waktu lebih lama daripada batas waktu ini sebelum klien dianggap terputus karena cara fitur ini diterapkan. Nilai yang disarankan adalah dua kali lipat nilainya KeepAliveInterval .
HandshakeTimeout	15 detik	Jika klien tidak mengirim pesan jabat tangan awal dalam interval waktu ini, koneksi ditutup. Opsi ini adalah pengaturan lanjutan yang hanya boleh dimodifikasi jika kesalahan batas waktu jabat tangan terjadi karena latensi jaringan yang parah. Untuk detail selengkapnya tentang proses jabat tangan, lihat SignalR Spesifikasi Protokol Hub.
KeepAliveInterval	15 detik	Interval saat pesan ping dikirim secara otomatis untuk menjaga koneksi tetap terbuka. Saat Anda mengubah nilai KeepAliveInterval, ubah pengaturan ServerTimeout atau serverTimeoutInMilliseconds di klien. Nilai yang direkomendasikan ServerTimeout atau serverTimeoutInMilliseconds adalah dua kali lipat dari nilai KeepAliveInterval.
SupportedProtocols	Semua protokol yang terinstal	Protokol yang didukung oleh hub ini. Secara default, semua protokol yang terdaftar di server diizinkan. Protokol dapat dihapus dari daftar ini untuk menonaktifkan protokol tertentu untuk hub individual.
EnableDetailedErrors	false	Ketika opsi ini diaktifkan (true), pesan pengecualian terperinci dikembalikan ke klien ketika pengecualian dilemparkan dalam metode hub. Defaultnya adalah false karena pesan pengecualian ini dapat berisi informasi sensitif.
StreamBufferCapacity	10	Jumlah maksimum item yang dapat di-buffer untuk stream pengunggahan klien. Ketika batas ini tercapai, pemrosesan pemanggilan diblokir hingga server memproses item streaming.
MaximumReceiveMessageSize	32 KB	Ukuran maksimum untuk satu pesan masuk hub. Meningkatkan nilai dapat meningkatkan risiko serangan Denial of service (DoS).
MaximumParallelInvocationsPerClient	1	Jumlah maksimum metode hub yang dapat dipanggil setiap klien secara paralel sebelum mengantre. Perhatikan bahwa batas ini tidak berlaku untuk pemanggilan hub streaming. Untuk informasi selengkapnya, lihat Menggunakan hub di ASP.NET Core SignalR.
DisableImplicitFromServicesParameters	false	Argumen metode hub ditentukan melalui injeksi dependensi, jika memungkinkan.

Opsi dapat dikonfigurasi untuk semua hub dengan menyediakan delegasi opsi ke pemanggilan AddSignalR dalam file Program.cs.

 builder.Services.AddSignalR(hubOptions =>
 {
     hubOptions.EnableDetailedErrors = true;
     hubOptions.KeepAliveInterval = TimeSpan.FromMinutes(1);
 });

Opsi untuk satu hub mengesampingkan opsi global yang disediakan di AddSignalR dan dapat dikonfigurasi dengan menggunakan metode AddHubOptions:

builder.Services.AddSignalR().AddHubOptions<ChatHub>(options =>
{
    options.EnableDetailedErrors = true;
});

Mengonfigurasi opsi HTTP tingkat lanjut

Gunakan HttpConnectionDispatcherOptions untuk mengonfigurasi pengaturan tingkat lanjut yang terkait dengan transportasi dan manajemen buffer memori. Opsi ini dikonfigurasi dengan meneruskan delegat ke metode MapHub di Program.cs.

using Microsoft.AspNetCore.Http.Connections;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddSignalR();

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();
app.MapHub<ChatHub>("/chathub", options =>
{
    options.Transports =
        HttpTransportType.WebSockets |
        HttpTransportType.LongPolling;
}
);
app.Run();

Tabel berikut ini menjelaskan opsi untuk mengonfigurasi opsi HTTP tingkat lanjut ASP.NET CoreSignalR.

Opsi	Nilai standar	Deskripsi
ApplicationMaxBufferSize	64 KB	Jumlah maksimum byte yang diterima dari klien yang di-buffer server sebelum menerapkan backpressure. Meningkatkan nilai ini memungkinkan server untuk menerima pesan yang lebih besar lebih cepat tanpa menerapkan backpressure, tetapi dapat meningkatkan konsumsi memori.
TransportMaxBufferSize	64 KB	Jumlah maksimum byte yang dikirim oleh aplikasi yang di-buffer server sebelum mengamati backpressure. Meningkatkan nilai ini memungkinkan server untuk buffer pesan yang lebih besar lebih cepat tanpa menunggu backpressure, tetapi dapat meningkatkan konsumsi memori.
AuthorizationData	Data yang dikumpulkan secara otomatis dari Authorize atribut yang diterapkan ke kelas Hub.	Daftar IAuthorizeData objek yang digunakan untuk menentukan apakah klien berwenang untuk terhubung ke hub.
Transports	Semua Transportasi diaktifkan.	Bit menandai enum HttpTransportType nilai yang dapat membatasi transportasi yang dapat digunakan klien untuk menyambungkan.
LongPolling	Lihat Mengonfigurasi transportasi Long Polling	Opsi khusus untuk transportasi Long Polling.
WebSockets	Lihat Mengonfigurasi transpor WebSocket	Opsi khusus untuk transpor WebSockets.
MinimumProtocolVersion	0	Versi minimum protokol negosiasi. Nilai ini digunakan untuk membatasi klien ke versi protokol yang lebih baru.
CloseOnAuthenticationExpiration	false	Mengontrol pelacakan kedaluwarsa autentikasi, yang menutup koneksi saat token kedaluwarsa.

Mengonfigurasi transportasi Long Polling

Metode transport Long Polling memiliki opsi lain yang dapat dikonfigurasi dengan menggunakan properti LongPolling:

Opsi	Nilai standar	Deskripsi
PollTimeout	90 detik	Jumlah maksimum waktu server menunggu pesan dikirim ke klien sebelum mengakhiri satu permintaan polling. Mengurangi nilai ini menyebabkan klien lebih sering mengeluarkan permintaan polling baru.

Konfigurasikan transpor WebSocket

Transportasi WebSocket memiliki opsi lain yang dapat dikonfigurasi dengan menggunakan WebSockets properti :

Opsi	Nilai standar	Deskripsi
CloseTimeout	5 detik	Setelah server ditutup, jika klien gagal menutup dalam interval waktu ini, koneksi dihentikan.
SubProtocolSelector	null	Delegasi yang dapat digunakan untuk mengatur Sec-WebSocket-Protocol header ke nilai kustom. Delegasi menerima nilai yang diminta oleh klien sebagai input dan diharapkan mengembalikan nilai yang diinginkan.

Mengonfigurasi opsi klien

Di klien .NET dan klien JavaScript, opsi klien dikonfigurasi pada jenis HubConnectionBuilder. Di klien Java, opsi dikonfigurasi pada subkelas HttpHubConnectionBuilder, yang berisi opsi konfigurasi penyusun dan HubConnection itu sendiri.

Mengonfigurasi pengelogan

Pengelogan dikonfigurasi di klien .NET dengan menggunakan metode ConfigureLogging. Penyedia pencatatan log dan filter dapat didaftarkan dengan cara yang sama seperti yang ada di server. Untuk informasi selengkapnya, lihat dokumentasi Logging in ASP.NET Core.

Nota

Untuk mendaftarkan penyedia pengelogan, Anda harus menginstal paket yang diperlukan. Untuk informasi selengkapnya, lihat daftar lengkap penyedia pengelogan bawaan.

Misalnya, untuk mengaktifkan pengelogan Konsol, instal Microsoft.Extensions.Logging.Console paket NuGet. AddConsole Panggil metode ekstensi:

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/chathub")
    .ConfigureLogging(logging => {
        logging.SetMinimumLevel(LogLevel.Information);
        logging.AddConsole();
    })
    .Build();

Di klien JavaScript, ada metode serupa configureLogging . Berikan LogLevel nilai sebagai tingkat minimum pesan log yang akan dihasilkan. Log ditulis ke jendela konsol browser.

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub")
    .configureLogging(signalR.LogLevel.Information)
    .build();

Alih-alih LogLevel nilai, Anda juga dapat memberikan string nilai yang mewakili nama tingkat log. Pendekatan ini berguna saat mengonfigurasi pengelogan SignalR di lingkungan tempat Anda tidak memiliki akses ke LogLevel konstanta.

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub")
    .configureLogging("warn")
    .build();

Tabel berikut mencantumkan tingkat log yang tersedia. Nilai yang Anda berikan untuk configureLogging mengatur tingkat log minimum untuk pengelogan. Pesan yang dicatat pada tingkat ini, atau tingkat yang tercantum setelahnya dalam tabel, dicatat.

string	LogLevel
trace	LogLevel.Trace
debug	LogLevel.Debug
info atauinformation	LogLevel.Information
warn atauwarning	LogLevel.Warning
error	LogLevel.Error
critical	LogLevel.Critical
none	LogLevel.None

Nota

Untuk menonaktifkan pengelogan sepenuhnya, tentukan signalR.LogLevel.None dalam configureLogging metode .

Untuk informasi selengkapnya tentang pengelogan, lihat Log dan diagnostik di ASP.NET Core SignalR.

Klien SignalR Java menggunakan pustaka Simple Logging Facade for Java (SLF4J) untuk pencatatan log. Ini adalah API pengelogan tingkat tinggi yang memungkinkan pengguna pustaka untuk memilih implementasi pengelogan spesifik mereka sendiri dengan membawa dependensi pengelogan tertentu. Cuplikan kode berikut menunjukkan cara menggunakan java.util.logging dengan SignalR klien Java.

implementation 'org.slf4j:slf4j-jdk14:1.7.25'

Jika Anda tidak mengonfigurasi pengelogan dalam dependensi Anda, SLF4J memuat pencatat tanpa operasi default dengan pesan peringatan berikut:

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

Anda dapat mengabaikan pesan ini dengan aman.

Mengonfigurasi transportasi yang diizinkan

Transportasi yang digunakan oleh SignalR dapat dikonfigurasi dalam fungsi panggilan WithUrl (withUrl di JavaScript). Operasi bitwise-OR pada nilai HttpTransportType dapat digunakan untuk membatasi klien agar hanya menggunakan transport yang ditentukan. Semua transportasi diaktifkan secara default.

Misalnya, untuk menonaktifkan transportasi Server-Sent Events, tetapi izinkan WebSocket dan koneksi Long Polling:

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/chathub", HttpTransportType.WebSockets | HttpTransportType.LongPolling)
    .Build();

Di klien JavaScript, transportasi dikonfigurasi dengan mengatur transport bidang pada objek opsi yang disediakan untuk withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", { transport: signalR.HttpTransportType.WebSockets | signalR.HttpTransportType.LongPolling })
    .build();

Dalam versi klien Java ini, WebSockets adalah satu-satunya transportasi yang tersedia.

Di klien Java, transportasi dipilih dengan menggunakan metode withTransport pada HttpHubConnectionBuilder. Klien Java default menggunakan transportasi WebSockets.

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/chathub")
    .withTransport(TransportEnum.WEBSOCKETS)
    .build();

Nota

Klien Java SignalR saat ini tidak mendukung mekanisme transport cadangan.

Mengonfigurasi autentikasi pembawa

Untuk menyediakan data autentikasi bersama dengan SignalR permintaan, gunakan AccessTokenProvider opsi (accessTokenFactory di JavaScript) untuk menentukan fungsi yang mengembalikan token akses yang diinginkan. Di klien .NET, token akses ini diteruskan sebagai token "Autentikasi Pembawa" HTTP (menggunakan header Authorization dengan jenis Bearer). Di klien JavaScript, token akses digunakan sebagai token Pembawa, kecuali dalam beberapa kasus di mana API browser membatasi kemampuan untuk menerapkan header (khususnya, dalam Server-Sent permintaan Peristiwa dan WebSocket). Dalam kasus ini, token akses disediakan sebagai nilai access_tokenstring kueri .

Di klien .NET, opsi AccessTokenProvider dapat ditentukan dengan menggunakan opsi yang didelegasikan di WithUrl:

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/chathub", options => {
        options.AccessTokenProvider = async () => {
            // Get and return the access token.
        };
    })
    .Build();

Di klien JavaScript, token akses dikonfigurasi dengan mengatur accessTokenFactory bidang pada objek opsi di withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        accessTokenFactory: () => {
            // Get and return the access token.
            // This function can return a JavaScript Promise if asynchronous
            // logic is required to retrieve the access token.
        }
    })
    .build();

Di klien SignalR Java, Anda dapat mengonfigurasi token pembawa untuk digunakan untuk autentikasi dengan menyediakan penyedia token akses ke HttpHubConnectionBuilder. Gunakan withAccessTokenProvider untuk memberikan RxJavaSingle<String>. Dengan panggilan ke Single.defer, Anda dapat menulis logika untuk menghasilkan token akses untuk klien Anda.

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/chathub")
    .withAccessTokenProvider(Single.defer(() -> {
        // Your logic here.
        return Single.just("An Access Token");
    })).build();

Mengonfigurasi waktu habis dan opsi tetap aktif

Bagian ini menjelaskan opsi lain untuk mengonfigurasi batas waktu dan perilaku tetap hidup.

.NET

Opsi	Nilai standar	Deskripsi
WithServerTimeout	30 detik (30.000 milidetik)	Nilai batas waktu untuk aktivitas server, yang diatur langsung pada HubConnectionBuilder. Jika server tidak mengirim pesan dalam interval ini, klien mempertimbangkan server terputus dan memicu Closed peristiwa (onclose di JavaScript). Nilai ini harus cukup besar agar pesan ping dikirim dari server dan diterima oleh klien dalam interval waktu habis. Nilai yang disarankan adalah angka setidaknya dua kali lipat dari nilai durasi tetap hidup (WithKeepAliveInterval) server untuk memastikan waktu bagi ping untuk tiba.
HandshakeTimeout	15 detik	Nilai batas waktu untuk handshake server awal, yang tersedia pada objek HubConnection itu sendiri. Jika server tidak mengirim respons jabat tangan dalam interval ini, klien membatalkan jabat tangan dan memicu Closed peristiwa (onclose di JavaScript). Opsi ini adalah pengaturan lanjutan yang harus dimodifikasi hanya jika kesalahan batas waktu jabat tangan terjadi karena latensi jaringan yang parah. Untuk detail selengkapnya tentang proses jabat tangan, lihat SignalR Spesifikasi Protokol Hub.
WithKeepAliveInterval	15 detik	Nilai ini menentukan interval di mana klien mengirim pesan ping dan diatur langsung pada HubConnectionBuilder. Pengaturan ini memungkinkan server mendeteksi pemutusan sambungan keras, seperti ketika klien mencabut sambungan komputernya dari jaringan. Mengirim pesan apa pun dari klien mengatur ulang timer ke awal interval. Jika klien tidak mengirim pesan dalam jangka waktu ClientTimeoutInterval yang ditetapkan di server, server menganggap klien terputus.

Di klien .NET, nilai batas waktu ditentukan sebagai nilai TimeSpan.

Contoh berikut menunjukkan nilai yang menggandakan nilai default:

var builder = new HubConnectionBuilder()
    .WithUrl(Navigation.ToAbsoluteUri("/chathub"))
    .WithServerTimeout(TimeSpan.FromSeconds(60))
    .WithKeepAliveInterval(TimeSpan.FromSeconds(30))
    .Build();

builder.On<string, string>("ReceiveMessage", (user, message) => ...

await builder.StartAsync();

JavaScript

Opsi	Nilai standar	Deskripsi
withServerTimeout	30 detik (30.000 milidetik)	Nilai batas waktu untuk aktivitas server, yang diatur langsung pada HubConnectionBuilder. Jika server tidak mengirim pesan dalam interval ini, klien mempertimbangkan server terputus dan memicu onclose peristiwa. Pengaturan ini memungkinkan server mendeteksi pemutusan sambungan keras, seperti ketika klien mencabut sambungan komputernya dari jaringan. Nilai ini harus cukup besar agar pesan ping dikirim dari server dan diterima oleh klien dalam interval waktu habis. Nilai yang disarankan adalah angka setidaknya dua kali lipat dari nilai durasi tetap hidup (withKeepAliveInterval) server untuk memastikan waktu bagi ping untuk tiba.
withKeepAliveInterval	15 detik (15.000 milidetik)	Nilai ini menentukan interval di mana klien mengirim pesan ping dan diatur langsung pada HubConnectionBuilder. Pengaturan ini memungkinkan server mendeteksi pemutusan sambungan keras, seperti ketika klien mencabut sambungan komputernya dari jaringan. Mengirim pesan apa pun dari klien mengatur ulang timer ke awal interval. Jika klien tidak mengirim pesan dalam jangka waktu ClientTimeoutInterval yang ditetapkan di server, server menganggap klien terputus. Ping paling sering terjadi sesering ping server. Jika server melakukan ping setiap lima detik, menetapkan nilai yang lebih rendah dari 5000 (5 detik) ping setiap lima detik. Nilai defaultnya adalah 15 detik. Interval keep-alive harus kurang dari atau sama dengan setengah nilai yang ditetapkan untuk batas waktu server (withServerTimeout).

Contoh berikut menunjukkan nilai yang menggandakan nilai default:

var connection = new signalR.HubConnectionBuilder()
  .withUrl("/chatHub")
  .withServerTimeout(60000)
  .withKeepAliveInterval(30000)
  .build();

Jawa

Opsi	Nilai standar	Deskripsi
getServerTimeout / setServerTimeout	30 detik (30.000 milidetik)	Nilai batas waktu untuk aktivitas server. Jika server tidak mengirim pesan dalam interval ini, klien mempertimbangkan server terputus dan memicu onClose peristiwa. Nilai ini harus cukup besar agar pesan ping dikirim dari server dan diterima oleh klien dalam interval waktu habis. Nilai yang disarankan adalah angka setidaknya dua kali lipat dari nilai server KeepAliveInterval untuk memungkinkan waktu ping tiba.
withHandshakeResponseTimeout	15 detik	Nilai batas waktu untuk proses koneksi awal dengan server. Jika server tidak mengirim respons handshake dalam interval waktu ini, klien membatalkan proses handshake dan memicu peristiwa onClose. Opsi ini adalah pengaturan lanjutan yang harus dimodifikasi hanya jika kesalahan batas waktu jabat tangan terjadi karena latensi jaringan yang parah. Untuk detail selengkapnya tentang proses Jabat Tangan, lihat SignalR Spesifikasi Protokol Hub.
getKeepAliveInterval / setKeepAliveInterval	15 detik (15.000 milidetik)	Nilai ini menentukan interval di mana klien mengirim pesan ping. Mengirim pesan apa pun dari klien mengatur ulang timer ke awal interval. Jika klien tidak mengirim pesan dalam jangka waktu ClientTimeoutInterval yang ditetapkan di server, server menganggap klien terputus.

Mengonfigurasi koneksi ulang stateful

SignalR penyambungan ulang stateful mengurangi waktu henti yang dirasakan oleh klien yang mengalami gangguan sementara pada koneksi jaringan mereka, seperti saat berpindah koneksi jaringan atau mengalami hilangnya akses singkat.

Penyambungan ulang stateful menghasilkan waktu henti yang dirasakan melalui:

• Melakukan buffering data secara sementara di server dan klien.
• Mengakui pesan yang diterima (ACK-ing) oleh server dan klien.
• Mengenali kapan koneksi aktif dan memutar ulang pesan yang mungkin dikirim saat koneksi tidak berfungsi.

"Stateful reconnect" tersedia di .NET 8 atau versi yang lebih baru.

Aktifkan penyambungan ulang stateful

Anda dapat mengaktifkan penyambungan ulang stateful baik pada endpoint hub server maupun pada klien.

• Pada titik akhir hub server, perbarui konfigurasi untuk mengaktifkan AllowStatefulReconnects opsi:

  app.MapHub<MyHub>("/hubName", options =>
  {
      options.AllowStatefulReconnects = true;
  });
  

  Secara opsional, ukuran buffer maksimum dalam byte yang diizinkan oleh server dapat diatur secara global atau untuk hub tertentu dengan StatefulReconnectBufferSize opsi .

  • Atur opsi StatefulReconnectBufferSize secara global:

    builder.AddSignalR(o => o.StatefulReconnectBufferSize = 1000);
    

  • Atur StatefulReconnectBufferSize opsi untuk hub tertentu:

    builder.AddSignalR().AddHubOptions<MyHub>(o => o.StatefulReconnectBufferSize = 1000);
    

  Pengaturan StatefulReconnectBufferSize bersifat opsional dengan ukuran default 100.000 byte.

• Pada klien, perbarui kode JavaScript atau TypeScript untuk mengaktifkan withStatefulReconnect opsi:

  const builder = new signalR.HubConnectionBuilder()
      .withUrl("/hubname")
      .withStatefulReconnect({ bufferSize: 1000 });  // Optional, defaults to 100,000
  const connection = builder.build();
  

  Pengaturan bufferSize bersifat opsional dengan ukuran default 100.000 byte.

• Pada klien .NET, perbarui kode untuk mengaktifkan opsi WithStatefulReconnect:

  var builder = new HubConnectionBuilder()
      .WithUrl("<hub url>")
      .WithStatefulReconnect();
  builder.Services.Configure<HubConnectionOptions>(o => o.StatefulReconnectBufferSize = 1000);
  var hubConnection = builder.Build();
  

  Pengaturan StatefulReconnectBufferSize bersifat opsional dengan ukuran default 100.000 byte.

Konfigurasikan opsi lain

Anda dapat mengonfigurasi opsi lain dalam metode WithUrl (withUrl di JavaScript) pada HubConnectionBuilder atau pada berbagai API konfigurasi pada HttpHubConnectionBuilder di klien Java.

.NET

Opsi	Nilai standar	Deskripsi
AccessTokenProvider	null	Fungsi yang mengembalikan nilai string, yang digunakan sebagai token autentikasi Bearer dalam permintaan HTTP.
SkipNegotiation	false	Atur opsi ini ke true untuk melewati langkah negosiasi. Catatan: Opsi ini hanya tersedia ketika transportasi WebSockets adalah satu-satunya transportasi yang diaktifkan. Pengaturan tidak dapat diaktifkan saat menggunakan layanan Azure SignalR.
ClientCertificates	Kosong	Kumpulan sertifikat Keamanan Lapisan Transportasi (TLS) untuk dikirim untuk mengautentikasi permintaan.
Cookies	Kosong	Kumpulan cookie HTTP untuk dikirim dengan setiap permintaan HTTP.
Credentials	Kosong	Kredensial yang dikirim dengan setiap permintaan HTTP.
CloseTimeout	5 detik	Jumlah maksimum waktu klien menunggu setelah menutup server untuk mengakui permintaan tutup. Jika server tidak mengakui penutupan dalam waktu ini, klien akan terputus. Catatan: Pengaturan ini hanya tersedia untuk WebSocket.
Headers	Kosong	Peta header HTTP lainnya untuk dikirim dengan setiap permintaan HTTP.
HttpMessageHandlerFactory	null	Delegasi yang dapat digunakan untuk mengonfigurasi atau mengganti HttpMessageHandler yang digunakan untuk mengirim permintaan HTTP. Delegasi ini harus mengembalikan nilai non-null, dan menerima nilai default sebagai parameter. Anda dapat mengubah pengaturan pada nilai default tersebut dan mengembalikannya, atau mengembalikan instans baru HttpMessageHandler . Catatan: - Ketika Anda mengganti handler, pastikan untuk menyalin pengaturan yang ingin Anda simpan dari handler yang disediakan. Jika tidak, opsi yang dikonfigurasi (seperti Cookie dan Header) tidak berlaku untuk handler baru. - Pengaturan ini tidak digunakan untuk koneksi WebSocket.
Proxy	null	Proksi HTTP yang akan digunakan saat mengirim permintaan HTTP.
UseDefaultCredentials	false	Atur boolean ini untuk mengirim kredensial default untuk permintaan HTTP dan WebSockets. Opsi ini memungkinkan penggunaan Windows authentication.
WebSocketConfiguration	null	Delegasi yang dapat digunakan untuk mengonfigurasi lebih banyak opsi WebSocket. Menerima instans ClientWebSocketOptions yang dapat digunakan untuk mengonfigurasi opsi.
ApplicationMaxBufferSize	1 MB	Jumlah maksimum byte yang diterima dari server yang di-buffer oleh klien sebelum menerapkan backpressure. Meningkatkan nilai ini memungkinkan klien untuk menerima pesan yang lebih besar lebih cepat tanpa menerapkan backpressure, tetapi dapat meningkatkan konsumsi memori.
TransportMaxBufferSize	1 MB	Jumlah maksimum byte yang dikirim oleh aplikasi pengguna yang disimpan dalam buffer klien sebelum terjadi tekanan balik. Meningkatkan nilai ini memungkinkan klien untuk melakukan buffer pesan yang lebih besar lebih cepat tanpa menunggu hambatan aliran data, namun demikian dapat meningkatkan konsumsi memori.

Di klien .NET, opsi ini dapat dimodifikasi dalam delegasi opsi yang disediakan untuk WithUrl:

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/chathub", options => {
        options.Headers["Foo"] = "Bar";
        options.SkipNegotiation = true;
        options.Transports = HttpTransportType.WebSockets;
        options.Cookies.Add(new Cookie(/* ... */);
        options.ClientCertificates.Add(/* ... */);
    })
    .Build();

JavaScript

Opsi	Nilai standar	Deskripsi
accessTokenFactory	null	Fungsi yang mengembalikan nilai string, yang digunakan sebagai token autentikasi Bearer dalam permintaan HTTP.
transport	null	Nilai HttpTransportType yang menentukan transportasi yang akan digunakan untuk koneksi.
headers	null	Kamus header yang dikirim dengan setiap permintaan HTTP. Catatan: Mengirim header di browser tidak berfungsi untuk WebSocket atau HttpTransportType aliran.
logMessageContent	null	Atur opsi ini ke true untuk mencatat byte/karakter pesan yang dikirim dan diterima oleh klien.
skipNegotiation	false	Atur opsi ini ke true untuk melewati langkah negosiasi. Catatan: Opsi ini hanya tersedia ketika transportasi WebSockets adalah satu-satunya transportasi yang diaktifkan. Pengaturan tidak dapat diaktifkan saat menggunakan layanan Azure SignalR.
withCredentials	true	Menentukan apakah kredensial dikirim dengan permintaan CORS. Azure App Service menggunakan cookie untuk sesi lekat dan memerlukan opsi ini diaktifkan agar berfungsi dengan benar. Untuk informasi selengkapnya tentang CORS dengan SignalR, lihat pertimbangan Keamanan dalam ASP.NET Core SignalR.
timeout	100,000	Nilai batas waktu dalam milidetik untuk diterapkan ke permintaan HTTP. Catatan: Opsi ini tidak berlaku untuk permintaan polling Long Polling, EventSource, atau WebSockets.

Di Klien JavaScript, opsi ini dapat disediakan dalam objek JavaScript yang disediakan untuk withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        // "Foo: Bar" will not be sent with WebSockets or Server-Sent Events requests
        headers: { "Foo": "Bar" },
        transport: signalR.HttpTransportType.LongPolling 
    })
    .build();

Jawa

Opsi	Nilai standar	Deskripsi
withAccessTokenProvider	null	Fungsi yang mengembalikan nilai string, yang digunakan sebagai token autentikasi Bearer dalam permintaan HTTP.
shouldSkipNegotiate	false	Atur opsi ini ke true untuk melewati langkah negosiasi. Catatan: Opsi ini hanya tersedia ketika transportasi WebSockets adalah satu-satunya transportasi yang diaktifkan. Pengaturan tidak dapat diaktifkan saat menggunakan layanan Azure SignalR.
withHeader withHeaders	Kosong	Peta header HTTP lainnya untuk dikirim dengan setiap permintaan HTTP.

Di klien Java, opsi ini dapat dikonfigurasi dengan metode pada HttpHubConnectionBuilder yang dikembalikan dari HubConnectionBuilder.create("HUB URL"):

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/chathub")
        .withHeader("Foo", "Bar")
        .shouldSkipNegotiate(true)
        .withHandshakeResponseTimeout(30*1000)
        .build();

Konten terkait

• Mulai menggunakan ASP.NET Core SignalR
• Menggunakan hub di ASP.NET Core SignalR
• klien ASP.NET Core SignalR JavaScript
• klien ASP.NET Core SignalR .NET
• Gunakan MessagePack Hub Protocol di SignalR untuk ASP.NET Core
• platform yang didukung ASP.NET Core SignalR