pub struct SessionsNodeProxyBlocking<'c>(/* private fields */);
Expand description
Session Object
Implementations§
Source§impl<'c> SessionsNodeProxyBlocking<'c>
impl<'c> SessionsNodeProxyBlocking<'c>
Sourcepub fn new(conn: &Connection) -> Result<SessionsNodeProxyBlocking<'c>>
pub fn new(conn: &Connection) -> Result<SessionsNodeProxyBlocking<'c>>
Creates a new proxy with the default service and path.
Sourcepub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>
pub fn builder(conn: &Connection) -> ProxyBuilder<'c, Self>
Returns a customizable builder for this proxy.
Sourcepub fn into_inner(self) -> Proxy<'c>
pub fn into_inner(self) -> Proxy<'c>
Consumes self
, returning the underlying zbus::Proxy
.
Sourcepub fn access_grant(&self, uid: u32) -> Result<()>
pub fn access_grant(&self, uid: u32) -> Result<()>
AccessGrant method
By default, only the user ID (UID) who created the session have access to it. This method used to grant other users access to this session.
§Arguments
uid
- The UID to the user account which is granted access;
Sourcepub fn access_revoke(&self, uid: u32) -> Result<()>
pub fn access_revoke(&self, uid: u32) -> Result<()>
AccessRevoke method
This revokes access to a session object for a specific user. Please note that the owner (the user which initiated this session) cannot have its access revoked.
§Arguments
uid
- The UID to the user account which gets the access revoked.
Sourcepub fn connect(&self) -> Result<()>
pub fn connect(&self) -> Result<()>
Connect method
This method starts the connection process. This requires that all credentials needed before contacting the server have been provided. It is always a good idea to first call the net.openvpn.v3.sessions.Ready
method first to ensure the backend is ready to connect.
Sourcepub fn disconnect(&self) -> Result<()>
pub fn disconnect(&self) -> Result<()>
Disconnect method
Disconnects a VPN connection. This will shutdown and stop the VPN backend process and the session object will be removed.
Sourcepub fn log_forward(&self, enable: bool) -> Result<()>
pub fn log_forward(&self, enable: bool) -> Result<()>
LogForward method
This enables log forwarding from the session to the currently connected D-Bus client. The forwarding itself is sent by the net.openvpn.v3.log
service.
§Arguments
enable
- Enables or disables the log forwarding.
Sourcepub fn pause(&self, reason: &str) -> Result<()>
pub fn pause(&self, reason: &str) -> Result<()>
Pause method
This method pauses an on-going VPN connection.
§Arguments
reason
- A string used for log purposes primarily, describing why the tunnel was paused.
Sourcepub fn ready(&self) -> Result<()>
pub fn ready(&self) -> Result<()>
Ready method
This method is to check if the backend VPN client is ready to connect. If it is ready, it will return immediately. If it is not, it will return with a D-Bus error exception providing the reason it is not ready. Most commonly it needs some input from the user, such as user credentials or some challenge token not already provided in the configuration.
Sourcepub fn restart(&self) -> Result<()>
pub fn restart(&self) -> Result<()>
Restart method
Completely disconnects and reconnects an active VPN connection.
Sourcepub fn user_input_provide(
&self,
type_: ClientAttentionType,
group: ClientAttentionGroup,
id: u32,
value: &str,
) -> Result<()>
pub fn user_input_provide( &self, type_: ClientAttentionType, group: ClientAttentionGroup, id: u32, value: &str, ) -> Result<()>
UserInputProvide method
This method is used to return information from the front-end application to the backend service.
§Arguments
type_
- ClientAttentionType reference to query for.group
- ClientAttentionGroup reference to query for.id
- Request ID to query for, provided byUserInputQueueCheck()
.value
- The frontend’s response to the backend.
Sourcepub fn user_input_queue_check(
&self,
type_: ClientAttentionType,
group: ClientAttentionGroup,
) -> Result<Vec<u32>>
pub fn user_input_queue_check( &self, type_: ClientAttentionType, group: ClientAttentionGroup, ) -> Result<Vec<u32>>
UserInputQueueCheck method
This is used to get the proper index values of information requests the backend has asked for and which is not yet satisfied. The index list is tied to a specific (ClientAttentionType, ClientAttentionGroup) tuple.
§Arguments
type_
- ClientAttentionType reference to query for.group
- ClientAttentionGroup reference to query for.
§Returns
An array of indexes which needs to be provided.
Sourcepub fn user_input_queue_fetch(
&self,
type_: ClientAttentionType,
group: ClientAttentionGroup,
id: u32,
) -> Result<(ClientAttentionType, ClientAttentionGroup, u32, String, String, bool)>
pub fn user_input_queue_fetch( &self, type_: ClientAttentionType, group: ClientAttentionGroup, id: u32, ) -> Result<(ClientAttentionType, ClientAttentionGroup, u32, String, String, bool)>
UserInputQueueFetch method
This method returns details about a specific information request from the backend process.
§Arguments
type_
- ClientAttentionType reference to query for.group
- ClientAttentionGroup reference to query for.id
- Request ID to query for, provided byUserInputQueueCheck()
.
§Returns
A tuple consisting of:
type
- ClientAttentionType reference.group
- ClientAttentionGroup reference.id
- Request ID.name
- An internal variable name.description
- A description to present to the front-end user.hidden_input
- If true, the user’s input should be masked/hidden.
Sourcepub fn user_input_queue_get_type_group(
&self,
) -> Result<Vec<UserInputQueueTypeGroup>>
pub fn user_input_queue_get_type_group( &self, ) -> Result<Vec<UserInputQueueTypeGroup>>
UserInputQueueGetTypeGroup method
This will return information about various ClientAttentionType and ClientAttentionGroup tuples which contains requests for the front-end application. This information is used when checking the request queue via UserInputQueueCheck()
.
§Returns
An array of tuples of (ClientAttentionType, ClientAttentionGroup).
Sourcepub fn receive_attention_required(
&self,
) -> Result<AttentionRequiredIterator<'static>>
pub fn receive_attention_required( &self, ) -> Result<AttentionRequiredIterator<'static>>
Create a stream that receives AttentionRequired
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal
.
AttentionRequired signal
This signal is issued whenever the backend needs information, most commonly from the front-end user interface. This can be used to get user credentials or do PKCS#11/SmartCard operations, etc.
Sourcepub fn receive_attention_required_with_args(
&self,
args: &[(u8, &str)],
) -> Result<AttentionRequiredIterator<'static>>
pub fn receive_attention_required_with_args( &self, args: &[(u8, &str)], ) -> Result<AttentionRequiredIterator<'static>>
Create a stream that receives AttentionRequired
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal_with_args
.
AttentionRequired signal
This signal is issued whenever the backend needs information, most commonly from the front-end user interface. This can be used to get user credentials or do PKCS#11/SmartCard operations, etc.
Sourcepub fn receive_log(&self) -> Result<LogIterator<'static>>
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
See LogArgs.
Sourcepub fn receive_log_with_args(
&self,
args: &[(u8, &str)],
) -> Result<LogIterator<'static>>
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
See LogArgs.
Sourcepub fn receive_status_change(&self) -> Result<StatusChangeIterator<'static>>
pub fn receive_status_change(&self) -> Result<StatusChangeIterator<'static>>
Create a stream that receives StatusChange
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal
.
StatusChange signal
This signal is issued each time specific events occurs. They can both be from the session object itself or StatusChange messages proxied from the VPN client backend process.
See StatusChangeArgs.
Sourcepub fn receive_status_change_with_args(
&self,
args: &[(u8, &str)],
) -> Result<StatusChangeIterator<'static>>
pub fn receive_status_change_with_args( &self, args: &[(u8, &str)], ) -> Result<StatusChangeIterator<'static>>
Create a stream that receives StatusChange
signals.
This a convenient wrapper around zbus::blocking::Proxy::receive_signal_with_args
.
StatusChange signal
This signal is issued each time specific events occurs. They can both be from the session object itself or StatusChange messages proxied from the VPN client backend process.
See StatusChangeArgs.
Sourcepub fn cached_acl(
&self,
) -> Result<Option<<Result<Vec<u32>> as ResultAdapter>::Ok>, <Result<Vec<u32>> as ResultAdapter>::Err>
pub fn cached_acl( &self, ) -> Result<Option<<Result<Vec<u32>> as ResultAdapter>::Ok>, <Result<Vec<u32>> as ResultAdapter>::Err>
Get the cached value of the acl
property, or None
if the property is not cached.
Sourcepub fn receive_acl_changed(
&self,
) -> PropertyIterator<'c, <Result<Vec<u32>> as ResultAdapter>::Ok>
pub fn receive_acl_changed( &self, ) -> PropertyIterator<'c, <Result<Vec<u32>> as ResultAdapter>::Ok>
Create a stream for the acl
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn backend_pid(&self) -> Result<u32>
pub fn backend_pid(&self) -> Result<u32>
backend_pid property
Process ID of the VPN backend client process.
Sourcepub fn cached_backend_pid(
&self,
) -> Result<Option<<Result<u32> as ResultAdapter>::Ok>, <Result<u32> as ResultAdapter>::Err>
pub fn cached_backend_pid( &self, ) -> Result<Option<<Result<u32> as ResultAdapter>::Ok>, <Result<u32> as ResultAdapter>::Err>
Get the cached value of the backend_pid
property, or None
if the property is not cached.
Sourcepub fn receive_backend_pid_changed(
&self,
) -> PropertyIterator<'c, <Result<u32> as ResultAdapter>::Ok>
pub fn receive_backend_pid_changed( &self, ) -> PropertyIterator<'c, <Result<u32> as ResultAdapter>::Ok>
Create a stream for the backend_pid
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn config_name(&self) -> Result<String>
pub fn config_name(&self) -> Result<String>
config_name property
Name of the configuration profile when the session was started.
Sourcepub fn cached_config_name(
&self,
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
pub fn cached_config_name( &self, ) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
Get the cached value of the config_name
property, or None
if the property is not cached.
Sourcepub fn receive_config_name_changed(
&self,
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
pub fn receive_config_name_changed( &self, ) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the config_name
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn config_path(&self) -> Result<OwnedObjectPath>
pub fn config_path(&self) -> Result<OwnedObjectPath>
config_path property
D-Bus object path to the configuration profile used.
Sourcepub fn cached_config_path(
&self,
) -> Result<Option<<Result<OwnedObjectPath> as ResultAdapter>::Ok>, <Result<OwnedObjectPath> as ResultAdapter>::Err>
pub fn cached_config_path( &self, ) -> Result<Option<<Result<OwnedObjectPath> as ResultAdapter>::Ok>, <Result<OwnedObjectPath> as ResultAdapter>::Err>
Get the cached value of the config_path
property, or None
if the property is not cached.
Sourcepub fn receive_config_path_changed(
&self,
) -> PropertyIterator<'c, <Result<OwnedObjectPath> as ResultAdapter>::Ok>
pub fn receive_config_path_changed( &self, ) -> PropertyIterator<'c, <Result<OwnedObjectPath> as ResultAdapter>::Ok>
Create a stream for the config_path
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn dco(&self) -> Result<bool>
pub fn dco(&self) -> Result<bool>
dco property
Kernel based Data Channel Offload flag. Must be modified before calling Connect()
to override the current setting.
Sourcepub fn cached_dco(
&self,
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
pub fn cached_dco( &self, ) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
Get the cached value of the dco
property, or None
if the property is not cached.
Sourcepub fn receive_dco_changed(
&self,
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
pub fn receive_dco_changed( &self, ) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
Create a stream for the dco
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
pub fn set_dco(&self, value: bool) -> Result<()>
Sourcepub fn device_name(&self) -> Result<String>
pub fn device_name(&self) -> Result<String>
device_name property
Virtual network interface name used by this session.
Sourcepub fn cached_device_name(
&self,
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
pub fn cached_device_name( &self, ) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
Get the cached value of the device_name
property, or None
if the property is not cached.
Sourcepub fn receive_device_name_changed(
&self,
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
pub fn receive_device_name_changed( &self, ) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the device_name
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn device_path(&self) -> Result<String>
pub fn device_path(&self) -> Result<String>
device_path property
D-Bus object path to the net.openvpn.v3.netcfg
device object related to this session.
Sourcepub fn cached_device_path(
&self,
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
pub fn cached_device_path( &self, ) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
Get the cached value of the device_path
property, or None
if the property is not cached.
Sourcepub fn receive_device_path_changed(
&self,
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
pub fn receive_device_path_changed( &self, ) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the device_path
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn last_log(&self) -> Result<Log>
pub fn last_log(&self) -> Result<Log>
last_log property
Contains the last Log signal proxied from the backend process.
Sourcepub fn cached_last_log(
&self,
) -> Result<Option<<Result<Log> as ResultAdapter>::Ok>, <Result<Log> as ResultAdapter>::Err>
pub fn cached_last_log( &self, ) -> Result<Option<<Result<Log> as ResultAdapter>::Ok>, <Result<Log> as ResultAdapter>::Err>
Get the cached value of the last_log
property, or None
if the property is not cached.
Sourcepub fn receive_last_log_changed(
&self,
) -> PropertyIterator<'c, <Result<Log> as ResultAdapter>::Ok>
pub fn receive_last_log_changed( &self, ) -> PropertyIterator<'c, <Result<Log> as ResultAdapter>::Ok>
Create a stream for the last_log
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn log_forwards(&self) -> Result<Vec<OwnedObjectPath>>
pub fn log_forwards(&self) -> Result<Vec<OwnedObjectPath>>
log_forwards property
Log Proxy/forward object paths used by net.openvpn.v3.log
to configure the forwarding.
Sourcepub fn cached_log_forwards(
&self,
) -> Result<Option<<Result<Vec<OwnedObjectPath>> as ResultAdapter>::Ok>, <Result<Vec<OwnedObjectPath>> as ResultAdapter>::Err>
pub fn cached_log_forwards( &self, ) -> Result<Option<<Result<Vec<OwnedObjectPath>> as ResultAdapter>::Ok>, <Result<Vec<OwnedObjectPath>> as ResultAdapter>::Err>
Get the cached value of the log_forwards
property, or None
if the property is not cached.
Sourcepub fn receive_log_forwards_changed(
&self,
) -> PropertyIterator<'c, <Result<Vec<OwnedObjectPath>> as ResultAdapter>::Ok>
pub fn receive_log_forwards_changed( &self, ) -> PropertyIterator<'c, <Result<Vec<OwnedObjectPath>> as ResultAdapter>::Ok>
Create a stream for the log_forwards
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn log_verbosity(&self) -> Result<LogLevel>
pub fn log_verbosity(&self) -> Result<LogLevel>
log_verbosity property
Defines the minimum log level Log signals should have to be sent.
Sourcepub fn cached_log_verbosity(
&self,
) -> Result<Option<<Result<LogLevel> as ResultAdapter>::Ok>, <Result<LogLevel> as ResultAdapter>::Err>
pub fn cached_log_verbosity( &self, ) -> Result<Option<<Result<LogLevel> as ResultAdapter>::Ok>, <Result<LogLevel> as ResultAdapter>::Err>
Get the cached value of the log_verbosity
property, or None
if the property is not cached.
Sourcepub fn receive_log_verbosity_changed(
&self,
) -> PropertyIterator<'c, <Result<LogLevel> as ResultAdapter>::Ok>
pub fn receive_log_verbosity_changed( &self, ) -> PropertyIterator<'c, <Result<LogLevel> as ResultAdapter>::Ok>
Create a stream for the log_verbosity
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
pub fn set_log_verbosity(&self, value: LogLevel) -> Result<()>
Sourcepub fn owner(&self) -> Result<u32>
pub fn owner(&self) -> Result<u32>
owner property
The UID value of the user which did the import.
Sourcepub fn cached_owner(
&self,
) -> Result<Option<<Result<u32> as ResultAdapter>::Ok>, <Result<u32> as ResultAdapter>::Err>
pub fn cached_owner( &self, ) -> Result<Option<<Result<u32> as ResultAdapter>::Ok>, <Result<u32> as ResultAdapter>::Err>
Get the cached value of the owner
property, or None
if the property is not cached.
Sourcepub fn receive_owner_changed(
&self,
) -> PropertyIterator<'c, <Result<u32> as ResultAdapter>::Ok>
pub fn receive_owner_changed( &self, ) -> PropertyIterator<'c, <Result<u32> as ResultAdapter>::Ok>
Create a stream for the owner
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn public_access(&self) -> Result<bool>
pub fn public_access(&self) -> Result<bool>
public_access property
If set to true, access control is disabled. Only owner may change this property, modify the ACL or delete the configuration.
Sourcepub fn cached_public_access(
&self,
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
pub fn cached_public_access( &self, ) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
Get the cached value of the public_access
property, or None
if the property is not cached.
Sourcepub fn receive_public_access_changed(
&self,
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
pub fn receive_public_access_changed( &self, ) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
Create a stream for the public_access
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
pub fn set_public_access(&self, value: bool) -> Result<()>
Sourcepub fn restrict_log_access(&self) -> Result<bool>
pub fn restrict_log_access(&self) -> Result<bool>
restrict_log_access property
If set to true, only the session owner can modify receive_log_events
and log_verbosity
, otherwise all granted users can access the log settings.
Sourcepub fn cached_restrict_log_access(
&self,
) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
pub fn cached_restrict_log_access( &self, ) -> Result<Option<<Result<bool> as ResultAdapter>::Ok>, <Result<bool> as ResultAdapter>::Err>
Get the cached value of the restrict_log_access
property, or None
if the property is not cached.
Sourcepub fn receive_restrict_log_access_changed(
&self,
) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
pub fn receive_restrict_log_access_changed( &self, ) -> PropertyIterator<'c, <Result<bool> as ResultAdapter>::Ok>
Create a stream for the restrict_log_access
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
pub fn set_restrict_log_access(&self, value: bool) -> Result<()>
Sourcepub fn session_created(&self) -> Result<u64>
pub fn session_created(&self) -> Result<u64>
session_created property
Unix Epoc timestamp of when the session was created.
Sourcepub fn cached_session_created(
&self,
) -> Result<Option<<Result<u64> as ResultAdapter>::Ok>, <Result<u64> as ResultAdapter>::Err>
pub fn cached_session_created( &self, ) -> Result<Option<<Result<u64> as ResultAdapter>::Ok>, <Result<u64> as ResultAdapter>::Err>
Get the cached value of the session_created
property, or None
if the property is not cached.
Sourcepub fn receive_session_created_changed(
&self,
) -> PropertyIterator<'c, <Result<u64> as ResultAdapter>::Ok>
pub fn receive_session_created_changed( &self, ) -> PropertyIterator<'c, <Result<u64> as ResultAdapter>::Ok>
Create a stream for the session_created
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn session_name(&self) -> Result<String>
pub fn session_name(&self) -> Result<String>
session_name property
Name of the VPN session, named by the the OpenVPN 3 Core library on successful connect.
Sourcepub fn cached_session_name(
&self,
) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
pub fn cached_session_name( &self, ) -> Result<Option<<Result<String> as ResultAdapter>::Ok>, <Result<String> as ResultAdapter>::Err>
Get the cached value of the session_name
property, or None
if the property is not cached.
Sourcepub fn receive_session_name_changed(
&self,
) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
pub fn receive_session_name_changed( &self, ) -> PropertyIterator<'c, <Result<String> as ResultAdapter>::Ok>
Create a stream for the session_name
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn statistics(&self) -> Result<Statistics>
pub fn statistics(&self) -> Result<Statistics>
statistics property
Contains tunnel statistics.
Sourcepub fn cached_statistics(
&self,
) -> Result<Option<<Result<Statistics> as ResultAdapter>::Ok>, <Result<Statistics> as ResultAdapter>::Err>
pub fn cached_statistics( &self, ) -> Result<Option<<Result<Statistics> as ResultAdapter>::Ok>, <Result<Statistics> as ResultAdapter>::Err>
Get the cached value of the statistics
property, or None
if the property is not cached.
Sourcepub fn receive_statistics_changed(
&self,
) -> PropertyIterator<'c, <Result<Statistics> as ResultAdapter>::Ok>
pub fn receive_statistics_changed( &self, ) -> PropertyIterator<'c, <Result<Statistics> as ResultAdapter>::Ok>
Create a stream for the statistics
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Sourcepub fn status(&self) -> Result<Status>
pub fn status(&self) -> Result<Status>
status property
Contains the last processed StatusChange signal.
Sourcepub fn cached_status(
&self,
) -> Result<Option<<Result<Status> as ResultAdapter>::Ok>, <Result<Status> as ResultAdapter>::Err>
pub fn cached_status( &self, ) -> Result<Option<<Result<Status> as ResultAdapter>::Ok>, <Result<Status> as ResultAdapter>::Err>
Get the cached value of the status
property, or None
if the property is not cached.
Sourcepub fn receive_status_changed(
&self,
) -> PropertyIterator<'c, <Result<Status> as ResultAdapter>::Ok>
pub fn receive_status_changed( &self, ) -> PropertyIterator<'c, <Result<Status> as ResultAdapter>::Ok>
Create a stream for the status
property changes. This is a convenient wrapper around zbus::blocking::Proxy::receive_property_changed
.
Methods from Deref<Target = Proxy<'c>>§
Sourcepub fn connection(&self) -> &Connection
pub fn connection(&self) -> &Connection
Get a reference to the associated connection.
Sourcepub fn destination(&self) -> &BusName<'_>
pub fn destination(&self) -> &BusName<'_>
Get a reference to the destination service name.
Sourcepub fn path(&self) -> &ObjectPath<'_>
pub fn path(&self) -> &ObjectPath<'_>
Get a reference to the object path.
Sourcepub fn interface(&self) -> &InterfaceName<'_>
pub fn interface(&self) -> &InterfaceName<'_>
Get a reference to the interface.
Sourcepub fn introspect(&self) -> Result<String, Error>
pub fn introspect(&self) -> Result<String, Error>
Introspect the associated object, and return the XML description.
See the xml module for parsing the result.
Sourcepub fn cached_property<T>(
&self,
property_name: &str,
) -> Result<Option<T>, Error>
pub fn cached_property<T>( &self, property_name: &str, ) -> Result<Option<T>, 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.
Sourcepub fn cached_property_raw<'p>(
&'p self,
property_name: &'p str,
) -> Option<impl Deref<Target = Value<'static>> + 'p>
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.
Sourcepub fn get_property<T>(&self, property_name: &str) -> Result<T, Error>
pub fn get_property<T>(&self, property_name: &str) -> Result<T, 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.
Sourcepub fn set_property<'t, T>(
&self,
property_name: &str,
value: T,
) -> Result<(), Error>
pub fn set_property<'t, T>( &self, property_name: &str, value: T, ) -> Result<(), Error>
Set the property property_name
.
Effectively, call the Set
method of the org.freedesktop.DBus.Properties
interface.
Sourcepub 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,
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).
Sourcepub 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,
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.
Sourcepub 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,
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
Sourcepub 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,
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.
Sourcepub fn receive_signal<'m, M>(
&self,
signal_name: M,
) -> Result<SignalIterator<'m>, Error>
pub fn receive_signal<'m, M>( &self, signal_name: M, ) -> Result<SignalIterator<'m>, 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).
Sourcepub fn receive_signal_with_args<'m, M>(
&self,
signal_name: M,
args: &[(u8, &str)],
) -> Result<SignalIterator<'m>, Error>
pub fn receive_signal_with_args<'m, M>( &self, signal_name: M, args: &[(u8, &str)], ) -> Result<SignalIterator<'m>, 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.
Sourcepub fn receive_all_signals(&self) -> Result<SignalIterator<'static>, Error>
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).
Sourcepub fn receive_property_changed<'name, T>(
&self,
name: &'name str,
) -> PropertyIterator<'a, T>where
'name: 'a,
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.
Sourcepub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>
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.
Trait Implementations§
Source§impl<'c> AsMut<Proxy<'c>> for SessionsNodeProxyBlocking<'c>
impl<'c> AsMut<Proxy<'c>> for SessionsNodeProxyBlocking<'c>
Source§impl<'c> AsRef<Proxy<'c>> for SessionsNodeProxyBlocking<'c>
impl<'c> AsRef<Proxy<'c>> for SessionsNodeProxyBlocking<'c>
Source§impl<'c> Clone for SessionsNodeProxyBlocking<'c>
impl<'c> Clone for SessionsNodeProxyBlocking<'c>
Source§fn clone(&self) -> SessionsNodeProxyBlocking<'c>
fn clone(&self) -> SessionsNodeProxyBlocking<'c>
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read more