Struct Session 

pub struct Session<'a> { /* private fields */ }

OpenVPN 3 Session

Implementations

impl<'a> Session<'a>

pub fn path(&'a self) -> &ObjectPath<'_>

Get a reference to the underlying proxy’s object path.

pub async fn ready(&'a self) -> Result<()>

pub async fn connect(&'a self) -> Result<()>

Start the connection process.

pub async fn pause(&'a self, reason: &str) -> Result<()>

Pause an active connection.

pub async fn resume(&'a self) -> Result<()>

Resume a paused connection.

pub async fn restart(&'a self) -> Result<()>

Disconnect and reconnect.

pub async fn disconnect(&'a self) -> Result<()>

Disconnect and remove the VPN session.

pub async fn status(&'a self) -> Result<Status>

Get the last processed [StatusChange] signal.

pub async fn statistics(&'a self) -> Result<Statistics>

Get tunnel statistics.

pub async fn get_property<T>(&'a self, property_name: &str) -> Result<T>

where T: TryFrom<OwnedValue>, T::Error: Into<Error>,

Get a property value from the underlying D-Bus proxy.

pub async fn user_input_queue_get_type_group( &'a self, ) -> Result<Vec<UserInputQueueTypeGroup>>

pub async fn user_input_queue_check( &'a self, qtype: ClientAttentionType, qgroup: ClientAttentionGroup, ) -> Result<Vec<u32>>

pub async fn user_input_queue_fetch( &'a self, qtype: ClientAttentionType, qgroup: ClientAttentionGroup, qid: u32, ) -> Result<UserInputSlot<'a>>

Fetch a UserInputSlot which represents a request for user input and which can be used to provide input to the backend.

Arguments

• qtype - Queue type of the user input slot.
• qgroup - Queue group of the user input slot.
• qid - Queue ID of the user input slot to retrieve.

Returns

A UserInputSlot which provides information on what input to query for.

pub async fn fetch_user_input_slots(&'a self) -> Result<Vec<UserInputSlot<'_>>>

Fetch all required user inputs.

Returns

An array of UserInputSlot instances which represent single requests for input and can be used to provide input to the backend.

pub async fn attention_required_stream( &self, ) -> Result<AttentionRequiredStream<'a>>

Get a AttentionRequiredStream for this VPN session.

pub async fn status_change_stream(&self) -> Result<StatusChangeStream<'a>>

Get a StatusChangeStream for this VPN session.

pub async fn log_stream(&self) -> Result<LogStream<'a>>

Get a LogStream for this VPN session.

This should be called after the backend process is ready

Trait Implementations

impl<'a> Clone for Session<'a>

fn clone(&self) -> Session<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Session<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.