package octez-shell-libs

  1. Overview
  2. Docs
Octez shell libraries

Install 

dune-project
 Dependency

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

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-18.1.tar.gz
sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d
sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

doc/octez-shell-libs.p2p/Tezos_p2p/P2p_io_scheduler/index.html

Module Tezos_p2p.P2p_io_schedulerSource

Scheduling of I/O operations over file descriptors.

This module defines the scheduler type t, and connection type connection. A connection is a wrapper over a P2p_fd.t. R/W functions over connections behave like regular R/W over file descriptors, but the scheduler ensures of fair allocation of bandwidth between them.

To each connection is associated a read (resp. write) queue where data is copied to (resp. read from), at a rate of max_download_speed / num_connections (resp. max_upload_speed / num_connections).

Sourcetype connection

Type of a connection.

Sourcetype t

Type of an IO scheduler.

Sourceval create : ?max_upload_speed:int -> ?max_download_speed:int -> ?read_queue_size:int -> ?write_queue_size:int -> read_buffer_size:int -> unit -> t

create ~max_upload_speed ~max_download_speed ~read_queue_size ~write_queue_size () is an IO scheduler with specified (global) max upload (resp. download) speed, and specified read (resp. write) queue sizes (in bytes) for connections.

ma_state sched returns the state of the moving average worker.

Sourceval register : t -> P2p_fd.t -> connection

register sched fd is a connection managed by sched.

write conn msg returns Ok () when msg has been added to conn's write queue, or fail with an error.

write_now conn msg is true iff msg has been (immediately) added to conn's write queue, false if it has been dropped.

Returns the readable of an abstract connection

stat conn is a snapshot of current bandwidth usage for conn.

global_stat sched is a snapshot of sched's bandwidth usage (sum of stat conn for each conn in sched).

Sourceval iter_connection : t -> (connection -> unit) -> unit

iter_connection sched f applies f on each connection managed by sched.

Sourceval close : ?timeout:float -> connection -> unit Tezos_base.TzPervasives.tzresult Lwt.t

close conn returns after any pending data has been sent and the canceler of conn has been triggered.

It does not wait for the canceler callbacks, so there is no guarantee that the file descriptor is already closed, but it will eventually be closed.

If timeout is set, the canceler will be triggered after the timeout, even if pending data remains to be sent.

Sourceval shutdown : ?timeout:float -> t -> unit Lwt.t

shutdown sched returns after all connections managed by sched have been closed and sched's inner worker has successfully canceled.

Sourceval id : connection -> int

id connection returns the identifier of the underlying P2p_fd.t file descriptor. This uniquely identifies a connection.