Class SliceEncodeOptions

Namespace

IceRpc.Slice

Assembly

IceRpc.Slice.dll

Represents a property bag used to configure the encoding of payloads.

public sealed class SliceEncodeOptions

Inheritance

object

SliceEncodeOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SliceEncodeOptions(MemoryPool<byte>?, int, int)

Constructs a new instance.

public SliceEncodeOptions(MemoryPool<byte>? pool = null, int minimumSegmentSize = -1, int streamFlushThreshold = -1)

Parameters

pool MemoryPool<byte>

The pool parameter for the constructor of PipeOptions.

minimumSegmentSize int

The minimum segment size for the constructor of PipeOptions.

streamFlushThreshold int

The value of StreamFlushThreshold. The default value (-1) is equivalent to 16 KB.

Properties

Default

Gets the default instance of SliceEncodeOptions.

public static SliceEncodeOptions Default { get; }

Property Value

SliceEncodeOptions

PipeOptions

Gets the pipe options that the IceRPC + Slice integration uses when creating pipes. The IceRPC + Slice integration creates a pipe when encoding a request or response payload, and when encoding an async enumerable into a PipeReader.

public PipeOptions PipeOptions { get; }

Property Value

PipeOptions

StreamFlushThreshold

Gets the stream flush threshold. When encoding a Slice stream (async enumerable), the IceRPC + Slice integration encodes the values provided by the source async enumerable into a pipe writer. The IceRPC + Slice integration flushes this pipe writer when no new value is available synchronously, or when it has written StreamFlushThreshold bytes to this pipe writer.

public int StreamFlushThreshold { get; }

Property Value

int