/
IAsyncState.xml
203 lines (203 loc) · 11.5 KB
/
IAsyncState.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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<Type Name="IAsyncState" FullName="Microsoft.Extensions.AsyncState.IAsyncState">
<TypeSignature Language="C#" Value="public interface IAsyncState" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IAsyncState" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AsyncState.IAsyncState" />
<TypeSignature Language="VB.NET" Value="Public Interface IAsyncState" />
<TypeSignature Language="F#" Value="type IAsyncState = interface" />
<TypeSignature Language="C++ CLI" Value="public interface class IAsyncState" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AsyncState</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Encapsulates all information within the asynchronous flow in an <see cref="T:System.Threading.AsyncLocal`1" /> variable.
Some implementations of this interface may not be thread safe.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public object? Get (Microsoft.Extensions.AsyncState.AsyncStateToken token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Get(valuetype Microsoft.Extensions.AsyncState.AsyncStateToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AsyncState.IAsyncState.Get(Microsoft.Extensions.AsyncState.AsyncStateToken)" />
<MemberSignature Language="VB.NET" Value="Public Function Get (token As AsyncStateToken) As Object" />
<MemberSignature Language="F#" Value="abstract member Get : Microsoft.Extensions.AsyncState.AsyncStateToken -> obj" Usage="iAsyncState.Get token" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Object ^ Get(Microsoft::Extensions::AsyncState::AsyncStateToken token);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AsyncState</AssemblyName>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="Microsoft.Extensions.AsyncState.AsyncStateToken" />
</Parameters>
<Docs>
<param name="token">The token representing the state to extract.</param>
<summary>
Gets the stored async context from the state.
</summary>
<returns>The asynchronous state corresponding to the token.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The context is not initialized.</exception>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public void Initialize ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Initialize() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AsyncState.IAsyncState.Initialize" />
<MemberSignature Language="VB.NET" Value="Public Sub Initialize ()" />
<MemberSignature Language="F#" Value="abstract member Initialize : unit -> unit" Usage="iAsyncState.Initialize " />
<MemberSignature Language="C++ CLI" Value="public:
 void Initialize();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AsyncState</AssemblyName>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Initializes async state in current asynchronous flow.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RegisterAsyncContext">
<MemberSignature Language="C#" Value="public Microsoft.Extensions.AsyncState.AsyncStateToken RegisterAsyncContext ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype Microsoft.Extensions.AsyncState.AsyncStateToken RegisterAsyncContext() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AsyncState.IAsyncState.RegisterAsyncContext" />
<MemberSignature Language="VB.NET" Value="Public Function RegisterAsyncContext () As AsyncStateToken" />
<MemberSignature Language="F#" Value="abstract member RegisterAsyncContext : unit -> Microsoft.Extensions.AsyncState.AsyncStateToken" Usage="iAsyncState.RegisterAsyncContext " />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::Extensions::AsyncState::AsyncStateToken RegisterAsyncContext();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AsyncState</AssemblyName>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.AsyncState.AsyncStateToken</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Registers new async context with the state.
</summary>
<returns>Token that gives access to the reserved context.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public void Reset ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Reset() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AsyncState.IAsyncState.Reset" />
<MemberSignature Language="VB.NET" Value="Public Sub Reset ()" />
<MemberSignature Language="F#" Value="abstract member Reset : unit -> unit" Usage="iAsyncState.Reset " />
<MemberSignature Language="C++ CLI" Value="public:
 void Reset();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AsyncState</AssemblyName>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Resets async state after usage.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public void Set (Microsoft.Extensions.AsyncState.AsyncStateToken token, object? value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Set(valuetype Microsoft.Extensions.AsyncState.AsyncStateToken token, object value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AsyncState.IAsyncState.Set(Microsoft.Extensions.AsyncState.AsyncStateToken,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Sub Set (token As AsyncStateToken, value As Object)" />
<MemberSignature Language="F#" Value="abstract member Set : Microsoft.Extensions.AsyncState.AsyncStateToken * obj -> unit" Usage="iAsyncState.Set (token, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Set(Microsoft::Extensions::AsyncState::AsyncStateToken token, System::Object ^ value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AsyncState</AssemblyName>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="Microsoft.Extensions.AsyncState.AsyncStateToken" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="token">The token representing the state to store.</param>
<param name="value">New state value.</param>
<summary>
Stores async context.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Context is not initialized.</exception>
</Docs>
</Member>
<Member MemberName="TryGet">
<MemberSignature Language="C#" Value="public bool TryGet (Microsoft.Extensions.AsyncState.AsyncStateToken token, out object? value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryGet(valuetype Microsoft.Extensions.AsyncState.AsyncStateToken token, [out] object& value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AsyncState.IAsyncState.TryGet(Microsoft.Extensions.AsyncState.AsyncStateToken,System.Object@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGet (token As AsyncStateToken, ByRef value As Object) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryGet : Microsoft.Extensions.AsyncState.AsyncStateToken * obj -> bool" Usage="iAsyncState.TryGet (token, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool TryGet(Microsoft::Extensions::AsyncState::AsyncStateToken token, [Runtime::InteropServices::Out] System::Object ^ % value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AsyncState</AssemblyName>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="Microsoft.Extensions.AsyncState.AsyncStateToken" />
<Parameter Name="value" Type="System.Object" RefType="out">
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.MaybeNullWhen(false)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.MaybeNullWhen(false)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="token">The token representing the state to extract.</param>
<param name="value">
Receives the value associated with the specified token, if the context is initialized;
otherwise, the default value for the type of the <paramref name="value" /> parameter.
</param>
<summary>
Tries to get the stored async context from the state.
</summary>
<returns>
<see langword="true" /> if the context is initialized; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>