☰

Active module processes

This module provides predicates to create and handle active module instances. Note that each instance is associated with its own computational resources.

Active module instances run on their own fibers (optionally in a new process) for an DMod.

Documentation on exports

REGTYPEactref/1

Usage:actref(X)

X is the reference of an active module instance

    REGTYPEspawn_opt/1
    spawn_opt(X)

    Options to control the location of the fiber:

    • child: run on a new child OS process
    • daemon: run on a new daemon OS process (background processes that are their own session and group leaders, and that are dissociated from a controlling terminal)
    • (default): run on this OS process

    Options to specify the active module implementation:

    • exec(ExecPath,ExecArgs): path for executable and arguments (containing the distributed runtime)
    • dynmod(Mod): module spec (for spawning using a generic ciaosh runtime)
    • libexec: like exec/1, using binary created by actmod_compile/1 at build/libexec
    • binexec(Name): use the binary Name created at build/bin (passing --actmod argument at process startup)

    Usage:spawn_opt(X)

    X is an spawning option

      PREDICATEactmod_spawn/3

      Usage:actmod_spawn(DMod,Opts,ActRef)

      Create a new active module instance of DMod. Opts is a list of options and ActRef the active module instance reference.

      PREDICATEactmod_kill/2

      Usage:actmod_kill(ActRef,Msg)

      Sends SIGKILL signal to the active module instance ActRef. If not registered as a child process, it is considered to be a daemon. Return message in Msg.

        PREDICATEactmod_terminate/2

        Usage:actmod_terminate(ActRef,Msg)

        Sends SIGTERM signal to the active module instance ActRef. If not registered as a child process, it is considered to be a daemon. Return message in Msg.

          PREDICATEactmod_join/1

          Usage:actmod_join(ActRef)

          Block until the active module instance ActRef terminates

            PREDICATEactmod_compile_all/0

            Usage:

            Compile all imported active modules (only for libexec)

              PREDICATEactmod_compile/1

              Usage:actmod_compile(DMod)

              Ensure that the (imported) active module DMod is compiled (only for libexec)

                PREDICATEactmod_check_bin/1

                Usage:actmod_check_bin(DMod)

                Check a binary for the (imported) active module DMod exists (only for libexec)

                  PREDICATEactmod_load_dynmod/1
                  No further documentation available for this predicate.

                  Documentation on multifiles

                  PREDICATEactmod_publish.save_addr/6
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEactmod_locate.remote_address/4
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEactmod_locate.cleanup_actI/2
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEqprot.collect/3
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEqprot.dec/4
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEqprot.enc/3
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEqprot.prepare_query/4
                  No further documentation available for this predicate. The predicate is multifile.

                  PREDICATEqprot.join_answers/7
                  No further documentation available for this predicate. The predicate is multifile.

                  Documentation on imports

                  This module has the following direct dependencies:
                  Generated with LPdoc using Ciao