Module `EzAPIServerUtils`Source

Sourcemodule StringMap : sig ... end

Sourcemodule Timings : sig ... end

Sourcemodule Directory : sig ... end

Sourcemodule Answer : sig ... end

Sourcemodule Req = EzAPI.Req

Sourcemodule File : sig ... end

Sourcemodule GMTime : sig ... end

Sourcemodule Ip : sig ... end

Server

Sourcetype server_kind =

| API of Directory.t
| Root of string * string option

Sourcetype server = {

server_port : int;
server_kind : server_kind;

}

Utils

Source

val return : 
  ?code:int ->
  ?headers:(string * string) list ->
  'a ->
  'a Answer.t Lwt.t

Source

val return_ok : 
  ?code:int ->
  ?headers:(string * string) list ->
  'a ->
  ('a, 'b) result Answer.t Lwt.t

Source

val return_error : 
  ?content:'a ->
  ?headers:(string * string) list ->
  int ->
  ('b, 'a option) result Answer.t Lwt.t

Sourceval verbose : int ref

Sourceval set_verbose : int -> unit

Sourceval pp_time : unit -> string

Sourceval debug : ?v:int -> ('a, unit, string, unit) format4 -> 'a

Sourceval debugf : ?v:int -> (unit -> unit) -> unit

Sourceval empty : 'a Directory.directory

Source

val register_res : 
  ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.service ->
  ('a -> 'e list -> 'b -> ('c, 'd) result Answer.t Lwt.t) ->
  Directory.t ->
  (Directory.t, Directory.Step.t list * Directory.conflict) result

Source

val register_ws_res : 
  ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.service ->
  react:('a -> 'e list -> 'b -> ('c, 'd) result Lwt.t) ->
  bg:('a -> 'e list -> (('c, 'd) result -> unit) -> unit Lwt.t) ->
  ?onclose:('a -> unit Lwt.t) ->
  ?step:float ->
  Directory.t ->
  (Directory.t, Directory.Step.t list * Directory.conflict) result

Sourceexception Conflict of Directory.Step.t list * Directory.conflict

Source

val register : 
  ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.service ->
  ('a -> 'e list -> 'b -> ('c, 'd) result Answer.t Lwt.t) ->
  Directory.t ->
  Directory.t

Source

val register_ws : 
  ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.service ->
  ?onclose:('a -> unit Lwt.t) ->
  ?step:float ->
  react:('a -> 'e list -> 'b -> ('c, 'd) result Lwt.t) ->
  bg:('a -> 'e list -> (('c, 'd) result -> unit) -> unit Lwt.t) ->
  Directory.t ->
  Directory.t

Sourcemodule Legacy : sig ... end

Source

val handle : 
  ?meth:
    [< `DELETE | `GET | `HEAD | `OPTIONS | `PATCH | `POST | `PUT GET OPTIONS ] ->
  ?content_type:string ->
  ?ws:
    (?onclose:(unit -> unit Lwt.t) ->
      ?step:float ->
      react:
        (string -> (Directory.ws_frame, Directory.handler_error) result Lwt.t) ->
      bg:
        (((Directory.ws_frame, Directory.handler_error) result -> unit) ->
          unit Lwt.t) ->
      Uuidm.t ->
      'a Lwt.t) ->
  server_kind ->
  Req.t ->
  string list ->
  string ->
  [> `http of string Answer.t | `ws of 'a ] Lwt.t

Sourceval default_access_control_headers : (string * string) list

Source

val merge_headers_with_default : 
  (string * string) list ->
  (string * string) list

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ez_api.server_utils/EzAPIServerUtils/index.html

Module `EzAPIServerUtils`Source

package ez_api

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ez_api.server_utils/EzAPIServerUtils/index.html

Module EzAPIServerUtilsSource

Module `EzAPIServerUtils`Source