-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
ChunkedCookieHandler.xml
252 lines (245 loc) · 15.7 KB
/
ChunkedCookieHandler.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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<Type Name="ChunkedCookieHandler" FullName="System.IdentityModel.Services.ChunkedCookieHandler">
<TypeSignature Language="C#" Value="public sealed class ChunkedCookieHandler : System.IdentityModel.Services.CookieHandler" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ChunkedCookieHandler extends System.IdentityModel.Services.CookieHandler" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Services.ChunkedCookieHandler" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ChunkedCookieHandler
Inherits CookieHandler" />
<TypeSignature Language="F#" Value="type ChunkedCookieHandler = class
 inherit CookieHandler" />
<TypeSignature Language="C++ CLI" Value="public ref class ChunkedCookieHandler sealed : System::IdentityModel::Services::CookieHandler" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IdentityModel.Services.CookieHandler</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a cookie handler that writes cookie data so that cookies never exceed a set size.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Services.ChunkedCookieHandler> class presents the cookie as a logical entity, so that, in the case of cookies with a size that exceeds a specified threshold (the chunk size), a single call to the <xref:System.IdentityModel.Services.CookieHandler.Write%2A> method breaks the data into a series of actual client-side cookies, none of which exceeds the chunk size.
Cookie names are constructed based on the `name` parameter to the <xref:System.IdentityModel.Services.CookieHandler.Write%2A>, <xref:System.IdentityModel.Services.CookieHandler.Read%2A>, or <xref:System.IdentityModel.Services.CookieHandler.Delete%2A> methods. The cookie names are constructed by appending a number to the base name: name, name1, name2, and so on.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Services.ChunkedCookieHandler" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChunkedCookieHandler ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.ChunkedCookieHandler.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 ChunkedCookieHandler();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Services.ChunkedCookieHandler" /> class that uses the default chunk size.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default chunk size is specified by <xref:System.IdentityModel.Services.ChunkedCookieHandler.DefaultChunkSize>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ChunkedCookieHandler (int chunkSize);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 chunkSize) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.ChunkedCookieHandler.#ctor(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (chunkSize As Integer)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Services.ChunkedCookieHandler : int -> System.IdentityModel.Services.ChunkedCookieHandler" Usage="new System.IdentityModel.Services.ChunkedCookieHandler chunkSize" />
<MemberSignature Language="C++ CLI" Value="public:
 ChunkedCookieHandler(int chunkSize);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="chunkSize" Type="System.Int32" />
</Parameters>
<Docs>
<param name="chunkSize">The chunk size that will be used to write cookies.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Services.ChunkedCookieHandler" /> class that uses a specified chunk size.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You must be careful when adjusting the chunk size. Web browsers have different limits on the size of cookies and the number of cookies that are allowed in total and per domain. For example, the original Netscape specification specified these limits: 300 cookies total, 4096 bytes per cookie header (including metadata, not just the cookie value), and 20 cookies per domain.
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="chunkSize" />' is less than the minimum chunk size of 1000 (<see cref="F:System.IdentityModel.Services.ChunkedCookieHandler.MinimumChunkSize" />).</exception>
</Docs>
</Member>
<Member MemberName="ChunkSize">
<MemberSignature Language="C#" Value="public int ChunkSize { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ChunkSize" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Services.ChunkedCookieHandler.ChunkSize" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ChunkSize As Integer" />
<MemberSignature Language="F#" Value="member this.ChunkSize : int" Usage="System.IdentityModel.Services.ChunkedCookieHandler.ChunkSize" />
<MemberSignature Language="C++ CLI" Value="public:
 property int ChunkSize { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the chunk size used by the current instance.</summary>
<value>The chunk size, in bytes.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultChunkSize">
<MemberSignature Language="C#" Value="public const int DefaultChunkSize = 2000;" />
<MemberSignature Language="ILAsm" Value=".field public static literal int32 DefaultChunkSize = (2000)" />
<MemberSignature Language="DocId" Value="F:System.IdentityModel.Services.ChunkedCookieHandler.DefaultChunkSize" />
<MemberSignature Language="VB.NET" Value="Public Const DefaultChunkSize As Integer = 2000" />
<MemberSignature Language="F#" Value="val mutable DefaultChunkSize : int" Usage="System.IdentityModel.Services.ChunkedCookieHandler.DefaultChunkSize" />
<MemberSignature Language="C++ CLI" Value="public: int DefaultChunkSize = 2000;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<MemberValue>2000</MemberValue>
<Docs>
<summary>The default chunk size of 2000 characters.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeleteCore">
<MemberSignature Language="C#" Value="protected override void DeleteCore (string name, string path, string domain, System.Web.HttpContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void DeleteCore(string name, string path, string domain, class System.Web.HttpContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.ChunkedCookieHandler.DeleteCore(System.String,System.String,System.String,System.Web.HttpContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub DeleteCore (name As String, path As String, domain As String, context As HttpContext)" />
<MemberSignature Language="F#" Value="override this.DeleteCore : string * string * string * System.Web.HttpContext -> unit" Usage="chunkedCookieHandler.DeleteCore (name, path, domain, context)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void DeleteCore(System::String ^ name, System::String ^ path, System::String ^ domain, System::Web::HttpContext ^ context);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="path" Type="System.String" />
<Parameter Name="domain" Type="System.String" />
<Parameter Name="context" Type="System.Web.HttpContext" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="path">To be added.</param>
<param name="domain">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinimumChunkSize">
<MemberSignature Language="C#" Value="public const int MinimumChunkSize = 1000;" />
<MemberSignature Language="ILAsm" Value=".field public static literal int32 MinimumChunkSize = (1000)" />
<MemberSignature Language="DocId" Value="F:System.IdentityModel.Services.ChunkedCookieHandler.MinimumChunkSize" />
<MemberSignature Language="VB.NET" Value="Public Const MinimumChunkSize As Integer = 1000" />
<MemberSignature Language="F#" Value="val mutable MinimumChunkSize : int" Usage="System.IdentityModel.Services.ChunkedCookieHandler.MinimumChunkSize" />
<MemberSignature Language="C++ CLI" Value="public: int MinimumChunkSize = 1000;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<MemberValue>1000</MemberValue>
<Docs>
<summary>The minimum chunk size of 1000 characters.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadCore">
<MemberSignature Language="C#" Value="protected override byte[] ReadCore (string name, System.Web.HttpContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance unsigned int8[] ReadCore(string name, class System.Web.HttpContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.ChunkedCookieHandler.ReadCore(System.String,System.Web.HttpContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function ReadCore (name As String, context As HttpContext) As Byte()" />
<MemberSignature Language="F#" Value="override this.ReadCore : string * System.Web.HttpContext -> byte[]" Usage="chunkedCookieHandler.ReadCore (name, context)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override cli::array <System::Byte> ^ ReadCore(System::String ^ name, System::Web::HttpContext ^ context);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="context" Type="System.Web.HttpContext" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteCore">
<MemberSignature Language="C#" Value="protected override void WriteCore (byte[] value, string name, string path, string domain, DateTime expirationTime, bool secure, bool httpOnly, System.Web.HttpContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void WriteCore(unsigned int8[] value, string name, string path, string domain, valuetype System.DateTime expirationTime, bool secure, bool httpOnly, class System.Web.HttpContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.ChunkedCookieHandler.WriteCore(System.Byte[],System.String,System.String,System.String,System.DateTime,System.Boolean,System.Boolean,System.Web.HttpContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub WriteCore (value As Byte(), name As String, path As String, domain As String, expirationTime As DateTime, secure As Boolean, httpOnly As Boolean, context As HttpContext)" />
<MemberSignature Language="F#" Value="override this.WriteCore : byte[] * string * string * string * DateTime * bool * bool * System.Web.HttpContext -> unit" Usage="chunkedCookieHandler.WriteCore (value, name, path, domain, expirationTime, secure, httpOnly, context)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void WriteCore(cli::array <System::Byte> ^ value, System::String ^ name, System::String ^ path, System::String ^ domain, DateTime expirationTime, bool secure, bool httpOnly, System::Web::HttpContext ^ context);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Byte[]" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="path" Type="System.String" />
<Parameter Name="domain" Type="System.String" />
<Parameter Name="expirationTime" Type="System.DateTime" />
<Parameter Name="secure" Type="System.Boolean" />
<Parameter Name="httpOnly" Type="System.Boolean" />
<Parameter Name="context" Type="System.Web.HttpContext" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="name">To be added.</param>
<param name="path">To be added.</param>
<param name="domain">To be added.</param>
<param name="expirationTime">To be added.</param>
<param name="secure">To be added.</param>
<param name="httpOnly">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>