← Back to branch summary

~ubuntu-branches/ubuntu/trusty/ocamlnet/trusty

« back to all changes in this revision

Viewing changes to src/netzip/netgzip.mli

  • Committer: Bazaar Package Importer
  • Author(s): Stéphane Glondu
  • Date: 2011-09-02 14:12:33 UTC
  • mfrom: (18.2.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110902141233-zbj0ygxb92u6gy4z
Tags: 3.4-1
http://bugs.debian.org/637147
* New upstream release
  - add a new NetcgiRequire directive to ease dependency management
    (Closes: #637147)
  - remove patches that were applied upstream:
    + Added-missing-shebang-lines-in-example-shell-scripts
    + Try-also-ocamlc-for-POSIX-threads

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/netzip/netgzip.mli
 
1
(* $Id: netgzip.mli 1610 2011-05-30 08:03:45Z gerd $ *)
 
2
 
 
3
(** Gzip object channels *)
 
4
 
 
5
class input_gzip : Gzip.in_channel -> Netchannels.in_obj_channel
 
6
  (** A [Gzip.in_channel] turned into a {!Netchannels.in_obj_channel} *)
 
7
 
 
8
class output_gzip : Gzip.out_channel -> Netchannels.out_obj_channel
 
9
  (** A [Gzip.out_channel] turned into a {!Netchannels.out_obj_channel} *)
 
10
 
 
11
class inflating_pipe : unit -> Netchannels.io_obj_channel
 
12
  (** An inflating (uncompressing) pipe for gzip data, to be used in filters *)
 
13
 
 
14
class deflating_pipe : ?level:int -> unit -> Netchannels.io_obj_channel
 
15
  (** A deflating (compressing) pipe for gzip data, to be used in filters *)
 
16
 
 
17
class input_inflate : 
 
18
        Netchannels.in_obj_channel -> Netchannels.in_obj_channel
 
19
  (** [let ch' = new input_inflate ch]: Reading data from [ch'] inflates
 
20
      data read from [ch]. Use this for uncompressing data while reading.
 
21
 
 
22
      Note that [ch] isn't closed when [ch'] is closed.
 
23
   *)
 
24
 
 
25
class input_deflate :
 
26
        ?level:int ->
 
27
        Netchannels.in_obj_channel -> Netchannels.in_obj_channel
 
28
  (** [let ch' = new input_deflate ch]: Reading data from [ch'] deflates
 
29
      data read from [ch]. Use this for compressing data while reading.
 
30
 
 
31
      Note that [ch] isn't closed when [ch'] is closed.
 
32
   *)
 
33
 
 
34
class output_inflate :
 
35
         Netchannels.out_obj_channel -> Netchannels.out_obj_channel
 
36
  (** [let ch' = new output_inflate ch]: Data written to [ch'] is inflated
 
37
      and written to [ch]. Use this for uncompressing data while writing.
 
38
 
 
39
      Note that [ch] isn't closed when [ch'] is closed.
 
40
   *)
 
41
 
 
42
class output_deflate :
 
43
        ?level:int ->
 
44
         Netchannels.out_obj_channel -> Netchannels.out_obj_channel
 
45
  (** [let ch' = new output_deflate ch]: Data written to [ch'] is deflated
 
46
      and written to [ch]. Use this for compressing data while writing.
 
47
 
 
48
      Note that [ch] isn't closed when [ch'] is closed.
 
49
   *)
 
50
 
 
51
val init : unit -> unit
 
52
  (** By calling this function it is enforced that the (de)-compression
 
53
      algorithms are registered at {!Netcompression}.
 
54
   *)