Struct ConfigurationProxyBlocking

pub struct ConfigurationProxyBlocking<'c>(/* private fields */);

Configuration Service

Stores VPN configuration profiles in a format used by the OpenVPN 3 Core library.

OpenVPN Documentation

Implementations

impl<'c> ConfigurationProxyBlocking<'c>

pub fn new(conn: &Connection) -> Result<ConfigurationProxyBlocking<'c>>

Creates a new proxy with the default service and path.

pub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>

Returns a customizable builder for this proxy.

pub fn into_inner(self) -> Proxy<'c>

Consumes self, returning the underlying zbus::Proxy.

pub fn inner(&self) -> &Proxy<'c>

The reference to the underlying zbus::Proxy.

pub fn fetch_available_configs(&self) -> Result<Vec<OwnedObjectPath>>

FetchAvailableConfigs method

This method will return an array of object paths to configuration objects the caller is granted access to.

pub fn import( &self, name: &str, config_str: &str, single_use: bool, persistent: bool, ) -> Result<ConfigurationNodeProxyBlocking<'c>>

Import method

This method imports a configuration profile. The configuration must be represented as a string blob containing everything.

Arguments

• name - User friendly name of the profile. To be used in user front-ends.
• config_str - Content of config file. All files must be embedded inline.
• single_use - If set to true, it will be removed from memory on first use.
• persistent - If set to true, the configuration will be saved to disk.

Returns

A unique D-Bus object path for the imported VPN configuration profile

pub fn lookup_config_name( &self, config_name: &str, ) -> Result<Vec<OwnedObjectPath>>

LookupConfigName method

This method will return an array of object paths to configuration objects the caller is granted access with the configuration name provided to the method.

Arguments

• config_name - String containing the configuration name for the configuration path lookup.

Returns

An array of object paths to accessible configuration objects

pub fn transfer_ownership( &self, path: &ObjectPath<'_>, new_owner_uid: u32, ) -> Result<()>

TransferOwnership method

This method transfers the ownership of a configuration profile to the given UID value. This feature is by design restricted to the root account only and is only expected to be used by openvpn3-autoload and similar tools.

Arguments

• path - Configuration object path where to modify the owner property.
• new_owner_uid - UID value of the new owner of the configuration profile.

pub fn receive_log(&self) -> Result<LogIterator<'static>>

Create a stream that receives Log signals.

This a convenient wrapper around zbus::blocking::Proxy::receive_signal. Log signal

Whenever the configuration manager wants to log something, it issues a Log signal which carries a log group, log verbosity level and a string with the log message itself. See the separate logging documentation for details on this signal.

pub fn receive_log_with_args( &self, args: &[(u8, &str)], ) -> Result<LogIterator<'static>>

Create a stream that receives Log signals.

This a convenient wrapper around zbus::blocking::Proxy::receive_signal_with_args. Log signal

Whenever the configuration manager wants to log something, it issues a Log signal which carries a log group, log verbosity level and a string with the log message itself. See the separate logging documentation for details on this signal.

pub fn version(&self) -> Result<String>

Version of the currently running service.

pub fn cached_version( &self, ) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>

Get the cached value of the version property, or None if the property is not cached.

pub fn receive_version_changed( &self, ) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>

Create a stream for the version property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed.

Methods from Deref<Target = Proxy<'c>>

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

pub fn destination(&self) -> &BusName<'_>

Get a reference to the destination service name.

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

Get a reference to the object path.

pub fn interface(&self) -> &InterfaceName<'_>

Get a reference to the interface.

pub fn introspect(&self) -> Result<String, Error>

Introspect the associated object, and return the XML description.

See the xml module for parsing the result.

pub fn cached_property<T>( &self, property_name: &str, ) -> Result<Option<T>, Error>

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

Get the cached value of the property property_name.

This returns None if the property is not in the cache. This could be because the cache was invalidated by an update, because caching was disabled for this property or proxy, or because the cache has not yet been populated. Use get_property to fetch the value from the peer.

pub fn cached_property_raw<'p>( &'p self, property_name: &'p str, ) -> Option<impl Deref<Target = Value<'static>> + 'p>

Get the cached value of the property property_name.

Same as cached_property, but gives you access to the raw value stored in the cache. This is useful if you want to avoid allocations and cloning.

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

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

Get the property property_name.

Get the property value from the cache or call the Get method of the org.freedesktop.DBus.Properties interface.

pub fn set_property<'t, T>( &self, property_name: &str, value: T, ) -> Result<(), Error>

where T: 't + Into<Value<'t>>,

Set the property property_name.

Effectively, call the Set method of the org.freedesktop.DBus.Properties interface.

pub fn call_method<'m, M, B>( &self, method_name: M, body: &B, ) -> Result<Arc<Message>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>, B: Serialize + DynamicType,

Call a method and return the reply.

Typically, you would want to use call method instead. Use this method if you need to deserialize the reply message manually (this way, you can avoid the memory allocation/copying, by deserializing the reply to an unowned type).

pub fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>, B: Serialize + DynamicType, R: DeserializeOwned + Type,

Call a method and return the reply body.

Use call_method instead if you need to deserialize the reply manually/separately.

pub fn call_with_flags<'m, M, B, R>( &self, method_name: M, flags: BitFlags<MethodFlags>, body: &B, ) -> Result<Option<R>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>, B: Serialize + DynamicType, R: DeserializeOwned + Type,

Call a method and return the reply body, optionally supplying a set of method flags to control the way the method call message is sent and handled.

Use call instead if you do not need any special handling via additional flags. If the NoReplyExpected flag is passed , this will return None immediately after sending the message, similar to call_noreply

pub fn call_noreply<'m, M, B>( &self, method_name: M, body: &B, ) -> Result<(), Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>, B: Serialize + DynamicType,

Call a method without expecting a reply

This sets the NoReplyExpected flag on the calling message and does not wait for a reply.

pub fn receive_signal<'m, M>( &self, signal_name: M, ) -> Result<SignalIterator<'m>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Create a stream for signal named signal_name.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

pub fn receive_signal_with_args<'m, M>( &self, signal_name: M, args: &[(u8, &str)], ) -> Result<SignalIterator<'m>, Error>

where M: TryInto<MemberName<'m>>, <M as TryInto<MemberName<'m>>>::Error: Into<Error>,

Same as Proxy::receive_signal but with a filter.

The D-Bus specification allows you to filter signals by their arguments, which helps avoid a lot of unnecessary traffic and processing since the filter is run on the server side. Use this method where possible. Note that this filtering is limited to arguments of string types.

The arguments are passed as a tuples of argument index and expected value.

pub fn receive_all_signals(&self) -> Result<SignalIterator<'static>, Error>

Create a stream for all signals emitted by this service.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

pub fn receive_property_changed<'name, T>( &self, name: &'name str, ) -> PropertyIterator<'a, T>

where 'name: 'a,

Get an iterator to receive owner changed events.

If the proxy destination is a unique name, the stream will be notified of the peer disconnection from the bus (with a None value).

If the proxy destination is a well-known name, the stream will be notified whenever the name owner is changed, either by a new peer being granted ownership (Some value) or when the name is released (with a None value).

Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.

pub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>

Get an iterator to receive property changed events.

Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.

pub fn inner(&self) -> &Proxy<'a>

Get a reference to the underlying async Proxy.

Trait Implementations

impl<'c> AsMut<Proxy<'c>> for ConfigurationProxyBlocking<'c>

fn as_mut(&mut self) -> &mut Proxy<'c>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'c> AsRef<Proxy<'c>> for ConfigurationProxyBlocking<'c>

fn as_ref(&self) -> &Proxy<'c>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'c> Clone for ConfigurationProxyBlocking<'c>

fn clone(&self) -> ConfigurationProxyBlocking<'c>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'c> Debug for ConfigurationProxyBlocking<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for ConfigurationProxyBlocking<'c>

type Target = Proxy<'c>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'c> DerefMut for ConfigurationProxyBlocking<'c>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'c> From<Proxy<'c>> for ConfigurationProxyBlocking<'c>

fn from(proxy: Proxy<'c>) -> Self

Converts to this type from the input type.

impl<'a> ProxyDefault for ConfigurationProxyBlocking<'a>

const INTERFACE: &'static str = "net.openvpn.v3.configuration"

const DESTINATION: &'static str = "net.openvpn.v3.configuration"

const PATH: &'static str = "/net/openvpn/v3/configuration"

impl<'c> Serialize for ConfigurationProxyBlocking<'c>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'c> Type for ConfigurationProxyBlocking<'c>

fn signature() -> Signature<'static>

Get the signature for the implementing type.