package async_rpc_kernel

  1. Overview
  2. Docs
package async_rpc_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Responder : sig ... end
val schedule_dispatch : Connection.t -> rpc_tag:string -> version:int -> Core_kernel.Bigstring.t -> pos:int -> len:int -> handle_response: (Core_kernel.Bigstring.t -> pos:int -> len:int -> unit Async_kernel.Deferred.t) -> handle_error:(Core_kernel.Error.t -> unit) -> [ `Flushed of unit Async_kernel.Deferred.t | `Connection_closed ]

This just schedules a write, so the Bigstring.t should not be overwritten until the flushed Deferred.t is determined.

The return value of handle_response has the same meaning as in the function argument of Implementations.Expert.create.

val dispatch : Connection.t -> rpc_tag:string -> version:int -> Core_kernel.Bigstring.t -> pos:int -> len:int -> handle_response: (Core_kernel.Bigstring.t -> pos:int -> len:int -> unit Async_kernel.Deferred.t) -> handle_error:(Core_kernel.Error.t -> unit) -> [ `Ok | `Connection_closed ]
type implementation_result =
  1. | Replied
  2. | Delayed_response of unit Async_kernel.Deferred.t

Result of callbacks passed to implement and implement':

  • Replied means that the response has already been sent using one of the functions of Responder
  • Delayed_response d means that the implementation is done using the input bigstring, but hasn't send the response yet. When d becomes determined it is expected that the response has been sent.

Note: it is NOT OK for an implementation to return:

Delayed_response (Responder.schedule responder buf ~pos:... ~len:...)

where buf is the same bigstring as the one containing the query. This is because it would indicate that buf can be overwritten even though it is still being used by Responder.schedule.

val implement : (_, _) t -> ('connection_state -> Responder.t -> Core_kernel.Bigstring.t -> pos:int -> len:int -> implementation_result Async_kernel.Deferred.t) -> 'connection_state Implementation.t
val implement' : (_, _) t -> ('connection_state -> Responder.t -> Core_kernel.Bigstring.t -> pos:int -> len:int -> implementation_result) -> 'connection_state Implementation.t
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