NamedPipeTransportOptions Class

Definition

Namespace:

Microsoft.AspNetCore.Server.Kestrel.Transport.NamedPipes

Assembly:

Microsoft.AspNetCore.Server.Kestrel.Transport.NamedPipes.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Options for named pipe based transports.

public sealed class NamedPipeTransportOptions

type NamedPipeTransportOptions = class

Public NotInheritable Class NamedPipeTransportOptions

Inheritance

Object

NamedPipeTransportOptions

Constructors

NamedPipeTransportOptions()

Properties

CreateNamedPipeServerStream	A function used to create a new NamedPipeServerStream to listen with. If not set, CreateDefaultNamedPipeServerStream(CreateNamedPipeServerStreamContext) is used.
CurrentUserOnly	Gets or sets a value that indicates that the pipe can only be connected to by a client created by the same user account. On Windows, a value of true verifies both the user account and elevation level.
ListenerQueueCount	The number of listener queues used to accept name pipe connections.
MaxReadBufferSize	Gets or sets the maximum unconsumed incoming bytes the transport will buffer. A value of null or 0 disables backpressure entirely allowing unlimited buffering. Unlimited server buffering is a security risk given untrusted clients.
MaxWriteBufferSize	Gets or sets the maximum outgoing bytes the transport will buffer before applying write backpressure. A value of null or 0 disables backpressure entirely allowing unlimited buffering. Unlimited server buffering is a security risk given untrusted clients.
PipeSecurity	Gets or sets the security information that determines the default access control and audit security for pipes.

Methods

CreateDefaultNamedPipeServerStream(CreateNamedPipeServerStreamContext)

Creates a default instance of NamedPipeServerStream for the given CreateNamedPipeServerStreamContext that can be used by a connection listener to listen for inbound requests.