syndicate_utils/README.md

1.7 KiB

Syndicate utils

json_translator

Wrapper that executes a command, parses its JSON output, and sends a Preserves conversion as a message in an <recv @jsonData any> record.

json_socket_translator

Utility to communicate with sockets that send and receive lines of JSON using <send …> and <recv …> messages. Compatible with mpv, see mpv.config-example.pr.

Do not send messages immediately to the dataspace passed json_socket_translator, wait until it asserts <connected @socketPath string>.

msg

A utility that sends a message to $SYNDICATE_SOCK in the form <ARGV0 ARG1 … ARGVn>. The $SYNDICATE_STEP variables sets the SturdyRef capability with a default to the SturdyRef generated by <ref { oid: "syndicate" key: #x"" }>.

net_mapper

Publishes ICMP packet round-trip-times. See net_mapper.prs for a protocol description. Source.

Example script:

? <machine-dataspace ?machine> [
  $machine ? <rtt "10.0.33.136" ?min ?avg ?max> [
    $log ! <log "-" { ping: { min: $min avg: $avg max: $max } }>
  ]

  $config [
    <require-service <daemon net_mapper>>
    <daemon net_mapper {
      argv: ["/bin/net_mapper"]
      protocol: application/syndicate
    }>
    ? <service-object <daemon net_mapper> ?cap> [
      $cap { dataspace: $machine }
    ]
  ]
]

preserve_process_environment

This utility serializes it's process environment to Preserves and prints it to stdout. It can be used to feed the environment variables of a nested child of the Syndicate server back to the server. For example, to retreive the environmental variables that a desktop manager passed on to its children.