← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/ocsigen/oneiric

« back to all changes in this revision

Viewing changes to eliom/eliom_sessions.mli

  • Committer: Bazaar Package Importer
  • Author(s): Stephane Glondu
  • Date: 2009-07-02 10:02:08 UTC
  • mfrom: (1.1.9 upstream) (4.1.3 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090702100208-n158b1sqwzn0asil
Tags: 1.2.0-2
Fix build on non-native architectures

Show diffs side-by-side

added added

removed removed

Lines of Context:
eliom/eliom_sessions.mli
82
82
(** returns the full path of the URL using the type {!Ocsigen_extensions.url_path} *)
83
83
val get_current_full_path : sp:server_params -> url_path
84
84
 
 
85
(** returns the full path of the URL as first sent by the browser (not changed by previous extensions like rewritemod) *)
 
86
val get_original_full_path_string : sp:server_params -> string
 
87
 
 
88
(** returns the full path of the URL as first sent by the browser (not changed by previous extensions like rewritemod) *)
 
89
val get_original_full_path : sp:server_params -> url_path
 
90
 
85
91
(** returns the sub path of the URL as a string.
86
92
    The sub-path is the full path without the path of the site (set in the
87
93
    configuration file).
99
105
 *)
100
106
val get_header_hostname : sp:server_params -> string option
101
107
 
102
 
(** returns the hostname declared in the config file ([<host defaulthostname="...">]).
 
108
(** returns the hostname declared in the config file 
 
109
    ([<host defaulthostname="...">]).
 
110
 *)
 
111
val get_default_hostname : sp:server_params -> string
 
112
 
 
113
(** returns the hostname used for absolute links.
 
114
    It is either the [Host] header sent by the browser or the default hostname
 
115
    set in the configuration file, depending on server configuration
 
116
    ([<usedefaulthostname/>] option).
103
117
 *)
104
118
val get_hostname : sp:server_params -> string
105
119
 
111
125
 *)
112
126
val get_default_sslport : sp:server_params -> int
113
127
 
114
 
(** returns the port on which the request has been done. *)
 
128
(** returns the port of the server. 
 
129
    It is either the default port in the configuration file,
 
130
    or the port in the Host header of the request,
 
131
    or the port on which the request has been done.
 
132
*)
115
133
val get_server_port : sp:server_params -> int
116
134
 
117
135
(** returns true if https is used, false if http. *)
526
544
   (between [<site>] and [</site>]).
527
545
 
528
546
   {e Warning: You must call that function during the initialisation of
529
 
   your module (not during a Lwt thread or a service).
530
 
   If you use that function after,
531
 
   you must give the [~sp] parameter, otherwise it will raise the exception
532
 
   {!Eliom_common.Eliom_function_forbidden_outside_site_loading}.}
 
547
   your module (not during a Lwt thread or a service)
 
548
   otherwise it will raise the exception
 
549
   {!Eliom_common.Eliom_function_forbidden_outside_site_loading}.
 
550
   If you want to build a statically linkable module, you must call this
 
551
   function inside the initialisation function given to
 
552
   {!Eliom_services.register_eliom_module}.}
533
553
 *)
534
554
val get_config : unit -> Simplexmlparser.xml list
535
555
 
536
556
(** returns the root of the site. *)
537
557
val get_site_dir : sp:server_params -> url_path
538
558
 
539
 
(** returns the charset for this site (from the configuration file) *)
540
 
val get_config_file_charset : sp:server_params -> string
 
559
(** returns the default charset for this site *)
 
560
val get_config_default_charset : sp:server_params -> string
541
561
 
542
562
 
543
563
 
1013
1033
(** returns all the information about the request. *)
1014
1034
val get_ri : sp:server_params -> request_info
1015
1035
 
 
1036
(** returns information from the configuration files. *)
 
1037
val get_config_info : sp:server_params -> config_info
 
1038
 
 
1039
(** returns all the information about the request and config. *)
 
1040
val get_request : sp:server_params -> request
 
1041
 
1016
1042
(** returns the name of the sessions to which belongs the running service
1017
1043
    ([None] if it is not a session service)
1018
1044
 *)
1111
1137
  (server_params -> exn -> Eliom_common.result_to_send Lwt.t) -> unit
1112
1138
 
1113
1139
 
 
1140
(** Returns the http error code of the request before Eliom was called *)
 
1141
val get_previous_extension_error_code :sp:server_params -> int
 
1142
 
 
1143
 
 
1144
 
1114
1145
val sp_of_esp : Eliom_common.server_params -> server_params
1115
1146
val esp_of_sp : server_params -> Eliom_common.server_params