Struct CreateSubscription 

pub struct CreateSubscription { /* private fields */ }

Create a subscription by sending a CreateSubscriptionRequest to the server.

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

Implementations

impl CreateSubscription

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

Set requested diagnostic bits.

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

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

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

Set the audit entry ID for the request.

pub fn header(&self) -> &RequestHeader

Get the request header.

impl CreateSubscription

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

Construct a new call to the CreateSubscription service.

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

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

pub fn publishing_interval(self, interval: Duration) -> Self

The requested publishing interval defines the cyclic rate that the Subscription is being requested to return Notifications to the Client. This interval is expressed in milliseconds. This interval is represented by the publishing timer in the Subscription state table. The negotiated value for this parameter returned in the response is used as the default sampling interval for MonitoredItems assigned to this Subscription. If the requested value is 0 or negative, the server shall revise with the fastest supported publishing interval in milliseconds.

pub fn max_lifetime_count(self, lifetime_count: u32) -> Self

Requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count. When the publishing timer has expired this number of times without a Publish request being available to send a NotificationMessage, then the Subscription shall be deleted by the Server.

pub fn max_keep_alive_count(self, keep_alive_count: u32) -> Self

Requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any NotificationMessage to be sent, the Subscription sends a keep-alive Message to the Client. The negotiated value for this parameter is returned in the response. If the requested value is 0, the server shall revise with the smallest supported keep-alive count.

pub fn max_notifications_per_publish( self, max_notifications_per_publish: u32, ) -> Self

The maximum number of notifications that the Client wishes to receive in a single Publish response. A value of zero indicates that there is no limit. The number of notifications per Publish is the sum of monitoredItems in the DataChangeNotification and events in the EventNotificationList.

pub fn priority(self, priority: u8) -> Self

Indicates the relative priority of the Subscription. When more than one Subscription needs to send Notifications, the Server should de-queue a Publish request to the Subscription with the highest priority number. For Subscriptions with equal priority the Server should de-queue Publish requests in a round-robin fashion.

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

A boolean parameter with the following values - true publishing is enabled for the Subscription, false, publishing is disabled for the Subscription. The value of this parameter does not affect the value of the monitoring mode Attribute of MonitoredItems.

Trait Implementations

impl UARequest for CreateSubscription

type Out = CreateSubscriptionResponse

Response message type.

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

where Self: 'a,

Send the message and wait for a response.