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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
|
<Type Name="Record" FullName="Mono.FastCgi.Record">
<TypeSignature Language="C#" Value="public struct Record" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Record extends System.ValueType" />
<AssemblyInfo>
<AssemblyName>fastcgi-mono-server2</AssemblyName>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
This struct sends and receives FastCGI records.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Record (Mono.FastCgi.Socket socket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Mono.FastCgi.Socket socket) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="socket" Type="Mono.FastCgi.Socket" />
</Parameters>
<Docs>
<param name="socket">
A <see cref="T:Mono.FastCgi.Socket" /> object to receive the record data
from.
</param>
<summary>
Constructs and initializes a new instance of <see cref="T:Mono.FastCgi.Record" /> by reading the contents from a specified
socket.
</summary>
<remarks>
To improve performance, consider using a buffer and
<see cref="T:Mono.FastCgi.Record" /> instead.
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="socket" /> is <see langword="null" />.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="socket" /> does not contain a complete
record.
</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Record (Mono.FastCgi.Socket socket, byte[] buffer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Mono.FastCgi.Socket socket, unsigned int8[] buffer) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="socket" Type="Mono.FastCgi.Socket" />
<Parameter Name="buffer" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="socket">
A <see cref="T:Mono.FastCgi.Socket" /> object to receive the record data
from.
</param>
<param name="buffer">
A <see cref="T:System.Byte[]" /> containing the buffer to use when
receiving from the socket or <see langword="null" /> to
create the buffers on the fly.
</param>
<summary>
Constructs and initializes a new instance of <see cref="T:Mono.FastCgi.Record" /> by reading the contents from a specified
socket.
</summary>
<remarks>
<para>If <paramref name="buffer" /> is not <see langword="null" />, the suggested size is <see cref="F:Mono.FastCgi.Record.SuggestedBufferSize" />. If the size of the buffer
is insufficient to read the data, a sufficiently sized
array will be created on a per-instance basis.</para>
<note type="caution">
<para>If a buffer is used, the new instance
is only valid until the same buffer is used again.
Therefore, use an extra degree of caution when using
this constructor.</para>
</note>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="socket" /> is <see langword="null" />.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="socket" /> does not contain a complete
record.
</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Record (byte version, Mono.FastCgi.RecordType type, ushort requestID, byte[] bodyData);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8 version, valuetype Mono.FastCgi.RecordType type, unsigned int16 requestID, unsigned int8[] bodyData) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="version" Type="System.Byte" />
<Parameter Name="type" Type="Mono.FastCgi.RecordType" />
<Parameter Name="requestID" Type="System.UInt16" />
<Parameter Name="bodyData" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="version">
A <see cref="T:System.Byte" /> containing the FastCGI version the
record is structured for.
</param>
<param name="type">
A <see cref="T:Mono.FastCgi.RecordType" /> containing the type of
record to create.
</param>
<param name="requestID">
A <see cref="T:System.UInt16" /> containing the ID of the request
associated with the new record.
</param>
<param name="bodyData">
A <see cref="T:System.Byte[]" /> containing the contents to use
in the new record.
</param>
<summary>
Constructs and initializes a new instance of <see cref="T:Mono.FastCgi.Record" /> populating it with a specified version,
type, ID, and body.
</summary>
<remarks>
<note type="caution">
The new instance will store a reference to <paramref name="bodyData" /> and as such be invalid when the
value changes externally.
</note>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="bodyData" /> is <see langword="null" />.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="bodyData" /> contains more than 65535
bytes and cannot be sent.
</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Record (byte version, Mono.FastCgi.RecordType type, ushort requestID, byte[] bodyData, int bodyIndex, int bodyLength);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8 version, valuetype Mono.FastCgi.RecordType type, unsigned int16 requestID, unsigned int8[] bodyData, int32 bodyIndex, int32 bodyLength) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="version" Type="System.Byte" />
<Parameter Name="type" Type="Mono.FastCgi.RecordType" />
<Parameter Name="requestID" Type="System.UInt16" />
<Parameter Name="bodyData" Type="System.Byte[]" />
<Parameter Name="bodyIndex" Type="System.Int32" />
<Parameter Name="bodyLength" Type="System.Int32" />
</Parameters>
<Docs>
<param name="version">
A <see cref="T:System.Byte" /> containing the FastCGI version the
record is structured for.
</param>
<param name="type">
A <see cref="T:Mono.FastCgi.RecordType" /> containing the type of
record to create.
</param>
<param name="requestID">
A <see cref="T:System.UInt16" /> containing the ID of the request
associated with the new record.
</param>
<param name="bodyData">
A <see cref="T:System.Byte[]" /> containing the contents to use
in the new record.
</param>
<param name="bodyIndex">
A <see cref="T:System.Int32" /> specifying the index in <paramref name="bodyData" /> at which the body begins.
</param>
<param name="bodyLength">
A <see cref="T:System.Int32" /> specifying the length of the body in
<paramref name="bodyData" /> or -1 if all remaining data
(<c><paramref name="bodyData" />.Length - <paramref name="bodyIndex" /></c>) is used.
</param>
<summary>
Constructs and initializes a new instance of <see cref="T:Mono.FastCgi.Record" /> populating it with a specified version,
type, ID, and body.
</summary>
<remarks>
<note type="caution">
The new instance will store a reference to <paramref name="bodyData" /> and as such be invalid when the
value changes externally.
</note>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="bodyData" /> is <see langword="null" />.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="bodyIndex" /> is outside of the range
of <paramref name="bodyData" />.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="bodyLength" /> contains more than 65535
bytes or is set to -1 and calculated to be greater than
65535 bytes.
</exception>
</Docs>
</Member>
<Member MemberName="BodyLength">
<MemberSignature Language="C#" Value="public ushort BodyLength { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int16 BodyLength" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the length of the body of the current instance.
</summary>
<value>
A <see cref="T:System.UInt16" /> containing the body length of the
current instance.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CopyTo">
<MemberSignature Language="C#" Value="public void CopyTo (byte[] dest, int destIndex);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyTo(unsigned int8[] dest, int32 destIndex) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dest" Type="System.Byte[]" />
<Parameter Name="destIndex" Type="System.Int32" />
</Parameters>
<Docs>
<param name="dest">
A <see cref="T:System.Byte[]" /> to copy the body to.
</param>
<param name="destIndex">
A <see cref="T:System.Int32" /> specifying at what index to start
copying.
</param>
<summary>
Copies the body to another array.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dest" /> is <see langref="null" />.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="destIndex" /> is less than zero or does
not provide enough space to copy the body.
</exception>
</Docs>
</Member>
<Member MemberName="GetBody">
<MemberSignature Language="C#" Value="public byte[] GetBody ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] GetBody() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the body data of with the current instance.
</summary>
<returns>
A new <see cref="T:System.Byte[]" /> containing the body data of
the current instance.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HeaderSize">
<MemberSignature Language="C#" Value="public const int HeaderSize = 8;" />
<MemberSignature Language="ILAsm" Value=".field public static literal int32 HeaderSize = (8)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>
The size of a FastCGI record header.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequestID">
<MemberSignature Language="C#" Value="public ushort RequestID { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int16 RequestID" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the ID of the request associated with the current
instance.
</summary>
<value>
A <see cref="T:System.Byte" /> containing the ID of the request
associated with the current instance.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Send">
<MemberSignature Language="C#" Value="public void Send (Mono.FastCgi.Socket socket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Send(class Mono.FastCgi.Socket socket) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="socket" Type="Mono.FastCgi.Socket" />
</Parameters>
<Docs>
<param name="socket">
A <see cref="T:Mono.FastCgi.Socket" /> object to send the data over.
</param>
<summary>
Sends a FastCGI record with the data from the current
instance over a given socket.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Send">
<MemberSignature Language="C#" Value="public void Send (Mono.FastCgi.Socket socket, byte[] buffer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Send(class Mono.FastCgi.Socket socket, unsigned int8[] buffer) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="socket" Type="Mono.FastCgi.Socket" />
<Parameter Name="buffer" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="socket">
A <see cref="T:Mono.FastCgi.Socket" /> object to send the data over.
</param>
<param name="buffer">
A <see cref="T:System.Byte[]" /> to write the record to or <see langword="null" /> to create a temporary buffer during
the send.
</param>
<summary>
Sends a FastCGI record with the data from the current
instance over a given socket.
</summary>
<remarks>
If <paramref name="buffer" /> is of insufficient size to
write to the buffer, a temporary buffer will be created.
</remarks>
</Docs>
</Member>
<Member MemberName="SuggestedBufferSize">
<MemberSignature Language="C#" Value="public const int SuggestedBufferSize = 65798;" />
<MemberSignature Language="ILAsm" Value=".field public static literal int32 SuggestedBufferSize = (65798)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<MemberValue>65798</MemberValue>
<Docs>
<summary>
Contains the suggested buffer size, equal to the maximum
possible size of a record.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates and returns a <see cref="T:System.String" />
representation of the current instance.
</summary>
<returns>
A <see cref="T:System.String" /> representation of the current
instance.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Mono.FastCgi.RecordType Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Mono.FastCgi.RecordType Type" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Mono.FastCgi.RecordType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the FastCGI record type of the current instance.
</summary>
<value>
A <see cref="T:System.Byte" /> containing the FastCGI record type
of the current instance.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public byte Version { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8 Version" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.8.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the FastCGI version of the current instance.
</summary>
<value>
A <see cref="T:System.Byte" /> containing the FastCGI version of
the current instance.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
|
