org.eclipse.milo.opcua.sdk.client.api.services

Interface SubscriptionServices

All Known Subinterfaces:

UaClient

All Known Implementing Classes:

OpcUaClient

public interface SubscriptionServices

Method Summary

Modifier and Type	Method and Description
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CreateSubscriptionResponse>	createSubscription(double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, boolean publishingEnabled, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority) This service is used to create a subscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse>	deleteSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds) This service is invoked to delete one or more subscriptions that belong to the client's session.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ModifySubscriptionResponse>	modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority) This service is used to modify a subscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse>	publish(List<org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement> subscriptionAcknowledgements) This service is used for two purposes.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RepublishResponse>	republish(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger retransmitSequenceNumber) This service requests the subscription to republish a notification message from its retransmission queue.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse>	setPublishingMode(boolean publishingEnabled, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds) This service is used to enable sending of notifications on one or more subscriptions.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse>	transferSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds, boolean sendInitialValues) This service is used to transfer a subscription and its monitored items from one session to another.

Method Detail

createSubscription

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CreateSubscriptionResponse> createSubscription(double requestedPublishingInterval,
                                                                                                                    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount,
                                                                                                                    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount,
                                                                                                                    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish,
                                                                                                                    boolean publishingEnabled,
                                                                                                                    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

This service is used to create a subscription. Subscriptions monitor a set of monitored items for notifications and return them to the client in response to Publish requests.

Parameters:

requestedPublishingInterval - this interval defines the cyclic rate that the subscription is being requested to return notifications to the client. This interval is expressed in milliseconds.

requestedLifetimeCount - the requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count.

requestedMaxKeepAliveCount - the requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any notification to be sent, the subscription sends a keep-alive message to the client.

maxNotificationsPerPublish - 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.

publishingEnabled - if true, publishing is enabled for this subscription.

priority - indicates the relative priority of the subscription.

Returns:

a CompletableFuture containing the CreateSubscriptionResponse.

modifySubscription

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ModifySubscriptionResponse> modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                                                                                    double requestedPublishingInterval,
                                                                                                                    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount,
                                                                                                                    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount,
                                                                                                                    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish,
                                                                                                                    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)

This service is used to modify a subscription.

Parameters:

subscriptionId - the server-assigned identifier for the subscription.

requestedPublishingInterval - this interval defines the cyclic rate that the subscription is being requested to return notifications to the client. This interval is expressed in milliseconds.

requestedLifetimeCount - the requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count.

requestedMaxKeepAliveCount - the requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any notification to be sent, the subscription sends a keep-alive message to the client.

maxNotificationsPerPublish - 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.

priority - indicates the relative priority of the subscription.

Returns:

a CompletableFuture containing the ModifySubscriptionResponse.

deleteSubscriptions

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse> deleteSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)

This service is invoked to delete one or more subscriptions that belong to the client's session.

Parameters:

subscriptionIds - the server-assigned identifiers for the subscriptions.

Returns:

a CompletableFuture containing the DeleteSubscriptionsResponse.

transferSubscriptions

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse> transferSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds,
                                                                                                                          boolean sendInitialValues)

This service is used to transfer a subscription and its monitored items from one session to another.

Parameters:

subscriptionIds - the server-assigned identifiers for the subscriptions to transfer.

sendInitialValues - if true, the first Publish response after the TransferSubscriptions service call shall contain the current values of all monitored items in the subscription where the MonitoringMode is MonitoringMode.Reporting.

Returns:

a CompletableFuture containing the TransferSubscriptionsResponse.

setPublishingMode

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse> setPublishingMode(boolean publishingEnabled,
                                                                                                                  List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)

This service is used to enable sending of notifications on one or more subscriptions.

Parameters:

publishingEnabled - true if publishing of notification messages is to be enabled.

subscriptionIds - a list of server-assigned subscription identifiers to enable or disable publishing on.

Returns:

a CompletableFuture containing the SetPublishingModeResponse.

publish

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse> publish(List<org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement> subscriptionAcknowledgements)

This service is used for two purposes. First, it is used to acknowledge the receipt of notification messages for one or more subscriptions. Second, it is used to request the server to return a notification message or a keep-alive message.

Parameters:

subscriptionAcknowledgements - the list of acknowledgements for one or more subscriptions. This list may contain multiple acknowledgements for the same subscription (multiple entries with the same subscriptionId).

Returns:

a CompletableFuture containing the PublishResponse.

republish

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RepublishResponse> republish(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                                                                  org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger retransmitSequenceNumber)

This service requests the subscription to republish a notification message from its retransmission queue. If the server does not have the requested message in its retransmission queue, it returns an error response.

Parameters:

subscriptionId - the server-assigned identifier for the subscription to be republished.

retransmitSequenceNumber - the sequence number of a specific notification message to be republished.

Returns:

a CompletableFuture containing the RepublishResponse.