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

Interface UaMonitoredItem

All Known Implementing Classes:

OpcUaMonitoredItem

public interface UaMonitoredItem

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UaMonitoredItem.EventConsumer
static interface	UaMonitoredItem.ValueConsumer

Method Summary

Modifier and Type	Method and Description
OpcUaClient	getClient() Get the OpcUaClient that created this monitored item.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getClientHandle() Get the client-assigned id.
boolean	getDiscardOldest() Get the discard policy.
org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject	getFilterResult() Get the filter result ExtensionObject.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMonitoredItemId() Get the server-assigned id.
org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject	getMonitoringFilter() Get the filter requested when the item was created.
org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode	getMonitoringMode() Get the MonitoringMode.
org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId	getReadValueId() Get the ReadValueId.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRequestedQueueSize() Get the last requested queue size.
double	getRequestedSamplingInterval() Get the last requested sampling interval.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRevisedQueueSize() Get the revised queue size.
double	getRevisedSamplingInterval() Get the revised sampling interval.
org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode	getStatusCode() Get the StatusCode of the last operation.
org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn	getTimestamps() Get the TimestampsToReturn requested when the item was created.
void	setEventConsumer(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> eventConsumer) Set the Consumer that will receive events as they arrive from the server.
void	setEventConsumer(UaMonitoredItem.EventConsumer eventConsumer) Set the UaMonitoredItem.EventConsumer that will receive events as they arrive from the server.
void	setValueConsumer(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> valueConsumer) Set the Consumer that will receive values as they arrive from the server.
void	setValueConsumer(UaMonitoredItem.ValueConsumer valueConsumer) Set a UaMonitoredItem.ValueConsumer that will receive values as they arrive from the server.

Method Detail

getClient

OpcUaClient getClient()

Get the OpcUaClient that created this monitored item.

Returns:

the OpcUaClient that created this monitored item.

getClientHandle

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getClientHandle()

Get the client-assigned id.

This handle is used in the subscription to match incoming values to the corresponding monitored item.

Returns:

the client-assigned id.

getMonitoredItemId

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMonitoredItemId()

Get the server-assigned id.

Returns:

the server-assigned id.

getReadValueId

org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId getReadValueId()

Get the ReadValueId.

Returns:

the ReadValueId.

getStatusCode

org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode getStatusCode()

Get the StatusCode of the last operation.

Returns:

the StatusCode of the last operation.

getRequestedSamplingInterval

double getRequestedSamplingInterval()

Get the last requested sampling interval.

Returns:

the last requested sampling interval.

getRevisedSamplingInterval

double getRevisedSamplingInterval()

Get the revised sampling interval.

Returns:

the revised sampling interval.

getRequestedQueueSize

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getRequestedQueueSize()

Get the last requested queue size.

Returns:

the last requested queue size.

getRevisedQueueSize

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getRevisedQueueSize()

Get the revised queue size.

Returns:

the revised queue size.

getFilterResult

org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject getFilterResult()

Get the filter result ExtensionObject.

Returns:

the filter result ExtensionObject.

getMonitoringMode

org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode getMonitoringMode()

Get the MonitoringMode.

Returns:

the MonitoringMode.

getMonitoringFilter

org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject getMonitoringFilter()

Get the filter requested when the item was created.

May be null if no filter was requested.

Returns:

the filter requested when the item was created. May be null if no filter was requested.

getDiscardOldest

boolean getDiscardOldest()

Get the discard policy.

true if oldest are discarded when the queue capacity is exceeded.

Returns:

the discard policy.

getTimestamps

org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn getTimestamps()

Get the TimestampsToReturn requested when the item was created.

Returns:

the TimestampsToReturn requested when the item was created.

setValueConsumer

void setValueConsumer(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> valueConsumer)

Set the Consumer that will receive values as they arrive from the server.

Parameters:

valueConsumer - the Consumer that will receive values as they arrive from the server.

setValueConsumer

void setValueConsumer(UaMonitoredItem.ValueConsumer valueConsumer)

Set a UaMonitoredItem.ValueConsumer that will receive values as they arrive from the server.

The UaMonitoredItem in the consumer will be this item.

Parameters:

valueConsumer - the UaMonitoredItem.ValueConsumer that will receive values as they arrive from the server.

setEventConsumer

void setEventConsumer(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> eventConsumer)

Set the Consumer that will receive events as they arrive from the server.

Parameters:

eventConsumer - the Consumer that will receive events as they arrive from the server.

setEventConsumer

void setEventConsumer(UaMonitoredItem.EventConsumer eventConsumer)

Set the UaMonitoredItem.EventConsumer that will receive events as they arrive from the server.

Parameters:

eventConsumer - the UaMonitoredItem.EventConsumer that will receive events as they arrive from the server.