Skip to main content

TransferSubscriptions

Struct TransferSubscriptions 

Source
pub struct TransferSubscriptions { /* private fields */ }
Expand description

Transfers Subscriptions and their MonitoredItems from one Session to another. For example, a Client may need to reopen a Session and then transfer its Subscriptions to that Session. It may also be used by one Client to take over a Subscription from another Client by transferring the Subscription to its Session.

Note that if you call this manually, you will need to register the subscriptions in the subscription state (Session::subscription_state) in order to receive notifications.

See OPC UA Part 4 - Services 5.13.7 for complete description of the service and error responses.

Implementations§

Source§

impl TransferSubscriptions

Source

pub fn diagnostics(self, bits: DiagnosticBits) -> Self

Set requested diagnostic bits.

Source

pub fn timeout(self, timeout: Duration) -> Self

Set the timeout for this request. Defaults to session timeout.

Source

pub fn audit_entry_id(self, entry: impl Into<UAString>) -> Self

Set the audit entry ID for the request.

Source

pub fn header(&self) -> &RequestHeader

Get the request header.

Source§

impl TransferSubscriptions

Source

pub fn new(session: &Session) -> Self

Construct a new call to the TransferSubscriptions service.

Source

pub fn new_manual( session_id: u32, timeout: Duration, auth_token: NodeId, request_handle: IntegerId, ) -> Self

Construct a new call to the TransferSubscriptions service, setting header parameters manually.

Source

pub fn send_initial_values(self, send_initial_values: bool) -> Self

A boolean parameter with the following values - true the first publish response shall contain the current values of all monitored items in the subscription, false, the first publish response shall contain only the value changes since the last publish response was sent.

Source

pub fn subscription_ids(self, subscription_ids: Vec<u32>) -> Self

Set the subscription IDs to transfer, overwriting any that were added previously.

Source

pub fn subscription(self, subscription_id: u32) -> Self

Add a subscription ID to transfer.

Trait Implementations§

Source§

impl Clone for TransferSubscriptions

Source§

fn clone(&self) -> TransferSubscriptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl UARequest for TransferSubscriptions

Source§

type Out = TransferSubscriptionsResponse

Response message type.
Source§

async fn send<'a>( self, channel: &'a AsyncSecureChannel, ) -> Result<Self::Out, StatusCode>
where Self: 'a,

Send the message and wait for a response.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more