-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
ChannelOptions.xml
136 lines (136 loc) · 7.89 KB
/
ChannelOptions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<Type Name="ChannelOptions" FullName="System.Threading.Channels.ChannelOptions">
<TypeSignature Language="C#" Value="public abstract class ChannelOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ChannelOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Threading.Channels.ChannelOptions" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ChannelOptions" />
<TypeSignature Language="F#" Value="type ChannelOptions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ChannelOptions abstract" />
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides options that control the behavior of channel instances.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ChannelOptions ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.Channels.ChannelOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 ChannelOptions();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes an instance of the <see cref="T:System.Threading.Channels.ChannelOptions" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AllowSynchronousContinuations">
<MemberSignature Language="C#" Value="public bool AllowSynchronousContinuations { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AllowSynchronousContinuations" />
<MemberSignature Language="DocId" Value="P:System.Threading.Channels.ChannelOptions.AllowSynchronousContinuations" />
<MemberSignature Language="VB.NET" Value="Public Property AllowSynchronousContinuations As Boolean" />
<MemberSignature Language="F#" Value="member this.AllowSynchronousContinuations : bool with get, set" Usage="System.Threading.Channels.ChannelOptions.AllowSynchronousContinuations" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool AllowSynchronousContinuations { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
<see langword="true" /> if operations performed on a channel may synchronously invoke continuations subscribed to
notifications of pending async operations; <see langword="false" /> if all continuations should be invoked asynchronously.</summary>
<value>To be added.</value>
<remarks>Setting this option to <see langword="true" /> can provide measurable throughput improvements by avoiding
scheduling additional work items. However, it may come at the cost of reduced parallelism, as for example a producer
may then be the one to execute work associated with a consumer, and if not done thoughtfully, this can lead
to unexpected interactions. The default is <see langword="false" />.</remarks>
</Docs>
</Member>
<Member MemberName="SingleReader">
<MemberSignature Language="C#" Value="public bool SingleReader { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SingleReader" />
<MemberSignature Language="DocId" Value="P:System.Threading.Channels.ChannelOptions.SingleReader" />
<MemberSignature Language="VB.NET" Value="Public Property SingleReader As Boolean" />
<MemberSignature Language="F#" Value="member this.SingleReader : bool with get, set" Usage="System.Threading.Channels.ChannelOptions.SingleReader" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool SingleReader { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
<see langword="true" /> readers from the channel guarantee that there will only ever be at most one read operation at a time;
<see langword="false" /> if no such constraint is guaranteed.</summary>
<value>To be added.</value>
<remarks>If <see langword="true" />, the channel may be able to optimize certain operations based on knowing about the single-reader guarantee.
The default is <see langword="false" />.</remarks>
</Docs>
</Member>
<Member MemberName="SingleWriter">
<MemberSignature Language="C#" Value="public bool SingleWriter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SingleWriter" />
<MemberSignature Language="DocId" Value="P:System.Threading.Channels.ChannelOptions.SingleWriter" />
<MemberSignature Language="VB.NET" Value="Public Property SingleWriter As Boolean" />
<MemberSignature Language="F#" Value="member this.SingleWriter : bool with get, set" Usage="System.Threading.Channels.ChannelOptions.SingleWriter" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool SingleWriter { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Channels</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
<see langword="true" /> if writers to the channel guarantee that there will only ever be at most one write operation
at a time; <see langword="false" /> if no such constraint is guaranteed.</summary>
<value>To be added.</value>
<remarks>If <see langword="true" />, the channel may be able to optimize certain operations based on knowing about the single-writer guarantee.
The default is <see langword="false" />.</remarks>
</Docs>
</Member>
</Members>
</Type>