Module holochain::conductor::api

Defines the three Conductor APIs by which other code can communicate with a Conductor:

• CellConductorApi, for Cells to communicate with their Conductor
• AppInterfaceApi, for external UIs to e.g. call zome functions on a Conductor
• AdminInterfaceApi, for external processes to e.g. modify ConductorState

Each type of API uses a ConductorHandle as its exclusive means of conductor access

Modules

• __mock_MockCellConductorApiT
• __mock_MockCellConductorApiT_CellConductorApiT
• __mock_MockCellConductorReadHandleT
• __mock_MockCellConductorReadHandleT_CellConductorReadHandleT
• conductor
  This module is used to configure the conductor
• config
• error
  Errors occurring during a CellConductorApi or InterfaceApi call
• signal_subscription
• state_dump
• storage_info

Structs

• AdminInterfaceConfig
  Information neeeded to spawn an admin interface
• AgentInfoDump
  Agent info dump with the agent, space, signed time, expires in and urls printed in a pretty way.
• AppInfo
  Info about an installed app, returned as part of AppResponse::AppInfo
• CellConductorApi
  The concrete implementation of CellConductorApiT, which is used to give Cells an API for calling back to their Conductor.
• ClonedCell
  Cloned cell that was created from a provisioned cell at runtime.
• DnaStorageInfo
  Storage info for DNA used by one or more hApps.
• FullIntegrationStateDump
  A full view of the DHT shard of the Cell. Ops start in the validation limbo then proceed to the integration limbo then finally are integrated.
• FullStateDump
• IntegrationStateDump
  A high level view of the incoming ops and where they are currently. Ops start in the validation limbo then proceed to the integration limbo then finally are integrated.
• IntegrationStateDumps
  A collection of many cells dumps for easy viewing. Use display to see a nice printout.
• JsonDump
• MockCellConductorApiT
  The “internal” Conductor API interface, for a Cell to talk to its calling Conductor.
• MockCellConductorReadHandleT
  A minimal set of functionality needed from the conductor by host functions.
• NetworkInfo
• P2pAgentsDump
  State dump of all the peer info
• ProvisionedCell
  Provisioned cell, a cell instantiated from a DNA on app installation.
• RealAdminInterfaceApi
  The admin interface that external connections can use to make requests to the conductor The concrete (non-mock) implementation of the AdminInterfaceApi
• RealAppInterfaceApi
  The Conductor lives inside an Arc<RwLock<_>> which is shared with all other Api references
• StemCell
  Cell whose instantiation has been deferred. Not yet implemented.
• StorageInfo
  Response type for storage used by holochain and applications
• ZomeCall
  The data provided over an app interface in order to make a zome call

Enums

• AdminRequest
  Represents the available conductor functions to call over an admin interface.
• AdminResponse
  Represents the possible responses to an AdminRequest and follows a general convention of noun_verb as opposed to the verb_noun of AdminRequest.
• AppInfoStatus
  A flat, slightly more API-friendly representation of AppInfo
• AppRequest
  Represents the available conductor functions to call over an app interface and will result in a corresponding AppResponse message being sent back over the interface connection.
• AppResponse
  Represents the possible responses to an AppRequest.
• AppStatusFilter
  Filter for AdminRequest::ListApps.
• CellInfo
• ExternalApiWireError
  Error type that goes over the websocket wire. This intends to be application developer facing so it should be readable and relevant
• InterfaceDriver
  Configuration for interfaces, specifying the means by which an interface should be opened.
• StorageBlob
  The type of storage blob

Traits

• AdminInterfaceApi
  A trait for the interface that a Conductor exposes to the outside world to use for administering the conductor. This trait has one mock implementation and one “real” implementation
• AppInterfaceApi
  The interface that a Conductor exposes to the outside world.
• CellConductorApiT
  The “internal” Conductor API interface, for a Cell to talk to its calling Conductor.
• CellConductorReadHandleT
  A minimal set of functionality needed from the conductor by host functions.
• InterfaceApi
  A trait that unifies both the admin and app interfaces

Type Aliases

• CellConductorHandle
  Alias
• CellConductorReadHandle
  A minimal set of functionality needed from the conductor by host functions.