package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file point_reconnection_config.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
(*****************************************************************************)
(*                                                                           *)
(* Open Source License                                                       *)
(* Copyright (c) 2022 Nomadic Labs, <contact@nomadic-labs.com>               *)
(*                                                                           *)
(* Permission is hereby granted, free of charge, to any person obtaining a   *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense,  *)
(* and/or sell copies of the Software, and to permit persons to whom the     *)
(* Software is furnished to do so, subject to the following conditions:      *)
(*                                                                           *)
(* The above copyright notice and this permission notice shall be included   *)
(* in all copies or substantial portions of the Software.                    *)
(*                                                                           *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL   *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING   *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER       *)
(* DEALINGS IN THE SOFTWARE.                                                 *)
(*                                                                           *)
(*****************************************************************************)

type t = {
  factor : float;
  initial_delay : Time.System.Span.t;
  disconnection_delay : Time.System.Span.t;
  increase_cap : Time.System.Span.t;
}

let default =
  {
    factor = 1.2;
    initial_delay = Ptime.Span.of_int_s 1;
    disconnection_delay = Ptime.Span.of_int_s 60;
    increase_cap = Ptime.Span.of_int_s 172800 (* 2 days *);
  }

let encoding =
  let open Data_encoding in
  conv
    (fun {factor; initial_delay; disconnection_delay; increase_cap} ->
      (factor, initial_delay, disconnection_delay, increase_cap))
    (fun (factor, initial_delay, disconnection_delay, increase_cap) ->
      {factor; initial_delay; disconnection_delay; increase_cap})
    (obj4
       (dft
          "factor"
          ~description:
            "The factor by which the reconnection delay is increased when a \
             peer that was previously disconnected is disconnected again. This \
             value should be set to 1 for a linear back-off and to >1 for an \
             exponential back-off."
          float
          default.factor)
       (dft
          "initial-delay"
          ~description:
            "The span of time a peer is disconnected for when it is first \
             disconnected."
          Time.System.Span.encoding
          default.initial_delay)
       (dft
          "disconnection-delay"
          ~description:
            "The span of time a peer is disconnected for when it is \
             disconnected as the result of an error."
          Time.System.Span.encoding
          default.disconnection_delay)
       (dft
          "increase-cap"
          ~description:
            "The maximum amount by which the reconnection is extended. This \
             limits the rate of the exponential back-off, which eventually \
             becomes linear when it reaches this limit. This limit is set to \
             avoid reaching the End-of-Time when repeatedly reconnection a \
             peer."
          Time.System.Span.encoding
          default.increase_cap))
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct