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

Interface MonitoredItemServices

All Known Subinterfaces:

AddressSpace, AddressSpaceFragment, Namespace

All Known Implementing Classes:

AddressSpaceComposite, AddressSpaceManager, ForwardingAddressSpace, ManagedAddressSpace, ManagedAddressSpaceFragment, ManagedAddressSpaceFragmentWithLifecycle, ManagedAddressSpaceWithLifecycle, ManagedNamespace, ManagedNamespaceWithLifecycle, OpcUaNamespace, ServerNamespace

public interface MonitoredItemServices

Method Summary

Modifier and Type	Method and Description
default void	onCreateDataItem(ReadValueId itemToMonitor, Double requestedSamplingInterval, UInteger requestedQueueSize, BiConsumer<Double,UInteger> revisionCallback) A DataItem is being created for a Node managed by this MonitoredItemServices.
default void	onCreateEventItem(ReadValueId itemToMonitor, UInteger requestedQueueSize, Consumer<UInteger> revisionCallback) An EventItem is being created for a Node managed by this MonitoredItemServices.
void	onDataItemsCreated(List<DataItem> dataItems) DataItems have been created for nodes belonging to this MonitoredItemServices.
void	onDataItemsDeleted(List<DataItem> dataItems) DataItems have been deleted for nodes belonging to this MonitoredItemServices.
void	onDataItemsModified(List<DataItem> dataItems) DataItems have been modified for nodes belonging to this MonitoredItemServices.
default void	onEventItemsCreated(List<EventItem> eventItems) EventItems have been created for nodes belonging to this MonitoredItemServices.
default void	onEventItemsDeleted(List<EventItem> eventItems) EventItems have been deleted for nodes belonging to this MonitoredItemServices.
default void	onEventItemsModified(List<EventItem> eventItems) EventItems have been modified for nodes belonging to this MonitoredItemServices.
default void	onModifyDataItem(ReadValueId itemToModify, Double requestedSamplingInterval, UInteger requestedQueueSize, BiConsumer<Double,UInteger> revisionCallback) A DataItem is being modified for a Node managed by this MonitoredItemServices.
default void	onModifyEventItem(ReadValueId itemToModify, UInteger requestedQueueSize, Consumer<UInteger> revisionCallback) An EventItem is being modified for a Node managed by this MonitoredItemServices.
void	onMonitoringModeChanged(List<MonitoredItem> monitoredItems) MonitoredItems have had their MonitoringMode modified by a client.

Method Detail

onCreateDataItem

default void onCreateDataItem(ReadValueId itemToMonitor,
                              Double requestedSamplingInterval,
                              UInteger requestedQueueSize,
                              BiConsumer<Double,UInteger> revisionCallback)

A DataItem is being created for a Node managed by this MonitoredItemServices.

This is a chance to revise the requested queue size and/or sampling interval.

The sampling interval has already been revised to fit within the configured server limits and to be at least the value of the Minimum Sampling Interval attribute for the Node if it was present.

Parameters:

itemToMonitor - the item that will be monitored.

requestedQueueSize - the requested queue size.

requestedSamplingInterval - the requested sampling interval.

revisionCallback - the callback to invoke to revise the sampling interval and queue size.

onModifyDataItem

default void onModifyDataItem(ReadValueId itemToModify,
                              Double requestedSamplingInterval,
                              UInteger requestedQueueSize,
                              BiConsumer<Double,UInteger> revisionCallback)

A DataItem is being modified for a Node managed by this MonitoredItemServices.

This is a chance to revise the requested queue size and/or sampling interval.

The sampling interval has already been revised to fit within the configured server limits and to be at least the value of the Minimum Sampling Interval attribute for the Node if it was present.

Parameters:

itemToModify - the item that will be modified.

requestedQueueSize - the requested queue size.

requestedSamplingInterval - the requested sampling interval.

revisionCallback - the callback to invoke to revise the sampling interval and queue size.

onCreateEventItem

default void onCreateEventItem(ReadValueId itemToMonitor,
                               UInteger requestedQueueSize,
                               Consumer<UInteger> revisionCallback)

An EventItem is being created for a Node managed by this MonitoredItemServices.

This is a chance to revise the requested queue size.

Parameters:

itemToMonitor - the item that will be monitored.

requestedQueueSize - the requested queue size.

revisionCallback - the callback to invoke to revise the queue size.

onModifyEventItem

default void onModifyEventItem(ReadValueId itemToModify,
                               UInteger requestedQueueSize,
                               Consumer<UInteger> revisionCallback)

An EventItem is being modified for a Node managed by this MonitoredItemServices.

This is a chance to revise the requested queue size.

Parameters:

itemToModify - the item that will be modified.

requestedQueueSize - the requested queue size.

revisionCallback - the callback to invoke to revise the queue size.

onDataItemsCreated

void onDataItemsCreated(List<DataItem> dataItems)

DataItems have been created for nodes belonging to this MonitoredItemServices.

If sampling is enabled for this item, it is expected that a best-effort will be made to update the item's value at the sampling rate.

Parameters:

dataItems - the DataItems that were created.

onDataItemsModified

void onDataItemsModified(List<DataItem> dataItems)

DataItems have been modified for nodes belonging to this MonitoredItemServices.

Check to see if the sampling rate has changed or if sampling has been enabled or disabled.

Parameters:

dataItems - the DataItems that were modified.

onDataItemsDeleted

void onDataItemsDeleted(List<DataItem> dataItems)

DataItems have been deleted for nodes belonging to this MonitoredItemServices.

Updates to this item should cease and any references to it should be removed.

Parameters:

dataItems - the DataItems that were deleted.

onEventItemsCreated

default void onEventItemsCreated(List<EventItem> eventItems)

EventItems have been created for nodes belonging to this MonitoredItemServices.

Parameters:

eventItems - the EventItems that were created.

onEventItemsModified

default void onEventItemsModified(List<EventItem> eventItems)

EventItems have been modified for nodes belonging to this MonitoredItemServices.

Parameters:

eventItems - the EventItems that were modified.

onEventItemsDeleted

default void onEventItemsDeleted(List<EventItem> eventItems)

EventItems have been deleted for nodes belonging to this MonitoredItemServices.

Parameters:

eventItems - the EventItems that were deleted.

onMonitoringModeChanged

void onMonitoringModeChanged(List<MonitoredItem> monitoredItems)

MonitoredItems have had their MonitoringMode modified by a client.

Check if sampling is still enabled and react accordingly.

Parameters:

monitoredItems - The MonitoredItems whose MonitoringMode was modified.