Skip to content
Sign in

mesh

v0.3.3

Mesh hub and client: join iii engines and share workers between them.

license: MITgohubmeshnetworking

Install

bash
iii trigger compose::add worker=mesh@next

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Functions18

mesh::auth

Function
Request
  • headersobjectrequired
  • ip_addressstring
  • query_paramsobject
Response
  • contextobjectrequired
    • mesh_nodestringrequired
    • session_keystringrequired
  • function_registration_prefixstringrequired
  • namespacesobjectrequired

mesh::configuration-id

Function
Request
Empty object
Response
  • idstringrequired

mesh::join::code

Function
Request
Empty object
Response
  • codestringrequired

mesh::join::cycle

Function
Request
Empty object
Response
  • codestringrequired

mesh::join::revoke

Function
Request
  • token_idstringrequired
Response
  • revokedbooleanrequired

mesh::join::token

Function
Request
  • ephemeralboolean
  • expires_in_secsinteger
  • reusableboolean
Response
  • tokenstringrequired
  • token_idstringrequired

mesh::middleware

Function
Request
  • actionobjectrequired
    • queuestring
    • typestringrequired
  • contextobjectrequired
    • mesh_nodestringrequired
    • session_keystringrequired
  • function_idstringrequired
  • namespacestringrequired
  • payloadunknownrequired
Response
Empty object

mesh::nodes::get

Function
Request
  • namestringrequired
Response
  • addressstringrequired
  • archstringrequired
  • ephemeralbooleanrequired
  • last_seenstring· date-timerequired
  • namestringrequired
  • onlinebooleanrequired
  • osstringrequired
  • pathstringrequired
  • statusunknownrequired
  • status_errorstring
  • versionstringrequired
  • workersobject[]required
    • functionsstring[]required
    • namestringrequired
    • statestringrequired

mesh::nodes::list

Function
Request
Empty object
Response
itemsobject[]
  • addressstringrequired
  • archstringrequired
  • ephemeralbooleanrequired
  • last_seenstring· date-timerequired
  • namestringrequired
  • onlinebooleanrequired
  • osstringrequired
  • pathstringrequired
  • versionstringrequired
  • workersobject[]required
    • functionsstring[]required
    • namestringrequired
    • statestringrequired

mesh::nodes::remove

Function
Request
  • namestringrequired
Response
  • codestringrequired
  • removedbooleanrequired

mesh::on-config-change

Function
Request
  • outputobjectrequired
    • idstringrequired
    • metadataobjectrequired
      • ui_formstringrequired
Response
  • okbooleanrequired

mesh::on-functions-change

Function
Request
Empty object
Response
  • okbooleanrequired

mesh::on-node-changed

Function
Request
  • atstring· date-timerequired
  • eventstringrequired
  • namestringrequired
Response
  • atstring· date-timerequired
  • eventstringrequired
  • namestringrequired

mesh::on-observer-registration

Function
Request
  • argsunknownrequired
  • contextobjectrequired
    • mesh_nodestringrequired
    • session_keystringrequired
  • filtersunknownrequired
  • function_idstringrequired
  • metadataunknown
  • namespacestringrequired
  • observer_idstringrequired
  • resolved_function_idstringrequired
  • resolved_target_function_idstringrequired
  • target_function_idstringrequired
  • target_namespacestringrequired
Response
  • argsunknownrequired
  • filtersunknown
  • function_idstringrequired
  • target_function_idstringrequired

mesh::on-status-changed

Function

Called by the mesh worker with its mesh::status answer when that answer changes.

Request
Empty object
Response
Empty object

mesh::on-tunnel-change

Function
Request
  • inputobjectrequired
    • tunnel_idstringrequired
Response
  • okbooleanrequired

mesh::status

Function
Request
Empty object
Response
  • catalog_skippedstring[]required
  • front_doorstringrequired
  • gatewaystringrequired
  • hub_addressstringrequired
  • nodesobjectrequired
    • onlineintegerrequired
    • outdatedintegerrequired
    • totalintegerrequired
  • prefixstringrequired
  • proxystringrequired
  • public_urlstringrequired
  • sharedobject[]required
    • functionsstring[]required
    • statestringrequired
    • workerstringrequired
  • tunnelobject
    • enabledbooleanrequired
    • errorstring
    • proxy_protocolstring
    • statestringrequired
    • tunnel_idstringrequired
    • urlstring
  • versionstringrequired

mesh::ui-content

Function
Request
  • pathstringrequired
Response
  • contentstringrequired
  • content_typestringrequired

Search the registry

Find workers, kits and executables, or jump to a page.