On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package otr
States and types
Type definitions and predicates
type ret = [ | `Warning of string| `Received_error of string| `Received of string| `Established_encrypted_session of string| `Received_encrypted of string| `SMP_awaiting_secret| `SMP_received_question of string| `SMP_success| `SMP_failure
]Return values of functions in the Engine module.
val sexp_of_policy : policy -> Sexplib0.Sexp.tval policy_of_sexp : Sexplib0.Sexp.t -> policyval policy_to_string : policy -> stringpolicy_to_string policy is string, the string representation of the given policy.
val string_to_policy : string -> policy optionstring_to_policy string is policy, the policy matching the string (None if none matches).
val all_policies : policy listall_policies returns a list of all defined policies.
val sexp_of_version : version -> Sexplib0.Sexp.tval version_of_sexp : Sexplib0.Sexp.t -> versionval version_to_string : version -> stringversion_to_string version is string, the string representation of the version.
val string_to_version : string -> version optionstring_to_version string is version, the version matching the string (None if none matches).
val all_versions : version listall_versions returns a list of all supported versions.
OTR configuration consisting of a set of policies and versions.
val sexp_of_config : config -> Sexplib0.Sexp.tval config_of_sexp : Sexplib0.Sexp.t -> configconfig versions policies is config, the configuration with the given versions and policies.
val session_to_string : session -> stringsession_to_string session is string, the string representation of the session.
version session is version, the current active protocol version of this session.
val is_encrypted : session -> boolis_encrypted session is true if the session is established.
val their_dsa : session -> Mirage_crypto_pk.Dsa.pub optiontheir_dsa session is dsa, the public DSA key used by the communication partner (if the session is established).
val new_session : config -> Mirage_crypto_pk.Dsa.priv -> unit -> sessionnew_session configuration dsa () is session, a fresh session given the configuration and dsa private key.
On This Page