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

Interface MonitoredItemServices

All Known Subinterfaces:

UaClient

All Known Implementing Classes:

OpcUaClient

public interface MonitoredItemServices

Method Summary

Modifier and Type	Method and Description
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CreateMonitoredItemsResponse>	createMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate) This service is used to create and add one or more monitored items to a subscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteMonitoredItemsResponse>	deleteMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds) This service is used to remove one or more monitored items of a subscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ModifyMonitoredItemsResponse>	modifyMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest> itemsToModify) This service is used to modify monitored items of a subscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetMonitoringModeResponse>	setMonitoringMode(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds) This service is used to set the MonitoringMode for one or more monitored items of a subscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetTriggeringResponse>	setTriggering(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToAdd, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToRemove) This service is used to create and delete triggering links for a triggering item.

Method Detail

createMonitoredItems

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CreateMonitoredItemsResponse> createMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                                                                                        org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                                                                                        List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate)

This service is used to create and add one or more monitored items to a subscription.

Parameters:

subscriptionId - the server-assigned identifier for the subscription that will report notifications for the monitored items.

timestampsToReturn - the TimestampsToReturn.

itemsToCreate - a list of monitored items to be created and assigned to the specified subscription.

Returns:

a CompletableFuture containing the CreateMonitoredItemsResponse.

modifyMonitoredItems

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ModifyMonitoredItemsResponse> modifyMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                                                                                        org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn,
                                                                                                                        List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest> itemsToModify)

This service is used to modify monitored items of a subscription.

Parameters:

subscriptionId - the server-assigned identifier of the subscription the items to modify belong to.

timestampsToReturn - the TimestampsToReturn.

itemsToModify - a list of monitored items to modify.

Returns:

a CompletableFuture containing the ModifyMonitoredItemsResponse.

deleteMonitoredItems

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteMonitoredItemsResponse> deleteMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                                                                                        List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds)

This service is used to remove one or more monitored items of a subscription.

Parameters:

subscriptionId - the server-assigned identifier of the subscription the items to delete belong to.

monitoredItemIds - a list of server-assigned identifiers for the items to delete.

Returns:

a CompletableFuture containing the DeleteMonitoredItemsResponse.

setMonitoringMode

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetMonitoringModeResponse> setMonitoringMode(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                                                                                  org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode,
                                                                                                                  List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds)

This service is used to set the MonitoringMode for one or more monitored items of a subscription.

Setting the mode to MonitoringMode.Disabled causes all queued notifications to be deleted.

Parameters:

subscriptionId - the server-assigned identifier of the subscription the items belong to.

monitoringMode - the MonitoringMode to be set for the monitored items.

monitoredItemIds - a list of server-assigned identifiers for the items whose MonitoringMode will be set.

Returns:

a CompletableFuture containing the SetMonitoringModeResponse.

setTriggering

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetTriggeringResponse> setTriggering(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId,
                                                                                                          org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId,
                                                                                                          List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToAdd,
                                                                                                          List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToRemove)

This service is used to create and delete triggering links for a triggering item. The triggering item and the items to report shall belong to the same subscription.

Parameters:

subscriptionId - the server-assigned identifier for the subscription that contains the triggering item and the items to report.

triggeringItemId - the server-assigned identifier for the monitored item used as the triggering item.

linksToAdd - the list of server-assigned identifiers of the items to report that are to be added as triggering links. The list of links to remove is processed before the links to add.

linksToRemove - the list of server-assigned identifiers of the items to report for the triggering links to be removed. The list of links to remove is processed before the links to add.

Returns:

a CompletableFuture containing the SetTriggeringResponse.