forked from milkyway-dev/Slot-Vikings-dev
-
Notifications
You must be signed in to change notification settings - Fork 0
/
com.Tivadar.Best.HTTP.xml
7059 lines (6903 loc) · 387 KB
/
com.Tivadar.Best.HTTP.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
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>com.Tivadar.Best.HTTP</name>
</assembly>
<members>
<member name="T:Best.HTTP.Shared.Compression.Crc.CRC32">
<summary>
Computes a CRC-32. The CRC-32 algorithm is parameterized - you
can set the polynomial and enable or disable bit
reversal. This can be used for GZIP, BZip2, or ZIP.
</summary>
<remarks>
This type is used internally by DotNetZip; it is generally not used
directly by applications wishing to create, read, or manipulate zip
archive files.
</remarks>
</member>
<member name="P:Best.HTTP.Shared.Compression.Crc.CRC32.TotalBytesRead">
<summary>
Indicates the total number of bytes applied to the CRC.
</summary>
</member>
<member name="P:Best.HTTP.Shared.Compression.Crc.CRC32.Crc32Result">
<summary>
Indicates the current CRC for all blocks slurped in.
</summary>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.GetCrc32(System.IO.Stream)">
<summary>
Returns the CRC32 for the specified stream.
</summary>
<param name="input">The stream over which to calculate the CRC32</param>
<returns>the CRC32 calculation</returns>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.GetCrc32AndCopy(System.IO.Stream,System.IO.Stream)">
<summary>
Returns the CRC32 for the specified stream, and writes the input into the
output stream.
</summary>
<param name="input">The stream over which to calculate the CRC32</param>
<param name="output">The stream into which to deflate the input</param>
<returns>the CRC32 calculation</returns>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.ComputeCrc32(System.Int32,System.Byte)">
<summary>
Get the CRC32 for the given (word,byte) combo. This is a
computation defined by PKzip for PKZIP 2.0 (weak) encryption.
</summary>
<param name="W">The word to start with.</param>
<param name="B">The byte to combine it with.</param>
<returns>The CRC-ized result.</returns>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.SlurpBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Update the value for the running CRC32 using the given block of bytes.
This is useful when using the CRC32() class in a Stream.
</summary>
<param name="block">block of bytes to slurp</param>
<param name="offset">starting point in the block</param>
<param name="count">how many bytes within the block to slurp</param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.UpdateCRC(System.Byte)">
<summary>
Process one byte in the CRC.
</summary>
<param name = "b">the byte to include into the CRC . </param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.UpdateCRC(System.Byte,System.Int32)">
<summary>
Process a run of N identical bytes into the CRC.
</summary>
<remarks>
<para>
This method serves as an optimization for updating the CRC when a
run of identical bytes is found. Rather than passing in a buffer of
length n, containing all identical bytes b, this method accepts the
byte value and the length of the (virtual) buffer - the length of
the run.
</para>
</remarks>
<param name = "b">the byte to include into the CRC. </param>
<param name = "n">the number of times that byte should be repeated. </param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.Combine(System.Int32,System.Int32)">
<summary>
Combines the given CRC32 value with the current running total.
</summary>
<remarks>
This is useful when using a divide-and-conquer approach to
calculating a CRC. Multiple threads can each calculate a
CRC32 on a segment of the data, and then combine the
individual CRC32 values at the end.
</remarks>
<param name="crc">the crc value to be combined with this one</param>
<param name="length">the length of data the CRC value was calculated on</param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.#ctor">
<summary>
Create an instance of the CRC32 class using the default settings: no
bit reversal, and a polynomial of 0xEDB88320.
</summary>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.#ctor(System.Boolean)">
<summary>
Create an instance of the CRC32 class, specifying whether to reverse
data bits or not.
</summary>
<param name='reverseBits'>
specify true if the instance should reverse data bits.
</param>
<remarks>
<para>
In the CRC-32 used by BZip2, the bits are reversed. Therefore if you
want a CRC32 with compatibility with BZip2, you should pass true
here. In the CRC-32 used by GZIP and PKZIP, the bits are not
reversed; Therefore if you want a CRC32 with compatibility with
those, you should pass false.
</para>
</remarks>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.#ctor(System.Int32,System.Boolean)">
<summary>
Create an instance of the CRC32 class, specifying the polynomial and
whether to reverse data bits or not.
</summary>
<param name='polynomial'>
The polynomial to use for the CRC, expressed in the reversed (LSB)
format: the highest ordered bit in the polynomial value is the
coefficient of the 0th power; the second-highest order bit is the
coefficient of the 1 power, and so on. Expressed this way, the
polynomial for the CRC-32C used in IEEE 802.3, is 0xEDB88320.
</param>
<param name='reverseBits'>
specify true if the instance should reverse data bits.
</param>
<remarks>
<para>
In the CRC-32 used by BZip2, the bits are reversed. Therefore if you
want a CRC32 with compatibility with BZip2, you should pass true
here for the <c>reverseBits</c> parameter. In the CRC-32 used by
GZIP and PKZIP, the bits are not reversed; Therefore if you want a
CRC32 with compatibility with those, you should pass false for the
<c>reverseBits</c> parameter.
</para>
</remarks>
</member>
<member name="M:Best.HTTP.Shared.Compression.Crc.CRC32.Reset">
<summary>
Reset the CRC-32 class - clear the CRC "remainder register."
</summary>
<remarks>
<para>
Use this when employing a single instance of this class to compute
multiple, distinct CRCs on multiple, distinct data blocks.
</para>
</remarks>
</member>
<member name="T:Best.HTTP.Shared.Compression.Zlib.DeflateStream">
<summary>
A class for compressing and decompressing streams using the Deflate algorithm.
</summary>
<remarks>
<para>
The DeflateStream is a <see
href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a <see
cref="T:System.IO.Stream"/>. It adds DEFLATE compression or decompression to any
stream.
</para>
<para>
Using this stream, applications can compress or decompress data via stream
<c>Read</c> and <c>Write</c> operations. Either compresssion or decompression
can occur through either reading or writing. The compression format used is
DEFLATE, which is documented in <see
href="http://www.ietf.org/rfc/rfc1951.txt">IETF RFC 1951</see>, "DEFLATE
Compressed Data Format Specification version 1.3.".
</para>
</remarks>
<seealso cref="T:Best.HTTP.Shared.Compression.Zlib.GZipStream" />
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode)">
<summary>
Create a DeflateStream using the specified CompressionMode.
</summary>
<remarks>
When mode is <c>CompressionMode.Compress</c>, the DeflateStream will use
the default compression level. The "captive" stream will be closed when
the DeflateStream is closed.
</remarks>
<example>
This example uses a DeflateStream to compress data from a file, and writes
the compressed data to another file.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(fileToCompress + ".deflated"))
{
using (Stream compressor = new DeflateStream(raw, CompressionMode.Compress))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(fileToCompress & ".deflated")
Using compressor As Stream = New DeflateStream(raw, CompressionMode.Compress)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the DeflateStream will compress or decompress.</param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode,Best.HTTP.Shared.Compression.Zlib.CompressionLevel)">
<summary>
Create a DeflateStream using the specified CompressionMode and the specified CompressionLevel.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Decompress</c>, the level parameter is
ignored. The "captive" stream will be closed when the DeflateStream is
closed.
</para>
</remarks>
<example>
This example uses a DeflateStream to compress data from a file, and writes
the compressed data to another file.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(fileToCompress + ".deflated"))
{
using (Stream compressor = new DeflateStream(raw,
CompressionMode.Compress,
CompressionLevel.BestCompression))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n= -1;
while (n != 0)
{
if (n > 0)
compressor.Write(buffer, 0, n);
n= input.Read(buffer, 0, buffer.Length);
}
}
}
}
</code>
<code lang="VB">
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(fileToCompress & ".deflated")
Using compressor As Stream = New DeflateStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream to be read or written while deflating or inflating.</param>
<param name="mode">Indicates whether the <c>DeflateStream</c> will compress or decompress.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode,System.Boolean)">
<summary>
Create a <c>DeflateStream</c> using the specified
<c>CompressionMode</c>, and explicitly specify whether the
stream should be left open after Deflation or Inflation.
</summary>
<remarks>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
memory stream that will be re-read after compression. Specify true for
the <paramref name="leaveOpen"/> parameter to leave the stream open.
</para>
<para>
The <c>DeflateStream</c> will use the default compression level.
</para>
<para>
See the other overloads of this constructor for example code.
</para>
</remarks>
<param name="stream">
The stream which will be read or written. This is called the
"captive" stream in other places in this documentation.
</param>
<param name="mode">
Indicates whether the <c>DeflateStream</c> will compress or decompress.
</param>
<param name="leaveOpen">true if the application would like the stream to
remain open after inflation/deflation.</param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode,Best.HTTP.Shared.Compression.Zlib.CompressionLevel,System.Boolean)">
<summary>
Create a <c>DeflateStream</c> using the specified <c>CompressionMode</c>
and the specified <c>CompressionLevel</c>, and explicitly specify whether
the stream should be left open after Deflation or Inflation.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Decompress</c>, the level parameter is ignored.
</para>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
<see cref="T:System.IO.MemoryStream"/> that will be re-read after
compression. Specify true for the <paramref name="leaveOpen"/> parameter
to leave the stream open.
</para>
</remarks>
<example>
This example shows how to use a <c>DeflateStream</c> to compress data from
a file, and store the compressed data into another file.
<code>
using (var output = System.IO.File.Create(fileToCompress + ".deflated"))
{
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (Stream compressor = new DeflateStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, true))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n= -1;
while (n != 0)
{
if (n > 0)
compressor.Write(buffer, 0, n);
n= input.Read(buffer, 0, buffer.Length);
}
}
}
// can write additional data to the output stream here
}
</code>
<code lang="VB">
Using output As FileStream = File.Create(fileToCompress & ".deflated")
Using input As Stream = File.OpenRead(fileToCompress)
Using compressor As Stream = New DeflateStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, True)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
' can write additional data to the output stream here.
End Using
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the DeflateStream will compress or decompress.</param>
<param name="leaveOpen">true if the application would like the stream to remain open after inflation/deflation.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode,Best.HTTP.Shared.Compression.Zlib.CompressionLevel,System.Boolean,System.Int32)">
<summary>
Create a <c>DeflateStream</c> using the specified <c>CompressionMode</c>
and the specified <c>CompressionLevel</c>, and explicitly specify whether
the stream should be left open after Deflation or Inflation.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Decompress</c>, the level parameter is ignored.
</para>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
<see cref="T:System.IO.MemoryStream"/> that will be re-read after
compression. Specify true for the <paramref name="leaveOpen"/> parameter
to leave the stream open.
</para>
</remarks>
<example>
This example shows how to use a <c>DeflateStream</c> to compress data from
a file, and store the compressed data into another file.
<code>
using (var output = System.IO.File.Create(fileToCompress + ".deflated"))
{
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (Stream compressor = new DeflateStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, true))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n= -1;
while (n != 0)
{
if (n > 0)
compressor.Write(buffer, 0, n);
n= input.Read(buffer, 0, buffer.Length);
}
}
}
// can write additional data to the output stream here
}
</code>
<code lang="VB">
Using output As FileStream = File.Create(fileToCompress & ".deflated")
Using input As Stream = File.OpenRead(fileToCompress)
Using compressor As Stream = New DeflateStream(output, CompressionMode.Compress, CompressionLevel.BestCompression, True)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
' can write additional data to the output stream here.
End Using
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the DeflateStream will compress or decompress.</param>
<param name="leaveOpen">true if the application would like the stream to remain open after inflation/deflation.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
<param name="windowBits">Desired window bits.</param>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.FlushMode">
<summary>
This property sets the flush behavior on the stream.
</summary>
<remarks> See the ZLIB documentation for the meaning of the flush behavior.
</remarks>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.BufferSize">
<summary>
The size of the working buffer for the compression codec.
</summary>
<remarks>
<para>
The working buffer is used for all stream operations. The default size is
1024 bytes. The minimum size is 128 bytes. You may get better performance
with a larger buffer. Then again, you might not. You would have to test
it.
</para>
<para>
Set this before the first call to <c>Read()</c> or <c>Write()</c> on the
stream. If you try to set it afterwards, it will throw.
</para>
</remarks>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.Strategy">
<summary>
The ZLIB strategy to be used during compression.
</summary>
<remarks>
By tweaking this parameter, you may be able to optimize the compression for
data with particular characteristics.
</remarks>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.TotalIn">
<summary> Returns the total number of bytes input so far.</summary>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.TotalOut">
<summary> Returns the total number of bytes output so far.</summary>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.Dispose(System.Boolean)">
<summary>
Dispose the stream.
</summary>
<remarks>
<para>
This may or may not result in a <c>Close()</c> call on the captive
stream. See the constructors that have a <c>leaveOpen</c> parameter
for more information.
</para>
<para>
Application code won't call this code directly. This method may be
invoked in two distinct scenarios. If disposing == true, the method
has been called directly or indirectly by a user's code, for example
via the public Dispose() method. In this case, both managed and
unmanaged resources can be referenced and disposed. If disposing ==
false, the method has been called by the runtime from inside the
object finalizer and this method should not reference other objects;
in that case only unmanaged resources must be referenced or
disposed.
</para>
</remarks>
<param name="disposing">
true if the Dispose method was invoked by user code.
</param>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.CanRead">
<summary>
Indicates whether the stream can be read.
</summary>
<remarks>
The return value depends on whether the captive stream supports reading.
</remarks>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.CanSeek">
<summary>
Indicates whether the stream supports Seek operations.
</summary>
<remarks>
Always returns false.
</remarks>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.CanWrite">
<summary>
Indicates whether the stream can be written.
</summary>
<remarks>
The return value depends on whether the captive stream supports writing.
</remarks>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.Flush">
<summary>
Flush the stream.
</summary>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.Length">
<summary>
Reading this property always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.DeflateStream.Position">
<summary>
The position of the stream pointer.
</summary>
<remarks>
Setting this property always throws a <see
cref="T:System.NotImplementedException"/>. Reading will return the total bytes
written out, if used in writing, or the total bytes read in, if used in
reading. The count may refer to compressed bytes or uncompressed bytes,
depending on how you've used the stream.
</remarks>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read data from the stream.
</summary>
<remarks>
<para>
If you wish to use the <c>DeflateStream</c> to compress data while
reading, you can create a <c>DeflateStream</c> with
<c>CompressionMode.Compress</c>, providing an uncompressed data stream.
Then call Read() on that <c>DeflateStream</c>, and the data read will be
compressed as you read. If you wish to use the <c>DeflateStream</c> to
decompress data while reading, you can create a <c>DeflateStream</c> with
<c>CompressionMode.Decompress</c>, providing a readable compressed data
stream. Then call Read() on that <c>DeflateStream</c>, and the data read
will be decompressed as you read.
</para>
<para>
A <c>DeflateStream</c> can be used for <c>Read()</c> or <c>Write()</c>, but not both.
</para>
</remarks>
<param name="buffer">The buffer into which the read data should be placed.</param>
<param name="offset">the offset within that data array to put the first byte read.</param>
<param name="count">the number of bytes to read.</param>
<returns>the number of bytes actually read</returns>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
</summary>
<param name="offset">this is irrelevant, since it will always throw!</param>
<param name="origin">this is irrelevant, since it will always throw!</param>
<returns>irrelevant!</returns>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.SetLength(System.Int64)">
<summary>
Will call the base stream's SetLength method.
</summary>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.DeflateStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Write data to the stream.
</summary>
<remarks>
<para>
If you wish to use the <c>DeflateStream</c> to compress data while
writing, you can create a <c>DeflateStream</c> with
<c>CompressionMode.Compress</c>, and a writable output stream. Then call
<c>Write()</c> on that <c>DeflateStream</c>, providing uncompressed data
as input. The data sent to the output stream will be the compressed form
of the data written. If you wish to use the <c>DeflateStream</c> to
decompress data while writing, you can create a <c>DeflateStream</c> with
<c>CompressionMode.Decompress</c>, and a writable output stream. Then
call <c>Write()</c> on that stream, providing previously compressed
data. The data sent to the output stream will be the decompressed form of
the data written.
</para>
<para>
A <c>DeflateStream</c> can be used for <c>Read()</c> or <c>Write()</c>,
but not both.
</para>
</remarks>
<param name="buffer">The buffer holding data to write to the stream.</param>
<param name="offset">the offset within that data array to find the first byte to write.</param>
<param name="count">the number of bytes to write.</param>
</member>
<member name="T:Best.HTTP.Shared.Compression.Zlib.GZipStream">
<summary>
A class for compressing and decompressing GZIP streams.
</summary>
<remarks>
<para>
The <c>GZipStream</c> is a <see
href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a
<see cref="T:System.IO.Stream"/>. It adds GZIP compression or decompression to any
stream.
</para>
<para>
Like the <c>System.IO.Compression.GZipStream</c> in the .NET Base Class Library, the
<c>Ionic.Zlib.GZipStream</c> can compress while writing, or decompress while
reading, but not vice versa. The compression method used is GZIP, which is
documented in <see href="http://www.ietf.org/rfc/rfc1952.txt">IETF RFC
1952</see>, "GZIP file format specification version 4.3".</para>
<para>
A <c>GZipStream</c> can be used to decompress data (through <c>Read()</c>) or
to compress data (through <c>Write()</c>), but not both.
</para>
<para>
If you wish to use the <c>GZipStream</c> to compress data, you must wrap it
around a write-able stream. As you call <c>Write()</c> on the <c>GZipStream</c>, the
data will be compressed into the GZIP format. If you want to decompress data,
you must wrap the <c>GZipStream</c> around a readable stream that contains an
IETF RFC 1952-compliant stream. The data will be decompressed as you call
<c>Read()</c> on the <c>GZipStream</c>.
</para>
<para>
Though the GZIP format allows data from multiple files to be concatenated
together, this stream handles only a single segment of GZIP format, typically
representing a single file.
</para>
</remarks>
<seealso cref="T:Best.HTTP.Shared.Compression.Zlib.DeflateStream" />
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.GZipStream.Comment">
<summary>
The comment on the GZIP stream.
</summary>
<remarks>
<para>
The GZIP format allows for each file to optionally have an associated
comment stored with the file. The comment is encoded with the ISO-8859-1
code page. To include a comment in a GZIP stream you create, set this
property before calling <c>Write()</c> for the first time on the
<c>GZipStream</c>.
</para>
<para>
When using <c>GZipStream</c> to decompress, you can retrieve this property
after the first call to <c>Read()</c>. If no comment has been set in the
GZIP bytestream, the Comment property will return <c>null</c>
(<c>Nothing</c> in VB).
</para>
</remarks>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.GZipStream.FileName">
<summary>
The FileName for the GZIP stream.
</summary>
<remarks>
<para>
The GZIP format optionally allows each file to have an associated
filename. When compressing data (through <c>Write()</c>), set this
FileName before calling <c>Write()</c> the first time on the <c>GZipStream</c>.
The actual filename is encoded into the GZIP bytestream with the
ISO-8859-1 code page, according to RFC 1952. It is the application's
responsibility to insure that the FileName can be encoded and decoded
correctly with this code page.
</para>
<para>
When decompressing (through <c>Read()</c>), you can retrieve this value
any time after the first <c>Read()</c>. In the case where there was no filename
encoded into the GZIP bytestream, the property will return <c>null</c> (<c>Nothing</c>
in VB).
</para>
</remarks>
</member>
<member name="F:Best.HTTP.Shared.Compression.Zlib.GZipStream.LastModified">
<summary>
The last modified time for the GZIP stream.
</summary>
<remarks>
GZIP allows the storage of a last modified time with each GZIP entity.
When compressing data, you can set this before the first call to
<c>Write()</c>. When decompressing, you can retrieve this value any time
after the first call to <c>Read()</c>.
</remarks>
</member>
<member name="P:Best.HTTP.Shared.Compression.Zlib.GZipStream.Crc32">
<summary>
The CRC on the GZIP stream.
</summary>
<remarks>
This is used for internal error checking. You probably don't need to look at this property.
</remarks>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.GZipStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode)">
<summary>
Create a <c>GZipStream</c> using the specified <c>CompressionMode</c>.
</summary>
<remarks>
<para>
When mode is <c>CompressionMode.Compress</c>, the <c>GZipStream</c> will use the
default compression level.
</para>
<para>
As noted in the class documentation, the <c>CompressionMode</c> (Compress
or Decompress) also establishes the "direction" of the stream. A
<c>GZipStream</c> with <c>CompressionMode.Compress</c> works only through
<c>Write()</c>. A <c>GZipStream</c> with
<c>CompressionMode.Decompress</c> works only through <c>Read()</c>.
</para>
</remarks>
<example>
This example shows how to use a GZipStream to compress data.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(outputFile))
{
using (Stream compressor = new GZipStream(raw, CompressionMode.Compress))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Dim outputFile As String = (fileToCompress & ".compressed")
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(outputFile)
Using compressor As Stream = New GZipStream(raw, CompressionMode.Compress)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<example>
This example shows how to use a GZipStream to uncompress a file.
<code>
private void GunZipFile(string filename)
{
if (!filename.EndsWith(".gz))
throw new ArgumentException("filename");
var DecompressedFile = filename.Substring(0,filename.Length-3);
byte[] working = new byte[WORKING_BUFFER_SIZE];
int n= 1;
using (System.IO.Stream input = System.IO.File.OpenRead(filename))
{
using (Stream decompressor= new Ionic.Zlib.GZipStream(input, CompressionMode.Decompress, true))
{
using (var output = System.IO.File.Create(DecompressedFile))
{
while (n !=0)
{
n= decompressor.Read(working, 0, working.Length);
if (n > 0)
{
output.Write(working, 0, n);
}
}
}
}
}
}
</code>
<code lang="VB">
Private Sub GunZipFile(ByVal filename as String)
If Not (filename.EndsWith(".gz)) Then
Throw New ArgumentException("filename")
End If
Dim DecompressedFile as String = filename.Substring(0,filename.Length-3)
Dim working(WORKING_BUFFER_SIZE) as Byte
Dim n As Integer = 1
Using input As Stream = File.OpenRead(filename)
Using decompressor As Stream = new Ionic.Zlib.GZipStream(input, CompressionMode.Decompress, True)
Using output As Stream = File.Create(UncompressedFile)
Do
n= decompressor.Read(working, 0, working.Length)
If n > 0 Then
output.Write(working, 0, n)
End IF
Loop While (n > 0)
End Using
End Using
End Using
End Sub
</code>
</example>
<param name="stream">The stream which will be read or written.</param>
<param name="mode">Indicates whether the GZipStream will compress or decompress.</param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.GZipStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode,Best.HTTP.Shared.Compression.Zlib.CompressionLevel)">
<summary>
Create a <c>GZipStream</c> using the specified <c>CompressionMode</c> and
the specified <c>CompressionLevel</c>.
</summary>
<remarks>
<para>
The <c>CompressionMode</c> (Compress or Decompress) also establishes the
"direction" of the stream. A <c>GZipStream</c> with
<c>CompressionMode.Compress</c> works only through <c>Write()</c>. A
<c>GZipStream</c> with <c>CompressionMode.Decompress</c> works only
through <c>Read()</c>.
</para>
</remarks>
<example>
This example shows how to use a <c>GZipStream</c> to compress a file into a .gz file.
<code>
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
{
using (var raw = System.IO.File.Create(fileToCompress + ".gz"))
{
using (Stream compressor = new GZipStream(raw,
CompressionMode.Compress,
CompressionLevel.BestCompression))
{
byte[] buffer = new byte[WORKING_BUFFER_SIZE];
int n;
while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
{
compressor.Write(buffer, 0, n);
}
}
}
}
</code>
<code lang="VB">
Using input As Stream = File.OpenRead(fileToCompress)
Using raw As FileStream = File.Create(fileToCompress & ".gz")
Using compressor As Stream = New GZipStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression)
Dim buffer As Byte() = New Byte(4096) {}
Dim n As Integer = -1
Do While (n <> 0)
If (n > 0) Then
compressor.Write(buffer, 0, n)
End If
n = input.Read(buffer, 0, buffer.Length)
Loop
End Using
End Using
End Using
</code>
</example>
<param name="stream">The stream to be read or written while deflating or inflating.</param>
<param name="mode">Indicates whether the <c>GZipStream</c> will compress or decompress.</param>
<param name="level">A tuning knob to trade speed for effectiveness.</param>
</member>
<member name="M:Best.HTTP.Shared.Compression.Zlib.GZipStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode,System.Boolean)">
<summary>
Create a <c>GZipStream</c> using the specified <c>CompressionMode</c>, and
explicitly specify whether the stream should be left open after Deflation
or Inflation.
</summary>
<remarks>
<para>
This constructor allows the application to request that the captive stream
remain open after the deflation or inflation occurs. By default, after
<c>Close()</c> is called on the stream, the captive stream is also
closed. In some cases this is not desired, for example if the stream is a
memory stream that will be re-read after compressed data has been written
to it. Specify true for the <paramref name="leaveOpen"/> parameter to leave
the stream open.
</para>
<para>
The <see cref="T:Best.HTTP.Shared.Compression.Zlib.CompressionMode"/> (Compress or Decompress) also
establishes the "direction" of the stream. A <c>GZipStream</c> with
<c>CompressionMode.Compress</c> works only through <c>Write()</c>. A <c>GZipStream</c>
with <c>CompressionMode.Decompress</c> works only through <c>Read()</c>.
</para>
<para>
The <c>GZipStream</c> will use the default compression level. If you want
to specify the compression level, see <see cref="M:Best.HTTP.Shared.Compression.Zlib.GZipStream.#ctor(System.IO.Stream,Best.HTTP.Shared.Compression.Zlib.CompressionMode,Best.HTTP.Shared.Compression.Zlib.CompressionLevel,System.Boolean)"/>.
</para>
<para>
See the other overloads of this constructor for example code.
</para>
</remarks>