package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

A package that contains multiple base libraries used by the Octez suite

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2

sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61

sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-libs.rpc-http-server/Tezos_rpc_http_server/RPC_server/index.html

Module `Tezos_rpc_http_server.RPC_server`Source

Typed RPC services: server implementation.

Sourcetype cors = {

allowed_headers : string list;
allowed_origins : string list;

}

Sourcemodule RPC_logging : Resto_cohttp_server.Server.LOGGING

include sig ... end

Sourcemodule Media_type : sig ... end

Sourcemodule Directory : sig ... end

Sourcetype server

Source

type callback =
  Cohttp_lwt_unix.Server.conn ->
  Cohttp.Request.t ->
  Cohttp_lwt.Body.t ->
  Cohttp_lwt_unix.Server.response_action Lwt.t

Source

val init_server : 
  ?cors:Resto_cohttp.Cors.t ->
  ?agent:string ->
  ?acl:Resto_acl.Acl.t ->
  media_types:Media_type.t list ->
  unit Directory.t ->
  server

Sourceval resto_callback : server -> callback

Source

val init_and_launch : 
  ?host:string ->
  ?cors:Resto_cohttp.Cors.t ->
  ?agent:string ->
  ?acl:Resto_acl.Acl.t ->
  media_types:Media_type.t list ->
  unit Directory.t ->
  Conduit_lwt_unix.server ->
  unit Lwt.t

Sourceval set_acl : server -> Resto_acl.Acl.t -> unit

Sourceval shutdown : server -> unit Lwt.t

Sourcemodule Max_active_rpc_connections : sig ... end

Limits (or not) the number of maximum allowed RPC connections at any given time

Source

val launch : 
  ?host:string ->
  server ->
  ?conn_closed:(Cohttp_lwt_unix.Server.conn -> unit) ->
  ?callback:callback ->
  ?max_active_connections:Max_active_rpc_connections.t ->
  Conduit_lwt_unix.server ->
  unit Lwt.t

launch ?host server ?conn_closed ?callback ?max_active_connections listening_protocol starts the given resto server initiating the listening loop using the

parameter [callback]
overwrites (if given) the default handler of each resto http query will be treated by.

parameter [conn_closed]
is an optional function that is called when a connection is closed.

parameter [max_active_connections]
limits the number of active connections. When this limit is reached, the server will not process new requests until existing ones are completed. Defaults to 100.

Sourcemodule Acl : sig ... end

package octez-libs

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-libs.rpc-http-server/Tezos_rpc_http_server/RPC_server/index.html

Module Tezos_rpc_http_server.RPC_serverSource

Module `Tezos_rpc_http_server.RPC_server`Source