Struct ManagedConnection

pub struct ManagedConnection { /* private fields */ }

Available on crate feature managed only.

QueryClient wrapper with connection-check on access

Implementations

impl ManagedConnection

pub fn conn_id(&mut self) -> Result<ClientId, Ts3Error>

Returns the current connection id (clid)

pub fn clone(&self, new_name: Option<String>) -> Result<Self, Ts3Error>

Try creating a second connection, based on the configs of this one. new_name can specifiy a different connection client name.

pub fn new(config: ManagedConfig) -> Result<ManagedConnection, Ts3Error>

Create new TS-Connection with an optional name

pub fn force_reconnect(&mut self) -> Result<(), Ts3Error>

Force reconnect, may be called if server returns invalid data on call. Can happen if for example the firewall just drops packages for some time.

pub fn get(&mut self) -> Result<&mut QueryClient, Ts3Error>

Returns the active connection or fallbacks to reconnect Checks for connection health every 1 second between a get() call.