| | | 1 | | // Copyright (c) ZeroC, Inc. |
| | | 2 | | |
| | | 3 | | using System.Buffers; |
| | | 4 | | using System.IO.Pipelines; |
| | | 5 | | |
| | | 6 | | namespace IceRpc.Slice; |
| | | 7 | | |
| | | 8 | | /// <summary>Represents a property bag used to configure the encoding of payloads.</summary> |
| | | 9 | | public sealed class SliceEncodeOptions |
| | | 10 | | { |
| | | 11 | | /// <summary>Gets the default instance of <see cref="SliceEncodeOptions" />.</summary> |
| | 240 | 12 | | public static SliceEncodeOptions Default { get; } = new(); |
| | | 13 | | |
| | | 14 | | /// <summary>Gets the pipe options that the IceRPC + Slice integration uses when creating pipes. The IceRPC + Slice |
| | | 15 | | /// integration creates a pipe when encoding a request or response payload, and when encoding an async enumerable |
| | | 16 | | /// into a <see cref="PipeReader" />.</summary> |
| | 237 | 17 | | public PipeOptions PipeOptions { get; } |
| | | 18 | | |
| | | 19 | | /// <summary>Gets the stream flush threshold. When encoding a Slice stream (async enumerable), the IceRPC + Slice |
| | | 20 | | /// integration encodes the values provided by the source async enumerable into a pipe writer. The IceRPC + Slice |
| | | 21 | | /// integration flushes this pipe writer when no new value is available synchronously, or when it has written |
| | | 22 | | /// <c>StreamFlushThreshold</c> bytes to this pipe writer.</summary> |
| | 25 | 23 | | public int StreamFlushThreshold { get; } |
| | | 24 | | |
| | | 25 | | /// <summary>Constructs a new instance.</summary> |
| | | 26 | | /// <param name="pool">The pool parameter for the constructor of <see cref="System.IO.Pipelines.PipeOptions" />. |
| | | 27 | | /// </param> |
| | | 28 | | /// <param name="minimumSegmentSize">The minimum segment size for the constructor of |
| | | 29 | | /// <see cref="System.IO.Pipelines.PipeOptions" />.</param> |
| | | 30 | | /// <param name="streamFlushThreshold">The value of <see cref="StreamFlushThreshold" />. The default value (-1) is |
| | | 31 | | /// equivalent to 16 KB.</param> |
| | 3 | 32 | | public SliceEncodeOptions( |
| | 3 | 33 | | MemoryPool<byte>? pool = default, |
| | 3 | 34 | | int minimumSegmentSize = -1, |
| | 3 | 35 | | int streamFlushThreshold = -1) |
| | 3 | 36 | | { |
| | | 37 | | // We keep the default readerScheduler (ThreadPool) because pipes created from these PipeOptions are never |
| | | 38 | | // ReadAsync concurrently with a FlushAsync/Complete on the pipe writer. The writerScheduler does not matter |
| | | 39 | | // since FlushAsync never blocks. |
| | 3 | 40 | | PipeOptions = new( |
| | 3 | 41 | | pool: pool, |
| | 3 | 42 | | minimumSegmentSize: minimumSegmentSize, |
| | 3 | 43 | | pauseWriterThreshold: 0, |
| | 3 | 44 | | useSynchronizationContext: false); |
| | | 45 | | |
| | 3 | 46 | | StreamFlushThreshold = streamFlushThreshold == -1 ? 16 * 1024 : streamFlushThreshold; |
| | 3 | 47 | | } |
| | | 48 | | } |