KestrelServerOptions 類別

定義

提供 Kestrel 特定功能的程式設計設定。

public ref class KestrelServerOptions
public class KestrelServerOptions
type KestrelServerOptions = class
Public Class KestrelServerOptions
繼承
KestrelServerOptions

建構函式

KestrelServerOptions()

提供 Kestrel 特定功能的程式設計設定。

屬性

AddServerHeader

取得或設定標頭是否 Server 應該包含在每個回應中。

AllowAlternateSchemes

取得或設定值,控制如何 :scheme 驗證 HTTP/2 和 HTTP/3 要求的欄位。

如果 false 接著 HTTP/2 和 HTTP/3 要求的 ':scheme' 欄位必須與傳輸 (完全相符,例如 TLS 連線的 HTTPs、非 TLS) 的 HTTP。 如果 true 接著 HTTP/2 和 HTTP/3 要求的 ':scheme' 欄位可以設定為替代值,這將會由 'HttpRequest.Scheme' 反映。 配置仍然必須根據 https://datatracker.ietf.org/doc/html/rfc3986/#section-3.1 有效。 只有在使用受信任的 Proxy 時,才啟用此功能。 這可用於從替代通訊協定轉換的 Proxy 等案例。 請參閱 https://datatracker.ietf.org/doc/html/rfc7540#section-8.1.2.3。 啟用此功能的應用程式應該先驗證預期的配置,再使用它。

AllowResponseHeaderCompression

取得或設定值,這個值控制是否允許動態壓縮回應標頭。 如需 HPack 動態標頭壓縮安全性考慮的詳細資訊,請造訪 https://tools.ietf.org/html/rfc7541#section-7

AllowSynchronousIO

取得或設定值,這個值控制 是否允許 Request 和 的同步 IO Response

ApplicationSchedulingMode

取得或設定值,決定 Kestrel 應該如何排程使用者回呼。

ApplicationServices

啟用接聽選項回呼,以解析和使用應用程式在啟動期間註冊的服務。 通常由 UseKestrel () 初始化。

ConfigurationLoader

提供組態來源,其中端點將從伺服器啟動時載入。 預設值為 null

DisableStringReuse

取得或設定值,這個值控制是否要在要求之間重複使用具體化的字串值;如果相符,則為 ,如果一律會重新配置字串,則為 。

EnableAltSvc
已過時。

控制是否要從 HTTP/2 或較低的 HTTP/3 回應傳回 「Alt-Svc」 標頭。

Limits

提供要求限制選項的存取權。

RequestHeaderEncodingSelector

取得或設定回呼,傳回 Encoding 以解碼指定之要求標頭名稱的值,或使用 null 預設 UTF8Encoding

ResponseHeaderEncodingSelector

取得或設定回呼,傳回 Encoding 以編碼指定回應標頭或預告片名稱的值,或使用 null 預設 ASCIIEncoding

方法

Configure()

建立設定 Kestrel 的組態載入器。

Configure(IConfiguration)

建立設定載入器來設定以 IConfiguration 作為輸入的 Kestrel。 此組態的範圍必須限定為 Kestrel 的組態區段。 呼叫 Configure(IConfiguration, Boolean) 以啟用動態端點系結更新。

Configure(IConfiguration, Boolean)

建立設定載入器來設定以 IConfiguration 作為輸入的 Kestrel。 此組態的範圍必須限定為 Kestrel 的組態區段。

ConfigureEndpointDefaults(Action<ListenOptions>)

指定要針對每個新建立的端點執行的組態動作。 再次呼叫此動作將會取代先前的動作。

ConfigureHttpsDefaults(Action<HttpsConnectionAdapterOptions>)

指定要針對每個新建立的 HTTPs 端點執行的組態動作。 再次呼叫此動作將會取代先前的動作。

Listen(EndPoint)

系結至指定的端點。

Listen(EndPoint, Action<ListenOptions>)

系結至指定的端點。 回呼會設定端點特定的設定。

Listen(IPAddress, Int32)

系結至指定的 IP 位址和埠。

Listen(IPAddress, Int32, Action<ListenOptions>)

系結至指定的 IP 位址和埠。 回呼會設定端點特定的設定。

Listen(IPEndPoint)

系結至指定的 IP 端點。

Listen(IPEndPoint, Action<ListenOptions>)

系結至指定的 IP 位址和埠。 回呼會設定端點特定的設定。

ListenAnyIP(Int32)

使用 IPv6 [::] 接聽所有 IP,如果不支援 IPv6,則接聽 IPv4 0.0.0.0。

ListenAnyIP(Int32, Action<ListenOptions>)

使用 IPv6 [::] 接聽所有 IP,如果不支援 IPv6,則接聽 IPv4 0.0.0.0。

ListenHandle(UInt64)

開啟通訊端檔案描述項。

ListenHandle(UInt64, Action<ListenOptions>)

開啟通訊端檔案描述項。 回呼會設定端點特定的設定。

ListenLocalhost(Int32)

使用指定的埠接聽 ::1 和 127.0.0.1。 此類型的端點不支援藉由指定 0 來要求動態埠。

ListenLocalhost(Int32, Action<ListenOptions>)

使用指定的埠接聽 ::1 和 127.0.0.1。 此類型的端點不支援藉由指定 0 來要求動態埠。

ListenUnixSocket(String)

系結至指定的 Unix 網域通訊端路徑。

ListenUnixSocket(String, Action<ListenOptions>)

系結至指定的 Unix 網域通訊端路徑。 指定回呼以設定端點特定的設定。

擴充方法

UseSystemd(KestrelServerOptions)

如果可用,請開啟檔案描述項 (從 systemd 通訊端型啟用邏輯初始化SD_LISTEN_FDS_START) 初始化。

UseSystemd(KestrelServerOptions, Action<ListenOptions>)

如果可用,請開啟檔案描述項 (從 systemd 通訊端型啟用邏輯初始化SD_LISTEN_FDS_START) 初始化。 指定回呼以設定端點特定的設定。

適用於