package ocsigenserver

You can search for identifiers within the package.

in-package search v0.2.0

ocsigenserver
ocsigenserver.baselib
- Dynlink_wrapper
- Ocsigen_cache
  - Dlist
  - Make
    
    A
    
    cache
- Ocsigen_config_static
- Ocsigen_lib
  - Clist
  - Filename
  - Int
  - Ip_address
  - List
  - Option
    
    Lwt
  - String
    
    Map
    
    Set
    
    Table
  - String_base
  - Tuple3
  - Url
  - Url_base
- Ocsigen_loader
- Ocsigen_stream
  - StringStream
ocsigenserver.baselib.base
- Ocsigen_lib_base
  - Clist
  - Int
  - List
  - Option
    
    Lwt
  - String_base
  - Tuple3
  - Url_base
ocsigenserver.cookies
- Ocsigen_cookie_map
  - Poly
ocsigenserver.ext.accesscontrol
- Accesscontrol
ocsigenserver.ext.authbasic
- Authbasic
ocsigenserver.ext.cors
- Cors
ocsigenserver.ext.deflatemod
- Deflatemod
ocsigenserver.ext.extendconfiguration
- Extendconfiguration
ocsigenserver.ext.outputfilter
- Outputfilter
ocsigenserver.ext.redirectmod
- Redirectmod
ocsigenserver.ext.revproxy
- Revproxy
ocsigenserver.ext.rewritemod
- Rewritemod
ocsigenserver.ext.staticmod
- Staticmod
ocsigenserver.ext.userconf
- Userconf
ocsigenserver.http
- Ocsigen_charset_mime
- Ocsigen_header
ocsigenserver.polytables
- Polytables

Legend:
Library
Module
Module type
Parameter
Class
Class type

val section : Lwt_log_core.section

use Lwt_log.Section.set_level in order to debug

val reload : ?file:string -> unit -> unit

Reload the configuration of the server. The optional parameter ?file may be used to read the configuration from another file.

val exec : Xml.xml list list -> unit

Start the server with a configuration file. Never returns.

val start : 
  ?ports:(Ocsigen_config.Socket_type.t * int) list ->
  ?ssl_ports:(Ocsigen_config.Socket_type.t * int) list ->
  ?ssl_info:Ocsigen_config.ssl_info option ->
  ?default_charset:string option ->
  ?logdir:string ->
  ?datadir:string ->
  ?uploaddir:string option ->
  ?maxuploadfilesize:int64 option ->
  ?syslog_facility:Lwt_log.syslog_facility option ->
  ?configfile:string ->
  ?usedefaulthostname:bool ->
  ?pidfile:string ->
  ?mimefile:string ->
  ?verbose:unit ->
  ?veryverbose:unit ->
  ?silent:unit ->
  ?daemon:unit ->
  ?debug:unit ->
  ?debugmode:bool ->
  ?minthreads:int ->
  ?maxthreads:int ->
  ?max_number_of_threads_queued:int ->
  ?max_number_of_connections:int ->
  ?client_timeout:int ->
  ?server_timeout:int ->
  ?shutdown_timeout:float option ->
  ?filebuffersize:int ->
  ?maxrequestbodysize:int64 option ->
  ?maxrequestbodysizeinmemory:int ->
  ?bindir:string ->
  ?extdir:string ->
  ?command_pipe:string ->
  ?disablepartialrequests:bool ->
  ?respect_pipeline:unit ->
  ?maxretries:int ->
  Ocsigen_extensions.host_config list ->
  unit

Start the server with some instructions. Never returns. It takes as main parameter a list of virtual hosts (see host below).

Options behave exactly like their <<a_manual chapter="config"|configuration file>> counterparts.

type instruction =
  Ocsigen_extensions.virtual_hosts ->
  Ocsigen_extensions.config_info ->
  Ocsigen_lib.Url.path ->
  Ocsigen_extensions.extension

The type of instructions to be used inside an host or site. Instructions are defined by extensions (Staticmod, Eliom, etc.)

val host : 
  ?regexp:string ->
  ?port:int ->
  ?default_hostname:string ->
  ?default_httpport:int ->
  ?default_httpsport:int ->
  ?default_protocol_is_https:bool ->
  ?mime_assoc:Ocsigen_charset_mime.mime_assoc ->
  ?charset_assoc:Ocsigen_charset_mime.charset_assoc ->
  ?default_directory_index:string list ->
  ?list_directory_content:bool ->
  ?follow_symlinks:[ `Always | `No | `Owner_match ] ->
  ?do_not_serve_404:Ocsigen_extensions.do_not_serve ->
  ?do_not_serve_403:Ocsigen_extensions.do_not_serve ->
  ?uploaddir:string option ->
  ?maxuploadfilesize:int64 option ->
  instruction list ->
  Ocsigen_extensions.host_config

You can define one or several virtual hosts corresponding to a given server name or port.

val site : 
  ?charset:string ->
  Ocsigen_lib.Url.path ->
  instruction list ->
  instruction

Each host may contain some sub-sites corresponding to subdirectories in the URL.