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

« back to all changes in this revision

Viewing changes to src/netplex/netplex_controller.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
* 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:
1
 
(* $Id: netplex_controller.mli 893 2006-06-02 20:30:24Z gerd $ *)
 
1
(* $Id: netplex_controller.mli 1496 2010-11-27 21:49:12Z gerd $ *)
2
2
 
3
3
(** Controller *)
4
4
 
9
9
open Netplex_types
10
10
 
11
11
val create_controller : parallelizer -> controller_config -> controller
 
12
  (** Create a controller with the default event system *)
 
13
 
 
14
val create_controller_for_esys : 
 
15
      Unixqueue.event_system -> parallelizer -> controller_config -> controller
 
16
  (** Create a controller for the passed event system *)
12
17
 
13
18
val extract_config : 
14
19
  logger_factory list -> config_file -> controller_config
 
20
  (** Extracts the controller config *)
 
21
 
 
22
(** {1 Configuring the controller} 
 
23
 
 
24
    There is a [controller] section that may configure the controller:
 
25
 
 
26
    {[ netplex {
 
27
         ...
 
28
         controller {
 
29
           socket_directory = "/var/run/myapp_sockets";
 
30
           max_level = "debug";
 
31
           logging { ... };
 
32
         }
 
33
         ...
 
34
       }
 
35
    ]}
 
36
 
 
37
    The [socket_directory] overrides the location where the special
 
38
    directory with Unix Domain sockets and other runtime files is
 
39
    created.
 
40
 
 
41
    The [max_level] parameter defines the global maximum log level.
 
42
    It defaults to "info". By setting it to "debug" (as shown) debug
 
43
    logging is enabled. This parameter can be modified at runtime.
 
44
 
 
45
    The [logging] section is explained in {!Netplex_log}.
 
46
 
 
47
 *)
 
48
 
 
49
 
 
50
module Debug : sig
 
51
  val enable : bool ref
 
52
end