capnp-rpc 0.3.3 · OCaml Package

The type of messages sent by this endpoint.

module QuestionId : sig ... end

module AnswerId : sig ... end

module ImportId : sig ... end

module ExportId : sig ... end

type third_party_desc = Network_types.third_party_cap_id * ExportId.t

type message_target = [

| `ReceiverAnswer of QuestionId.t * Core_types.Wire.Path.t
| `ReceiverHosted of ImportId.t

]

type desc = [

| `None
| `ReceiverAnswer of QuestionId.t * Core_types.Wire.Path.t
| `ReceiverHosted of ImportId.t
| `SenderHosted of ExportId.t
| `SenderPromise of ExportId.t
| `ThirdPartyHosted of third_party_desc

]

val pp_desc : 
  Format.formatter ->
  [< `Local of < pp : Format.formatter -> unit.. >
  | `None
  | `ReceiverAnswer of QuestionId.t * Core_types.Wire.Path.t
  | `ReceiverHosted of ImportId.t
  | `SenderHosted of ExportId.t
  | `SenderPromise of ExportId.t
  | `ThirdPartyHosted of 'a ] ->
  unit

type send_results_to = [

| `Caller
| `ThirdParty of Network_types.recipient_id
| `Yourself

]

type return = [

| `AcceptFromThirdParty
| `Cancelled
| `Exception of Exception.t
| `Results of Core_types.Wire.Response.t * desc RO_array.t
| `ResultsSentElsewhere
| `TakeFromOtherQuestion of QuestionId.t

]

type disembargo_request = [

| `Loopback of message_target * Message_types.EmbargoId.t

]

val pp_return : 
  Format.formatter ->
  [< `AcceptFromThirdParty
  | `Cancelled
  | `Exception of Exception.t
  | `Results of
    'a
    * [< `Local of < pp : Format.formatter -> unit.. >
      | `None
      | `ReceiverAnswer of QuestionId.t * Core_types.Wire.Path.t
      | `ReceiverHosted of ImportId.t
      | `SenderHosted of ExportId.t
      | `SenderPromise of ExportId.t
      | `ThirdPartyHosted of 'b ]
        RO_array.t
  | `ResultsSentElsewhere
  | `TakeFromOtherQuestion of QuestionId.t ] ->
  unit

val pp_disembargo_request : disembargo_request Fmt.t

type t = [

| `Abort of Exception.t
| `Bootstrap of QuestionId.t * string
| `Call of QuestionId.t * message_target * Core_types.Wire.Request.t * desc RO_array.t * send_results_to
| `Disembargo_reply of message_target * Message_types.EmbargoId.t
| `Disembargo_request of disembargo_request
| `Finish of QuestionId.t * bool
| `Release of ImportId.t * int
| `Resolve of ExportId.t * (desc, Exception.t) result
| `Return of AnswerId.t * return * bool

]

A message sent over the network.

val with_qid_tag : Logs.Tag.set -> t -> Logs.Tag.set

val pp_results_to : 
  Format.formatter ->
  [< `Caller | `ThirdParty of 'a | `Yourself ] ->
  unit

val pp_recv : 
  (Format.formatter -> Core_types.Wire.Request.t -> unit) ->
  t Fmt.t

package capnp-rpc