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

Class ManagedItem

java.lang.Object

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

Direct Known Subclasses:

ManagedDataItem, ManagedEventItem

public abstract class ManagedItem
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected OpcUaClient	client
protected OpcUaMonitoredItem	monitoredItem
protected ManagedSubscription	subscription

Method Summary

Modifier and Type	Method and Description
void	delete() Delete this ManagedDataItem.
abstract CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	deleteAsync() Delete this ManagedDataItem.
OpcUaClient	getClient() Get the OpcUaClient that created this ManagedDataItem.
boolean	getDiscardOldest() Get this item's current discard policy.
OpcUaMonitoredItem	getMonitoredItem() Get the underlying OpcUaMonitoredItem.
org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode	getMonitoringMode() Get this item's current MonitoringMode.
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getNodeId() Get the NodeId component of the ReadValueId for this item.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getQueueSize() Get this item's current queue size, i.e.
org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId	getReadValueId() Get the ReadValueId for this item.
org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode	getStatusCode() Get the StatusCode of the last operation this item was part of.
ManagedSubscription	getSubscription() Get the ManagedSubscription this item belongs to.
org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn	getTimestampsToReturn() Get this item's current TimestampsToReturn parameter.
void	setDiscardOldest(boolean discardOldest) Set this item's discard policy.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	setDiscardOldestAsync(boolean discardOldest) Set this item's discard policy.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	setDiscardOldestAsync(boolean discardOldest, BatchModifyMonitoredItems batch) Set this item's discard policy as part of a batch operation.
void	setMonitoringMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode) Set this item's MonitoringMode.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	setMonitoringModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode) Set this item's MonitoringMode.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	setMonitoringModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode, BatchSetMonitoringMode batch) Set this item's MonitoringMode as part of a batch operation.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	setQueueSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger queueSize) Request a new queue size for this item.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	setQueueSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger queueSize) Request a new queue size for this item.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	setQueueSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger queueSize, BatchModifyMonitoredItems batch) Request a new queue size for this item as part of a batch operation
void	setTimestampsToReturn(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps) Set a new TimestampsToReturn parameter on this item.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	setTimestampsToReturnAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps) Set a new TimestampsToReturn parameter on this item.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	setTimestampsToReturnAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps, BatchModifyMonitoredItems batch) Set this item's TimestampsToReturn as part of a batch operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

client

protected final OpcUaClient client

subscription

protected final ManagedSubscription subscription

monitoredItem

protected final OpcUaMonitoredItem monitoredItem

Method Detail

getClient

public OpcUaClient getClient()

Get the OpcUaClient that created this ManagedDataItem.

Returns:

the OpcUaClient that created this ManagedDataItem.

getSubscription

public ManagedSubscription getSubscription()

Get the ManagedSubscription this item belongs to.

Returns:

the ManagedSubscription this item belongs to.

getMonitoredItem

public OpcUaMonitoredItem getMonitoredItem()

Get the underlying OpcUaMonitoredItem.

Returns:

the underlying OpcUaMonitoredItem.

getNodeId

public org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getNodeId()

Get the NodeId component of the ReadValueId for this item.

Returns:

the NodeId component of the ReadValueId for this item.

getReadValueId

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

Get the ReadValueId for this item.

Returns:

the ReadValueId for this item.

getStatusCode

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

Get the StatusCode of the last operation this item was part of.

Returns:

the StatusCode of the last operation this item was part of.

getMonitoringMode

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

Get this item's current MonitoringMode.

Returns:

this item's current MonitoringMode.

See Also:

UaMonitoredItem.getMonitoringMode()

setMonitoringMode

public void setMonitoringMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Set this item's MonitoringMode.

Parameters:

monitoringMode - the new MonitoringMode to set.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an operation- or service-level error occurs.

setMonitoringModeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> setMonitoringModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode)

Set this item's MonitoringMode.

Parameters:

monitoringMode - the new MonitoringMode to set.

Returns:

a CompletableFuture that completes successfully if the new MonitoringMode was set and completes exceptionally if an operation- or service-level error occurs.

setMonitoringModeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> setMonitoringModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode,
                                                                                             BatchSetMonitoringMode batch)

Set this item's MonitoringMode as part of a batch operation.

Parameters:

monitoringMode - the new MonitoringMode to set.

batch - the BatchSetMonitoringMode operation.

Returns:

a CompletableFuture that completes successfully if the new MonitoringMode was set and completes exceptionally if an operation- or service-level error occurs.

getQueueSize

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

Get this item's current queue size, i.e. its revised queue size.

Returns:

this item's current queue size, i.e. its revised queue size.

See Also:

UaMonitoredItem.getRevisedQueueSize()

setQueueSize

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger setQueueSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger queueSize)
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Request a new queue size for this item.

Parameters:

queueSize - the new queue size to request.

Returns:

the new queue size, possibly revised by the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an operation- or service-level error occurs.

setQueueSizeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> setQueueSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger queueSize)

Request a new queue size for this item.

This call completes asynchronously.

Parameters:

queueSize - the new queue size to request.

Returns:

a CompletableFuture that completes successfully with the new queue size, possibly revised by the server, or completes exceptionally if an operation- or service-level error occurs.

setQueueSizeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> setQueueSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger queueSize,
                                                                                                              BatchModifyMonitoredItems batch)

Request a new queue size for this item as part of a batch operation

Parameters:

queueSize - the new queue size to request.

batch - the BatchModifyMonitoredItems operation.

Returns:

a CompletableFuture that completes successfully with the new queue size, possibly revised by the server, or completes exceptionally if an operation- or service-level error occurred.

getTimestampsToReturn

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

Get this item's current TimestampsToReturn parameter.

Returns:

this item's current TimestampsToReturn parameter.

setTimestampsToReturn

public void setTimestampsToReturn(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Set a new TimestampsToReturn parameter on this item.

Parameters:

timestamps - a new TimestampsToReturn parameter.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an operation- or service-level error occurs.

setTimestampsToReturnAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> setTimestampsToReturnAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps)

Set a new TimestampsToReturn parameter on this item.

This call completes asynchronously.

Parameters:

timestamps - a new TimestampsToReturn parameter.

Returns:

a CompletableFuture that completes successfully if the item was modified and completes exceptionally if an operation- or service-level error occurs.

setTimestampsToReturnAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> setTimestampsToReturnAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps,
                                                                                                 BatchModifyMonitoredItems batch)

Set this item's TimestampsToReturn as part of a batch operation.

Parameters:

timestamps - the new TimestampsToReturn to set.

batch - the BatchModifyMonitoredItems operation.

Returns:

a CompletableFuture that completes successfully if the new TimestampsToReturn was set and completes exceptionally if an operation- or service-level error occurs.

getDiscardOldest

public boolean getDiscardOldest()

Get this item's current discard policy.

Returns:

true if the oldest are discarded when the queue is full.

setDiscardOldest

public void setDiscardOldest(boolean discardOldest)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Set this item's discard policy.

Parameters:

discardOldest - true if the oldest are discarded when the queue is full.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an operation- or service-level error occurs.

setDiscardOldestAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> setDiscardOldestAsync(boolean discardOldest)

Set this item's discard policy.

This call completes asynchronously.

Parameters:

discardOldest - true if the oldest are discarded when the queue is full.

Returns:

a CompletableFuture that completes successfully if the item was modified and completes exceptionally if an operation- or service-level error occurs.

setDiscardOldestAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> setDiscardOldestAsync(boolean discardOldest,
                                                                                            BatchModifyMonitoredItems batch)

Set this item's discard policy as part of a batch operation.

Parameters:

discardOldest - true if the oldest are discarded when the queue is full.

batch - the BatchModifyMonitoredItems operation.

Returns:

a CompletableFuture that completes successfully if the item was modified and completes exceptionally if an operation- or service-level error occurs.

delete

public void delete()
            throws org.eclipse.milo.opcua.stack.core.UaException

Delete this ManagedDataItem.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an operation- or service-level error occurs.

deleteAsync

public abstract CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> deleteAsync()

Delete this ManagedDataItem.

This call completes asynchronously.

Returns:

a CompletableFuture that completes successfully if the operation succeeds or completes exceptionally if an operation- or service-level error occurs.