Module S.Untyped

Instructions: Use this module in your project

In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:

Add the following to your project's dependencies/CMakeLists.txt:

Copy

DkSDKProject_DeclareAvailable(capnp
    CONSTRAINT "= 3.5.0"
    FINDLIBS capnp capnp.unix)
DkSDKProject_MakeAvailable(capnp)

Add the Findlib::capnp library to any desired targets in src/*/CMakeLists.txt:

Copy

target_link_libraries(YourPackage_YourLibraryName
     # ... existing libraries, if any ...
     Findlib::capnp)

Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

Run:
Copy
```
opam install capnp.3.5.0
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (capnp (>= 3.5.0))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "capnp" {>= "3.5.0"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the capnp library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    capnp))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    capnp))

type abstract_method_t

An untyped method. This will typically be something like 'a reader_t -> 'b StructRef.t. i.e. the result of calling an interface's method is a promise for the future result.

val abstract_method : ``('a StructStorage.reader_t, 'b)`` Service.method_t -> abstract_method_t

Cast a method to abstract_method_t. Typically this will be the identity function. This is used in the generated code to ensure that all methods have the same type for the dispatch function.

valstruct_field :'a StructRef.t ->``int-> 'b StructRef.t

struct_field t i is a reference to the struct found at pointer index i within the struct t. Used to implement the "_pipelined" accessors.

valcapability_field :'a StructRef.t ->``int-> 'b Capability.t

capability_field t i is a reference to the capability found at pointer index i within the struct t. Used to implement the "_pipelined" accessors.

class type generic_service=object...end

vallocal :generic_service -> 'a Capability.t

local service is a capability reference to a local service implemented by service#dispatch. Used by the generated functions with the same name (but a fixed type).

valget_cap :MessageSig.attachments -> Uint32.t -> 'a Capability.t

Used in the generated code to get a capability from the attachments by index.

valadd_cap :MessageSig.attachments -> 'a Capability.t -> Uint32.t

Used in the generated code to store a capability in the attachments. Returns the new index.

valclear_cap :MessageSig.attachments -> Uint32.t -> unit

Remove a capability from the attachments. Used if the interface is changed.

val unknown_interface : ``interface_id:Uint64.t -> abstract_method_t

Used to handle calls when the interface ID isn't known.

val unknown_method : ``interface_id:Uint64.t ->``method_id:int-> abstract_method_t

Used to handle calls when the method ID isn't known.

More from the DkSDK Book

1. DkSDK
1. 1. Package capnp
  1. 1. Module Capnp
    1. 1. Module Capnp.Array
      1. Module Capnp.BytesStorage
      1. Module Capnp.Codecs
      1. Module Codecs.FramedStream
        Module Codecs.FramingError
      1. Module Capnp.Message
      1. Module Message.BytesMessage
        Module BytesMessage.ListStorage
        Module BytesMessage.Message
        Module BytesMessage.Object
        Module BytesMessage.Segment
        Module BytesMessage.Slice
        Module BytesMessage.StructStorage
        Module Message.Make
        Module Make.ListStorage
        Module Make.Message
        Module Make.Object
        Module Make.Segment
        Module Make.Slice
        Module Make.StructStorage
      1. Module Capnp.MessageSig
      1. Module type MessageSig.MESSAGE
        Module type MessageSig.S
        Module type MessageSig.SEGMENT
        Module type MessageSig.SLICE
      1. Module Capnp.RPC
      1. Module RPC.MethodID
        Module type RPC.S
        ...
        Module S.Untyped
        ...
        Module RPC.None
        Module RPC.Registry
      1. Module Capnp.Runtime
      1. Module Runtime.BuilderInc
        Module BuilderInc.Make
        Module NM.Capability
        Module NM.ListStorage
        Module NM.Message
        Module NM.Object
        Module NM.Segment
        Module NM.Service
        Module NM.Slice
        Module NM.StructRef
        Module NM.StructStorage
        Module NM.Untyped
        ...
        Module Runtime.BuilderOps
        Module BuilderOps.Make
        Module ROM.ListStorage
        Module ROM.Message
        Module ROM.Object
        Module ROM.Segment
        Module ROM.Slice
        Module ROM.StructStorage
        Module RWM.Capability
        Module RWM.ListStorage
        Module RWM.Message
        Module RWM.Object
        Module RWM.Segment
        Module RWM.Service
        Module RWM.Slice
        Module RWM.StructRef
        Module RWM.StructStorage
        Module RWM.Untyped
        ...
        Module BuilderOps.StructSizes
        Module Runtime.FarPointer
        Module Runtime.FragmentBuffer
        Module Runtime.InnerArray
        Module Runtime.ListPointer
        Module Runtime.ListStorageType
        Module Runtime.OtherPointer
        Module Runtime.Packing
        Module Packing.MixedContext
        Module Runtime.Pointer
        Module Pointer.Bitfield
        Module Runtime.ReaderInc
        Module ReaderInc.Make
        Module MessageWrapper.Capability
        Module MessageWrapper.ListStorage
        Module MessageWrapper.Message
        Module MessageWrapper.Object
        Module MessageWrapper.Segment
        Module MessageWrapper.Service
        Module MessageWrapper.Slice
        Module MessageWrapper.StructRef
        Module MessageWrapper.StructStorage
        Module MessageWrapper.Untyped
        ...
        Module Runtime.StructPointer
        Module Runtime.Util
    1. Module Capnp_unix
    1. 1. Module Capnp_unix.IO
      1. Module IO.ReadContext
        Module IO.WriteContext
  1. Package cmdliner
  1. 1. Module Cmdliner
    1. 1. Module Cmdliner.Arg
      1. Module Cmdliner.Cmd
      1. Module Cmd.Env
        Module Cmd.Exit
      1. Module Cmdliner.Manpage
      1. Module Cmdliner.Term
    1. Module Cmdliner_arg
    1. Module Cmdliner_base
    1. Module Cmdliner_cline
    1. Module Cmdliner_cmd
    1. Module Cmdliner_docgen
    1. Module Cmdliner_eval
    1. Module Cmdliner_info
    1. 1. Module Cmdliner_info.Arg
      1. Module Arg.Set
      1. Module Cmdliner_info.Cmd
      1. Module Cmdliner_info.Env
      1. Module Env.Set
      1. Module Cmdliner_info.Eval
      1. Module Cmdliner_info.Exit
    1. Module Cmdliner_manpage
    1. Module Cmdliner_msg
    1. Module Cmdliner_term
    1. Module Cmdliner_term_deprecated
    1. Module Cmdliner_trie
  1. Package fmt
  1. 1. Module Fmt
    1. 1. Module Fmt.Dump
    1. Module Fmt_cli
    1. Module Fmt_tty
  1. Package logs
  1. 1. Module Logs
    1. 1. Module type Logs.LOG
      1. ...
    1. Module Logs_cli
    1. Module Logs_fmt
    1. Module Logs_lwt
    1. 1. Module type Logs_lwt.LOG
    1. Module Logs_threaded
  1. Package lwt
  1. 1. Module Lwt
    1. 1. Module Lwt.Infix
      1. Module Infix.Let_syntax
      1. Module Lwt.Let_syntax
      1. Module Let_syntax.Let_syntax
      1. Module Lwt.Syntax
    1. Module Lwt_bytes
    1. Module Lwt_condition
    1. Module Lwt_config
    1. Module Lwt_engine
    1. 1. Module Lwt_engine.Ev_backend
      1. Module Lwt_engine.Versioned
    1. Module Lwt_features
    1. Module Lwt_fmt
    1. Module Lwt_gc
    1. Module Lwt_io
    1. 1. Module Lwt_io.BE
      1. Module Lwt_io.LE
      1. Module type Lwt_io.NumberIO
      1. Module Lwt_io.Versioned
    1. Module Lwt_list
    1. Module Lwt_main
    1. 1. Module Lwt_main.Enter_iter_hooks
      1. Module Lwt_main.Exit_hooks
      1. Module Lwt_main.Leave_iter_hooks
      1. Module type Lwt_main.Hooks
    1. Module Lwt_mutex
    1. Module Lwt_mvar
    1. Module Lwt_pool
    1. Module Lwt_pqueue
    1. 1. Module Lwt_pqueue.Make
      1. Module type Lwt_pqueue.OrderedType
        Module type Lwt_pqueue.S
    1. Module Lwt_preemptive
    1. Module Lwt_process
    1. Module Lwt_result
    1. 1. Module Lwt_result.Infix
      1. Module Lwt_result.Let_syntax
      1. Module Let_syntax.Let_syntax
      1. Module Lwt_result.Syntax
    1. Module Lwt_seq
    1. Module Lwt_sequence
    1. Module Lwt_stream
    1. Module Lwt_switch
    1. Module Lwt_sys
    1. Module Lwt_throttle
    1. 1. Module Lwt_throttle.Make
      1. Module type Lwt_throttle.S
    1. Module Lwt_timeout
    1. Module Lwt_unix
    1. 1. Module Lwt_unix.IO_vectors
      1. Module Lwt_unix.LargeFile
      1. Module Lwt_unix.Versioned
  1. Package mtime
  1. 1. Module Mtime
    1. 1. Module Mtime.Span
    1. Module Mtime_clock
  1. Package ocaml
  1. 1. Module Bigarray
    1. Module Condition
    1. Module Dynlink
    1. Module Event
    1. Module Mutex
    1. Module Profiling
    1. Module Semaphore
    1. 1. Module Semaphore.Binary
      1. Module Semaphore.Counting
    1. Module Stdlib
    1. 1. Module Stdlib.Arg
      1. Module Stdlib.Array
      1. Module Stdlib.ArrayLabels
      1. Module Stdlib.Atomic
      1. Module Stdlib.Bigarray
      1. Module Bigarray.Array0
        Module Bigarray.Array1
        Module Bigarray.Array2
        Module Bigarray.Array3
        Module Bigarray.Genarray
      1. Module Stdlib.Bool
      1. Module Stdlib.Buffer
      1. Module Stdlib.Bytes
      1. Module Stdlib.BytesLabels
      1. Module Stdlib.Callback
      1. Module Stdlib.Char
      1. Module Stdlib.Complex
      1. Module Stdlib.Digest
      1. Module Stdlib.Either
      1. Module Stdlib.Ephemeron
      1. Module Ephemeron.GenHashTable
        Module GenHashTable.MakeSeeded
        Module Ephemeron.K1
        Module K1.Bucket
        Module K1.Make
        Module K1.MakeSeeded
        Module Ephemeron.K2
        Module K2.Bucket
        Module K2.Make
        Module K2.MakeSeeded
        Module Ephemeron.Kn
        Module Kn.Bucket
        Module Kn.Make
        Module Kn.MakeSeeded
        Module type Ephemeron.S
        Module type Ephemeron.SeededS
      1. Module Stdlib.Filename
      1. Module Stdlib.Float
      1. Module Float.Array
        Module Float.ArrayLabels
      1. Module Stdlib.Format
      1. Module Stdlib.Fun
      1. Module Stdlib.Gc
      1. Module Gc.Memprof
      1. Module Stdlib.Genlex
      1. Module Stdlib.Hashtbl
      1. Module Hashtbl.Make
        Module Hashtbl.MakeSeeded
        Module type Hashtbl.HashedType
        Module type Hashtbl.S
        Module type Hashtbl.SeededHashedType
        Module type Hashtbl.SeededS
      1. Module Stdlib.In_channel
      1. Module Stdlib.Int
      1. Module Stdlib.Int32
      1. Module Stdlib.Int64
      1. Module Stdlib.LargeFile
      1. Module Stdlib.Lazy
      1. Module Stdlib.Lexing
      1. Module Stdlib.List
      1. Module Stdlib.ListLabels
      1. Module Stdlib.Map
      1. Module Map.Make
        Module type Map.OrderedType
        Module type Map.S
      1. Module Stdlib.Marshal
      1. Module Stdlib.MoreLabels
      1. Module MoreLabels.Hashtbl
        Module Hashtbl.Make
        Module Hashtbl.MakeSeeded
        Module MoreLabels.Map
        Module Map.Make
        Module MoreLabels.Set
        Module Set.Make
      1. Module Stdlib.Nativeint
      1. Module Stdlib.Obj
      1. Module Obj.Closure
        Module Obj.Ephemeron
        Module Obj.Extension_constructor
      1. Module Stdlib.Oo
      1. Module Stdlib.Option
      1. Module Stdlib.Out_channel
      1. Module Stdlib.Parsing
      1. Module Stdlib.Pervasives
      1. Module Stdlib.Printexc
      1. Module Printexc.Slot
      1. Module Stdlib.Printf
      1. Module Stdlib.Queue
      1. Module Stdlib.Random
      1. Module Random.State
      1. Module Stdlib.Result
      1. Module Stdlib.Scanf
      1. Module Scanf.Scanning
      1. Module Stdlib.Seq
      1. Module Stdlib.Set
      1. Module Set.Make
        Module type Set.OrderedType
        Module type Set.S
      1. Module Stdlib.Stack
      1. Module Stdlib.StdLabels
      1. Module Stdlib.Stream
      1. Module Stdlib.String
      1. Module Stdlib.StringLabels
      1. Module Stdlib.Sys
      1. Module Sys.Immediate64
        Module Immediate64.Make
      1. Module Stdlib.Uchar
      1. Module Stdlib.Unit
      1. Module Stdlib.Weak
      1. Module Weak.Make
        Module type Weak.S
    1. Module Str
    1. Module Thread
    1. Module ThreadUnix
    1. Module Topdirs
    1. Module Unix
    1. 1. Module Unix.LargeFile
    1. Module UnixLabels
    1. 1. Module UnixLabels.LargeFile
      1. Module EndianBigstring
      1. Module EndianBigstring.BigEndian
        Module EndianBigstring.BigEndian_unsafe
        Module EndianBigstring.LittleEndian
        Module EndianBigstring.LittleEndian_unsafe
        Module type EndianBigstring.EndianBigstringSig
        Module EndianBigstring.NativeEndian
        Module EndianBigstring.NativeEndian_unsafe
      1. Module EndianBytes
      1. Module EndianBytes.BigEndian
        Module EndianBytes.BigEndian_unsafe
        Module EndianBytes.LittleEndian
        Module EndianBytes.LittleEndian_unsafe
        Module type EndianBytes.EndianBytesSig
        Module EndianBytes.NativeEndian
        Module EndianBytes.NativeEndian_unsafe
      1. Module EndianString
      1. Module EndianString.BigEndian
        Module EndianString.BigEndian_unsafe
        Module EndianString.LittleEndian
        Module EndianString.LittleEndian_unsafe
        Module type EndianString.EndianStringSig
        Module EndianString.NativeEndian
        Module EndianString.NativeEndian_unsafe
  1. Package
  1. Package result
  1. 1. Module Result
  1. Package stdint
  1. 1. Module Stdint
    1. 1. Module Stdint.Int128
      1. Module Stdint.Int16
      1. Module Stdint.Int24
      1. Module Stdint.Int32
      1. Module Stdint.Int40
      1. Module Stdint.Int48
      1. Module Stdint.Int56
      1. Module Stdint.Int64
      1. Module Stdint.Int8
      1. Module type Stdint.Int
      1. Module Stdint.Uint128
      1. Module Stdint.Uint16
      1. Module Stdint.Uint24
      1. Module Stdint.Uint32
      1. Module Stdint.Uint40
      1. Module Stdint.Uint48
      1. Module Stdint.Uint56
      1. Module Stdint.Uint64
      1. Module Stdint.Uint8