package octez-libs

You can search for identifiers within the package.

in-package search v0.2.0

Package contains no libraries

type t = P2p_addr.t * P2p_addr.port

type addr_port_id = {

addr : string;
(*
String representation of an address. This address can be an IPv4 or IPv6 or a domain.
*)
port : int option;
(*
If specified, a port number in 0-65535.
*)
peer_id : P2p_peer_id.t option;
(*
If specified, a peer_id. This field is given by the user to ensure the identity of the node behind the address.
*)

}

val compare : t -> t -> int

val equal : t -> t -> bool

val pp : Format.formatter -> t -> unit

val pp_opt : Format.formatter -> t option -> unit

val pp_list : Format.formatter -> t list -> unit

val of_string_exn : ?default_port:int -> string -> t

val of_string : ?default_port:int -> string -> (t, string) result

val to_string : t -> string

val encoding : t Data_encoding.t

val is_local : t -> bool

val is_global : t -> bool

val rpc_arg : t Tezos_rpc.Arg.t

type parsing_error =

| Port_not_in_range of int
| Bad_id_format of string
| Bad_format

val string_of_parsing_error : parsing_error -> string

val parse_addr_port_id : string -> (addr_port_id, parsing_error) result

parse_addr_port_id addr_port_id splits the addr_port_id into an addr, a port and an id (as a b58 hash). Both port and id are optional. This function checks that the port is between 0-65535. The character ':' separates the addr and the port while the character '#' separates the addr or the port from the id. The function assumes that addr can be either an Ipv6 address, an Ipv4 address or a domain. The address is formatted so that it can be given to Lwt_unix.getaddrinfo. This means that square brackets around ipv6 addresses are removed.

val addr_port_id_to_string : addr_port_id -> string

val addr_port_id_encoding : addr_port_id Data_encoding.t

val pp_addr_port_id : Format.formatter -> addr_port_id -> unit

val hash : t -> int