Struct AdminWebsocket

pub struct AdminWebsocket { /* private fields */ }

Implementations

impl AdminWebsocket

pub async fn connect(socket_addr: impl ToSocketAddrs) -> Result<Self>

Connect to a Conductor API AdminWebsocket.

socket_addr is a websocket address that implements ToSocketAddr. See trait ToSocketAddr.

Examples

use std::net::Ipv4Addr;
let admin_ws = holochain_client::AdminWebsocket::connect((Ipv4Addr::LOCALHOST, 30_000)).await?;

As string "localhost:30000" As tuple ([127.0.0.1], 30000)

pub async fn connect_with_config( socket_addr: impl ToSocketAddrs, websocket_config: Arc<WebsocketConfig>, ) -> Result<Self>

Connect to a Conductor API AdminWebsocket with a custom WebsocketConfig.

pub async fn issue_app_auth_token( &self, payload: IssueAppAuthenticationTokenPayload, ) -> ConductorApiResult<AppAuthenticationTokenIssued>

Issue an app authentication token for the specified app.

A token is required to create an [AppAgentWebsocket] connection.

pub async fn generate_agent_pub_key(&self) -> ConductorApiResult<AgentPubKey>

pub async fn revoke_agent_key( &self, app_id: String, agent_key: AgentPubKey, ) -> ConductorApiResult<Vec<(CellId, String)>>

pub async fn list_app_interfaces( &self, ) -> ConductorApiResult<Vec<AppInterfaceInfo>>

List all app interfaces attached to the conductor.

See the documentation for AdminWebsocket::attach_app_interface to understand the content of AppInterfaceInfo and help you to select an appropriate interface to connect to.

pub async fn attach_app_interface( &self, port: u16, allowed_origins: AllowedOrigins, installed_app_id: Option<String>, ) -> ConductorApiResult<u16>

Attach an app interface to the conductor.

This will create a new websocket on the specified port. Alternatively, specify the port as 0 to allow the OS to choose a port. The selected port will be returned so you know where to connect your app client.

Allowed origins can be used to restrict which domains can connect to the interface. This is used to protect the interface from scripts running in web pages. In development it is acceptable to use AllowedOrigins::All to allow all connections. In production you should consider setting an explicit list of origins, such as "my_cli_app".to_string().into().

If you want to restrict this app interface so that it is only accessible to a specific installed app then you can provide the installed_app_id. The client will still need to authenticate with a valid token for the same app, but clients for other apps will not be able to connect. If you want to allow all apps to connect then set this to None.

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

pub async fn install_app( &self, payload: InstallAppPayload, ) -> ConductorApiResult<AppInfo>

pub async fn uninstall_app( &self, installed_app_id: String, force: bool, ) -> ConductorApiResult<()>

pub async fn enable_app( &self, installed_app_id: String, ) -> ConductorApiResult<EnableAppResponse>

pub async fn disable_app( &self, installed_app_id: String, ) -> ConductorApiResult<()>

pub async fn list_cell_ids(&self) -> ConductorApiResult<Vec<CellId>>

pub async fn get_dna_definition( &self, hash: DnaHash, ) -> ConductorApiResult<DnaDef>

pub async fn get_compatible_cells( &self, dna_hash: DnaHash, ) -> ConductorApiResult<CompatibleCells>

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

pub async fn delete_clone_cell( &self, payload: DeleteCloneCellPayload, ) -> ConductorApiResult<()>

pub async fn storage_info(&self) -> ConductorApiResult<StorageInfo>

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

pub async fn update_coordinators( &self, update_coordinators_payload: UpdateCoordinatorsPayload, ) -> ConductorApiResult<()>

pub async fn graft_records( &self, cell_id: CellId, validate: bool, records: Vec<Record>, ) -> ConductorApiResult<()>

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

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

pub async fn authorize_signing_credentials( &self, request: AuthorizeSigningCredentialsPayload, ) -> Result<SigningCredentials>

Trait Implementations

impl Drop for AdminWebsocket

fn drop(&mut self)

Executes the destructor for this type.