← Back to branch summary

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

« back to all changes in this revision

Viewing changes to src/netstring/netcompression.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/netstring/netcompression.mli
 
1
(* $Id: netcompression.mli 1610 2011-05-30 08:03:45Z gerd $ *)
 
2
 
 
3
(** Registry for compression algorithms *)
 
4
 
 
5
(** This registry is initially empty. The {!Netgzip} module can be used
 
6
    to register the [gzip] algorithm, just run
 
7
 
 
8
    {[ Netgzip.init() ]}
 
9
 
 
10
    to get this effect.
 
11
 *)
 
12
 
 
13
val register : iana_name:string ->
 
14
               ?encoder:(unit -> Netchannels.io_obj_channel) ->
 
15
               ?decoder:(unit -> Netchannels.io_obj_channel) ->
 
16
               unit -> unit
 
17
  (** Registers a compression algorithm. The algorithm is given as
 
18
      a pair of functions returning {!Netchannels.io_obj_channel}.
 
19
   *)
 
20
 
 
21
val lookup_encoder : iana_name:string -> unit -> Netchannels.io_obj_channel
 
22
  (** Returns the encoder, or raises [Not_found] *)
 
23
 
 
24
val lookup_decoder : iana_name:string -> unit -> Netchannels.io_obj_channel
 
25
  (** Returns the decoder, or raises [Not_found] *)
 
26
 
 
27
val all_encoders : unit -> string list
 
28
val all_decoders : unit -> string list
 
29
  (** The iana names of all encoders and decoders, resp. *)
 
30
 
 
31