Struct holochain::conductor::conductor::Conductor

pub struct Conductor {
    pub config: ConductorConfig,
    /* private fields */
}

A Conductor is a group of Cells

Fields

config: ConductorConfig

The config used to create this Conductor

Implementations

impl Conductor

Methods used by the ConductorHandle

pub fn check_running(&self) -> ConductorResult<()>

A gate to put at the top of public functions to ensure that work is not attempted after a shutdown has been issued

pub fn detach_task_management(&self) -> Option<JoinHandle<TaskManagerResult>>

Take ownership of the TaskManagerClient as well as the task which completes when all managed tasks have completed

pub fn shutdown(&self) -> JoinHandle<TaskManagerResult>

Broadcasts the shutdown signal to all managed tasks and returns a future to await for shutdown to complete.

impl Conductor

pub async fn add_app_interface( self: Arc<Self>, port: Either<u16, AppInterfaceId> ) -> ConductorResult<u16>

Spawn a new app interface task, register it with the TaskManager, and modify the conductor accordingly, based on the config passed in which is just a networking port number (or 0 to auto-select one). Returns the given or auto-chosen port number if giving an Ok Result

pub fn get_arbitrary_admin_websocket_port(&self) -> Option<u16>

Returns a port which is guaranteed to have a websocket listener with an Admin interface on it. Useful for specifying port 0 and letting the OS choose a free port.

pub async fn list_app_interfaces(&self) -> ConductorResult<Vec<u16>>

Give a list of networking ports taken up as running app interface tasks

impl Conductor

pub fn list_dnas(&self) -> Vec<DnaHash>

Get the list of hashes of installed Dnas in this Conductor

pub fn get_dna_def(&self, hash: &DnaHash) -> Option<DnaDef>

Get a DnaDef from the RibosomeStore

pub fn get_dna_file(&self, hash: &DnaHash) -> Option<DnaFile>

Get a DnaFile from the RibosomeStore

pub fn get_entry_def(&self, key: &EntryDefBufferKey) -> Option<EntryDef>

Get an EntryDef from the EntryDefBufferKey

pub fn get_dna_definitions( &self, app: &InstalledApp ) -> ConductorResult<HashMap<CellId, DnaDefHashed>>

Create a hash map of all existing DNA definitions, mapped to cell ids.

pub fn root_db_dir(&self) -> &DatabaseRootPath

Get the root environment directory.

pub fn keystore(&self) -> &MetaLairClient

Get the keystore.

pub fn holochain_p2p(&self) -> &HolochainP2pRef

Get a reference to the conductor’s HolochainP2p.

pub async fn register_dna(&self, dna: DnaFile) -> ConductorResult<()>

Install a DnaFile in this Conductor

impl Conductor

pub async fn get_agent_infos( &self, cell_id: Option<CellId> ) -> ConductorApiResult<Vec<AgentInfoSigned>>

Get signed agent info from the conductor

pub async fn block(&self, input: Block) -> DatabaseResult<()>

Block some target.

pub async fn unblock(&self, input: Block) -> DatabaseResult<()>

Unblock some target.

pub async fn is_blocked( &self, input: BlockTargetId, timestamp: Timestamp ) -> DatabaseResult<bool>

Check if some target is blocked.

pub async fn list_wasm_host_functions(&self) -> ConductorApiResult<Vec<String>>

List all host functions provided by this conductor for wasms.

pub async fn call_zome( &self, call: ZomeCall ) -> ConductorApiResult<ZomeCallResult>

Invoke a zome function on a Cell

pub async fn easy_call_zome<I, O, Z, F>( &self, provenance: &AgentPubKey, cap_secret: Option<CapSecret>, cell_id: CellId, zome_name: Z, fn_name: F, payload: I ) -> ConductorApiResult<O>where FunctionName: From<F>, ZomeName: From<Z>, I: Serialize + Debug, O: DeserializeOwned + Debug,

Make a zome call with deserialization and some error unwrapping built in

impl Conductor

pub async fn install_app_bundle( self: Arc<Self>, payload: InstallAppPayload ) -> ConductorResult<StoppedApp>

Install DNAs and set up Cells as specified by an AppBundle

pub async fn uninstall_app( self: Arc<Self>, installed_app_id: &InstalledAppId ) -> ConductorResult<()>

Uninstall an app

pub async fn list_running_apps(&self) -> ConductorResult<Vec<InstalledAppId>>

List active AppIds

pub async fn list_apps( &self, status_filter: Option<AppStatusFilter> ) -> ConductorResult<Vec<AppInfo>>

List Apps with their information

pub async fn list_running_apps_for_dependent_cell_id( &self, cell_id: &CellId ) -> ConductorResult<HashSet<InstalledAppId>>

Get the IDs of all active installed Apps which use this Cell

pub async fn find_cell_with_role_alongside_cell( &self, cell_id: &CellId, role_name: &RoleName ) -> ConductorResult<Option<CellId>>

Find the ID of the first active installed App which uses this Cell

pub async fn list_running_apps_for_dependent_dna_hash( &self, dna_hash: &DnaHash ) -> ConductorResult<HashSet<InstalledAppId>>

Get the IDs of all active installed Apps which use this Dna

pub async fn get_app_info( &self, installed_app_id: &InstalledAppId ) -> ConductorResult<Option<AppInfo>>

Get info about an installed App, regardless of status

impl Conductor

pub fn live_cell_ids(&self) -> HashSet<CellId>

Iterator over only the cells which are fully “live”, meaning they have been fully initialized and are registered with the kitsune network layer. Generally used to handle conductor interface requests.

pub fn running_cell_ids( &self, filter: Option<CellStatusFilter> ) -> HashSet<CellId>

List CellIds for Cells which match a status filter

impl Conductor

pub async fn create_clone_cell( self: Arc<Self>, payload: CreateCloneCellPayload ) -> ConductorResult<ClonedCell>

Create a new cell in an existing app based on an existing DNA.

Returns

A struct with the created cell’s clone id and cell id.

pub async fn enable_clone_cell( self: Arc<Self>, payload: &EnableCloneCellPayload ) -> ConductorResult<ClonedCell>

Enable a disabled clone cell.

impl Conductor

pub async fn reconcile_cell_status_with_app_status( self: Arc<Self> ) -> ConductorResult<CellStartupErrors>

Adjust which cells are present in the Conductor (adding and removing as needed) to match the current reality of all app statuses.

• If a Cell is used by at least one Running app, then ensure it is added
• If a Cell is used by no running apps, then ensure it is removed.

pub async fn enable_app( self: Arc<Self>, app_id: InstalledAppId ) -> ConductorResult<(InstalledApp, CellStartupErrors)>

Enable an app

pub async fn disable_app( self: Arc<Self>, app_id: InstalledAppId, reason: DisabledAppReason ) -> ConductorResult<InstalledApp>

Disable an app

pub async fn start_app( self: Arc<Self>, app_id: InstalledAppId ) -> ConductorResult<InstalledApp>

Start an app

impl Conductor

pub async fn grant_zome_call_capability( &self, payload: GrantZomeCallCapabilityPayload ) -> ConductorApiResult<()>

Grant a zome call capability for a cell

pub async fn dump_cell_state( &self, cell_id: &CellId ) -> ConductorApiResult<String>

Create a JSON dump of the cell’s state

pub async fn dump_full_cell_state( &self, cell_id: &CellId, dht_ops_cursor: Option<u64> ) -> ConductorApiResult<FullStateDump>

Create a comprehensive structured dump of a cell’s state

pub async fn dump_network_metrics( &self, dna_hash: Option<DnaHash> ) -> ConductorApiResult<String>

JSON dump of network metrics

pub async fn dump_network_stats(&self) -> ConductorApiResult<String>

JSON dump of backend network stats

pub async fn add_agent_infos( &self, agent_infos: Vec<AgentInfoSigned> ) -> ConductorApiResult<()>

Add signed agent info to the conductor

pub async fn graft_records_onto_source_chain( self: Arc<Self>, cell_id: CellId, validate: bool, records: Vec<Record> ) -> ConductorApiResult<()>

Inject records into a source chain for a cell. If the records form a chain segment that can be “grafted” onto the existing chain, it will be. Otherwise, a new chain will be formed using the specified records.

pub async fn update_coordinators( &self, hash: &DnaHash, coordinator_zomes: CoordinatorZomes, wasms: Vec<DnaWasm> ) -> ConductorResult<()>

Update coordinator zomes on an existing dna.

impl Conductor

pub fn signal_broadcaster(&self) -> SignalBroadcaster

Access to the signal broadcast channel, to create new subscriptions

pub async fn post_commit_permit( &self ) -> Result<OwnedPermit<PostCommitArgs>, SendError<()>>

Get the post commit sender.

pub fn get_config(&self) -> &ConductorConfig

Get the conductor config

pub fn task_manager(&self) -> TaskManagerClient

Get a TaskManagerClient

impl Conductor

pub fn builder() -> ConductorBuilder

Create a conductor builder