Crate wasmcloud_control_interface

source ·
Expand description

Control Interface Client

This library provides a client API for consuming the wasmCloud control interface over a NATS connection. This library can be used by multiple types of tools, and is also used by the control interface capability provider and the wash CLI

Modules

Structs

  • ActorAuctionAck
    One of a potential list of responses to an actor auction
  • ActorAuctionRequest
    A request to locate suitable hosts for a given actor
  • ActorDescription
    A summary description of an actor within a host inventory
  • ActorInstance
  • Client
    Lattice control interface client
  • ClientBuilder
    A client builder that can be used to fluently provide configuration settings used to construct the control interface client
  • CtlOperationAck
    Standard response for control interface operations
  • Host
    A summary representation of a host
  • HostInventory
    Describes the known contents of a given host at the time of a query
  • LinkDefinition
    Link definition for binding actor to provider
  • ProviderAuctionAck
    One of a potential list of responses to a provider auction
  • ProviderAuctionRequest
    A request to locate a suitable host for a capability provider. The provider’s unique identity (reference + link name) is used to rule out sites on which the provider is already running.
  • ProviderDescription
    A summary description of a capability provider within a host inventory
  • RegistryCredential
  • RemoveLinkDefinitionRequest
    A request to remove a link definition and detach the relevant actor from the given provider
  • ScaleActorCommand
  • StartActorCommand
    A command sent to a specific host instructing it to start the actor indicated by the reference.
  • StartProviderCommand
    A command sent to a host requesting a capability provider be started with the given link name and optional configuration.
  • StopActorCommand
    A command sent to a host to request that instances of a given actor be terminated on that host
  • StopHostCommand
    A command sent to request that the given host purge and stop
  • StopProviderCommand
    A request to stop the given provider on the indicated host
  • UpdateActorCommand
    A command instructing a specific host to perform a live update on the indicated actor by supplying a new image reference. Note that live updates are only possible through image references

Functions

  • json_deserialize
    The standard function for de-serializing codec structs from a format suitable for message exchange between actor and host. Use of any other function to deserialize could result in breaking incompatibilities.
  • json_serialize
    The standard function for serializing codec structs into a format that can be used for message exchange between actor and host. Use of any other function to serialize could result in breaking incompatibilities.

Type Aliases