Struct GatewayConnect 

pub struct GatewayConnect {
    pub client: Option<BasiliskClient>,
}

Gateway connection handle. Wraps the connected Basilisk client, if any.

Fields

client: Option<BasiliskClient>

The connected client. Always Some on instances returned by GatewayConnect::set_up.

Implementations

impl GatewayConnect

pub fn instance() -> Option<Arc<Self>>

Returns the process-wide instance if GatewayConnect::set_up has succeeded.

pub fn get_client(&self) -> Option<&BasiliskClient>

Returns the connected client, or None when there is no connection.

pub fn require_client(&self) -> Result<&BasiliskClient>

Returns the connected client. Errors when there is no connection (e.g. setup was skipped for empty mount paths).

pub async fn set_up( mount_paths: Vec<String>, scheme: impl Into<String>, weight: i32, auth_type: impl Into<String>, ) -> Result<Option<Arc<Self>>>

Registers with the gateway and connects the service bus with exponential-backoff retries.

Reads BASILISK_HOST, BASILISK_BUS_PORT, BASILISK_TOKEN, BASILISK_GATEWAY_URL, BASILISK_SERVICE_ID, and SERVICE_KEY from AppEnvironment (falling back to the process environment), and SERVER_PORT for the service port (defaults to 8080). mount_paths are registered as the service path prefixes; scheme, weight, and auth_type go into the registration. Returns Ok(None) without connecting when mount_paths is empty. Errors when already initialized, when required env is missing, or after 5 failed connect attempts.

pub async fn set_up_with_config( config: BasiliskClientConfig, ) -> Result<Arc<Self>>

Connects with an explicit client config and the same retry policy as GatewayConnect::set_up.

Errors when already initialised or after 5 failed connect attempts.

pub async fn deregister(&self) -> Result<()>

Deregisters this service from the gateway. No-ops when there is no connected client.

Trait Implementations

impl Clone for GatewayConnect

fn clone(&self) -> GatewayConnect

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.